From bacd392153f65423c576a40cf39aad6981a58413 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 15 Sep 2020 15:08:53 +0200 Subject: [PATCH] doc: Sync classref with 3.2 branch --- classes/class_@gdscript.rst | 144 +++++---- classes/class_@globalscope.rst | 11 +- classes/class_aabb.rst | 3 + classes/class_acceptdialog.rst | 3 + classes/class_animatedsprite.rst | 14 +- classes/class_animatedsprite3d.rst | 12 +- classes/class_animatedtexture.rst | 15 +- classes/class_animation.rst | 111 +++---- classes/class_animationnode.rst | 43 +-- classes/class_animationnodeadd2.rst | 3 + classes/class_animationnodeadd3.rst | 3 + classes/class_animationnodeanimation.rst | 3 + classes/class_animationnodeblend2.rst | 3 + classes/class_animationnodeblend3.rst | 3 + classes/class_animationnodeblendspace1d.rst | 15 +- classes/class_animationnodeblendspace2d.rst | 19 +- classes/class_animationnodeblendtree.rst | 15 +- classes/class_animationnodeoneshot.rst | 7 +- classes/class_animationnodeoutput.rst | 3 + classes/class_animationnodestatemachine.rst | 51 ++-- ...lass_animationnodestatemachineplayback.rst | 15 +- ...ss_animationnodestatemachinetransition.rst | 3 + classes/class_animationnodetimescale.rst | 3 + classes/class_animationnodetimeseek.rst | 3 + classes/class_animationnodetransition.rst | 11 +- classes/class_animationplayer.rst | 41 +-- classes/class_animationrootnode.rst | 3 + classes/class_animationtrackeditplugin.rst | 3 + classes/class_animationtree.rst | 7 +- classes/class_animationtreeplayer.rst | 99 ++++--- classes/class_area.rst | 31 +- classes/class_area2d.rst | 31 +- classes/class_array.rst | 17 +- classes/class_arraymesh.rst | 35 ++- classes/class_arvranchor.rst | 35 ++- classes/class_arvrcamera.rst | 3 + classes/class_arvrcontroller.rst | 47 +-- classes/class_arvrinterface.rst | 43 +-- classes/class_arvrinterfacegdnative.rst | 3 + classes/class_arvrorigin.rst | 3 + classes/class_arvrpositionaltracker.rst | 71 ++--- classes/class_arvrserver.rst | 31 +- classes/class_astar.rst | 129 ++++---- classes/class_astar2d.rst | 129 ++++---- classes/class_atlastexture.rst | 3 + classes/class_audiobuslayout.rst | 3 + classes/class_audioeffect.rst | 3 + classes/class_audioeffectamplify.rst | 3 + classes/class_audioeffectbandlimitfilter.rst | 3 + classes/class_audioeffectbandpassfilter.rst | 3 + classes/class_audioeffectchorus.rst | 27 +- classes/class_audioeffectcompressor.rst | 3 + classes/class_audioeffectdelay.rst | 3 + classes/class_audioeffectdistortion.rst | 12 +- classes/class_audioeffecteq.rst | 11 +- classes/class_audioeffecteq10.rst | 3 + classes/class_audioeffecteq21.rst | 3 + classes/class_audioeffecteq6.rst | 3 + classes/class_audioeffectfilter.rst | 10 +- classes/class_audioeffecthighpassfilter.rst | 3 + classes/class_audioeffecthighshelffilter.rst | 3 + classes/class_audioeffectinstance.rst | 3 + classes/class_audioeffectlimiter.rst | 3 + classes/class_audioeffectlowpassfilter.rst | 3 + classes/class_audioeffectlowshelffilter.rst | 3 + classes/class_audioeffectnotchfilter.rst | 3 + classes/class_audioeffectpanner.rst | 3 + classes/class_audioeffectphaser.rst | 3 + classes/class_audioeffectpitchshift.rst | 3 + classes/class_audioeffectrecord.rst | 11 +- classes/class_audioeffectreverb.rst | 3 + classes/class_audioeffectspectrumanalyzer.rst | 3 + ...ss_audioeffectspectrumanalyzerinstance.rst | 11 +- classes/class_audioeffectstereoenhance.rst | 3 + classes/class_audioserver.rst | 71 ++--- classes/class_audiostream.rst | 11 +- classes/class_audiostreamgenerator.rst | 3 + .../class_audiostreamgeneratorplayback.rst | 15 +- classes/class_audiostreammicrophone.rst | 3 + classes/class_audiostreamoggvorbis.rst | 3 + classes/class_audiostreamplayback.rst | 3 + .../class_audiostreamplaybackresampled.rst | 3 + classes/class_audiostreamplayer.rst | 3 + classes/class_audiostreamplayer2d.rst | 3 + classes/class_audiostreamplayer3d.rst | 5 + classes/class_audiostreamrandompitch.rst | 3 + classes/class_audiostreamsample.rst | 3 + classes/class_backbuffercopy.rst | 3 + classes/class_bakedlightmap.rst | 3 + classes/class_bakedlightmapdata.rst | 15 +- classes/class_basebutton.rst | 29 +- classes/class_basis.rst | 3 + classes/class_bitmap.rst | 21 +- classes/class_bitmapfont.rst | 15 +- classes/class_bone2d.rst | 21 +- classes/class_boneattachment.rst | 3 + classes/class_bool.rst | 3 + classes/class_boxcontainer.rst | 3 + classes/class_boxshape.rst | 3 + classes/class_bulletphysicsserver.rst | 3 + classes/class_button.rst | 18 ++ classes/class_buttongroup.rst | 3 + classes/class_camera.rst | 43 +-- classes/class_camera2d.rst | 19 +- classes/class_camerafeed.rst | 23 +- classes/class_cameraserver.rst | 3 + classes/class_cameratexture.rst | 3 + classes/class_canvasitem.rst | 75 ++--- classes/class_canvasitemmaterial.rst | 3 + classes/class_canvaslayer.rst | 11 +- classes/class_canvasmodulate.rst | 3 + classes/class_capsulemesh.rst | 3 + classes/class_capsuleshape.rst | 3 + classes/class_capsuleshape2d.rst | 3 + classes/class_centercontainer.rst | 3 + classes/class_charfxtransform.rst | 3 + classes/class_checkbox.rst | 3 + classes/class_checkbutton.rst | 3 + classes/class_circleshape2d.rst | 3 + classes/class_classdb.rst | 125 ++++---- classes/class_clippedcamera.rst | 13 +- classes/class_collisionobject.rst | 91 +++--- classes/class_collisionobject2d.rst | 111 +++---- classes/class_collisionpolygon.rst | 3 + classes/class_collisionpolygon2d.rst | 3 + classes/class_collisionshape.rst | 3 + classes/class_collisionshape2d.rst | 5 +- classes/class_color.rst | 3 + classes/class_colorpicker.rst | 7 +- classes/class_colorpickerbutton.rst | 3 + classes/class_colorrect.rst | 3 + classes/class_concavepolygonshape.rst | 7 +- classes/class_concavepolygonshape2d.rst | 3 + classes/class_conetwistjoint.rst | 7 +- classes/class_configfile.rst | 75 ++--- classes/class_confirmationdialog.rst | 3 + classes/class_container.rst | 3 + classes/class_control.rst | 203 +++++++------ classes/class_convexpolygonshape.rst | 3 + classes/class_convexpolygonshape2d.rst | 3 + classes/class_cpuparticles.rst | 19 +- classes/class_cpuparticles2d.rst | 19 +- classes/class_crypto.rst | 3 + classes/class_cryptokey.rst | 3 + classes/class_csgbox.rst | 3 + classes/class_csgcombiner.rst | 3 + classes/class_csgcylinder.rst | 3 + classes/class_csgmesh.rst | 3 + classes/class_csgpolygon.rst | 3 + classes/class_csgprimitive.rst | 3 + classes/class_csgshape.rst | 23 +- classes/class_csgsphere.rst | 3 + classes/class_csgtorus.rst | 3 + classes/class_csharpscript.rst | 11 +- classes/class_cubemap.rst | 15 +- classes/class_cubemesh.rst | 3 + classes/class_curve.rst | 31 +- classes/class_curve2d.rst | 51 ++-- classes/class_curve3d.rst | 67 +++-- classes/class_curvetexture.rst | 3 + classes/class_cylindermesh.rst | 3 + classes/class_cylindershape.rst | 3 + classes/class_dampedspringjoint2d.rst | 3 + classes/class_dictionary.rst | 3 + classes/class_directionallight.rst | 3 + classes/class_directory.rst | 7 +- classes/class_dtlsserver.rst | 3 + classes/class_dynamicfont.rst | 23 +- classes/class_dynamicfontdata.rst | 3 + classes/class_editorexportplugin.rst | 75 +++-- classes/class_editorfeatureprofile.rst | 19 +- classes/class_editorfiledialog.rst | 3 + classes/class_editorfilesystem.rst | 15 +- classes/class_editorfilesystemdirectory.rst | 83 +++--- classes/class_editorimportplugin.rst | 77 ++--- classes/class_editorinspector.rst | 3 + classes/class_editorinspectorplugin.rst | 47 +-- classes/class_editorinterface.rst | 31 +- .../class_editornavigationmeshgenerator.rst | 3 + classes/class_editorplugin.rst | 95 +++--- classes/class_editorproperty.rst | 11 +- .../class_editorresourceconversionplugin.rst | 17 +- classes/class_editorresourcepreview.rst | 3 + .../class_editorresourcepreviewgenerator.rst | 35 ++- classes/class_editorsceneimporter.rst | 19 +- classes/class_editorsceneimporterassimp.rst | 3 + classes/class_editorscenepostimport.rst | 23 +- classes/class_editorscript.rst | 7 +- classes/class_editorselection.rst | 3 + classes/class_editorsettings.rst | 83 +++--- classes/class_editorspatialgizmo.rst | 35 ++- classes/class_editorspatialgizmoplugin.rst | 51 ++-- classes/class_editorspinslider.rst | 3 + classes/class_editorvcsinterface.rst | 3 + classes/class_encodedobjectasid.rst | 3 + classes/class_engine.rst | 95 +++--- classes/class_environment.rst | 7 +- classes/class_expression.rst | 11 +- classes/class_externaltexture.rst | 3 + classes/class_file.rst | 105 +++---- classes/class_filedialog.rst | 5 + classes/class_filesystemdock.rst | 23 +- classes/class_float.rst | 3 + classes/class_font.rst | 73 ++--- classes/class_funcref.rst | 11 +- classes/class_gdnative.rst | 3 + classes/class_gdnativelibrary.rst | 17 +- classes/class_gdscript.rst | 17 +- classes/class_gdscriptfunctionstate.rst | 15 +- classes/class_generic6dofjoint.rst | 27 +- classes/class_geometry.rst | 7 +- classes/class_geometryinstance.rst | 7 +- classes/class_giprobe.rst | 3 + classes/class_giprobedata.rst | 3 + classes/class_godotsharp.rst | 3 + classes/class_gradient.rst | 15 +- classes/class_gradienttexture.rst | 3 + classes/class_graphedit.rst | 11 +- classes/class_graphnode.rst | 27 +- classes/class_gridcontainer.rst | 11 +- classes/class_gridmap.rst | 33 ++- classes/class_groovejoint2d.rst | 3 + classes/class_hashingcontext.rst | 3 + classes/class_hboxcontainer.rst | 3 + classes/class_heightmapshape.rst | 3 + classes/class_hingejoint.rst | 11 +- classes/class_hscrollbar.rst | 3 + classes/class_hseparator.rst | 3 + classes/class_hslider.rst | 5 + classes/class_hsplitcontainer.rst | 3 + classes/class_httpclient.rst | 29 +- classes/class_httprequest.rst | 17 +- classes/class_image.rst | 77 ++--- classes/class_imagetexture.rst | 7 +- classes/class_immediategeometry.rst | 3 + classes/class_input.rst | 91 +++--- classes/class_inputevent.rst | 69 ++--- classes/class_inputeventaction.rst | 3 + classes/class_inputeventgesture.rst | 3 + classes/class_inputeventjoypadbutton.rst | 3 + classes/class_inputeventjoypadmotion.rst | 3 + classes/class_inputeventkey.rst | 11 +- classes/class_inputeventmagnifygesture.rst | 3 + classes/class_inputeventmidi.rst | 3 + classes/class_inputeventmouse.rst | 3 + classes/class_inputeventmousebutton.rst | 3 + classes/class_inputeventmousemotion.rst | 3 + classes/class_inputeventpangesture.rst | 3 + classes/class_inputeventscreendrag.rst | 3 + classes/class_inputeventscreentouch.rst | 3 + classes/class_inputeventwithmodifiers.rst | 3 + classes/class_inputmap.rst | 57 ++-- classes/class_instanceplaceholder.rst | 7 +- classes/class_int.rst | 3 + classes/class_interpolatedcamera.rst | 3 + classes/class_ip.rst | 19 +- classes/class_itemlist.rst | 63 ++-- classes/class_javaclass.rst | 3 + classes/class_javaclasswrapper.rst | 3 + classes/class_javascript.rst | 3 + classes/class_jnisingleton.rst | 3 + classes/class_joint.rst | 3 + classes/class_joint2d.rst | 3 + classes/class_json.rst | 32 +- classes/class_jsonparseresult.rst | 13 +- classes/class_jsonrpc.rst | 35 ++- classes/class_kinematicbody.rst | 31 +- classes/class_kinematicbody2d.rst | 27 +- classes/class_kinematiccollision.rst | 3 + classes/class_kinematiccollision2d.rst | 3 + classes/class_label.rst | 29 +- classes/class_largetexture.rst | 15 +- classes/class_light.rst | 7 +- classes/class_light2d.rst | 3 + classes/class_lightoccluder2d.rst | 3 + classes/class_line2d.rst | 13 +- classes/class_lineedit.rst | 7 +- classes/class_lineshape2d.rst | 3 + classes/class_linkbutton.rst | 3 + classes/class_listener.rst | 25 +- classes/class_mainloop.rst | 77 ++--- classes/class_margincontainer.rst | 3 + classes/class_marshalls.rst | 3 + classes/class_material.rst | 3 + classes/class_menubutton.rst | 7 +- classes/class_mesh.rst | 43 +-- classes/class_meshdatatool.rst | 95 +++--- classes/class_meshinstance.rst | 11 +- classes/class_meshinstance2d.rst | 3 + classes/class_meshlibrary.rst | 39 +-- classes/class_meshtexture.rst | 3 + classes/class_mobilevrinterface.rst | 3 + classes/class_multimesh.rst | 23 +- classes/class_multimeshinstance.rst | 3 + classes/class_multimeshinstance2d.rst | 3 + classes/class_multiplayerapi.rst | 23 +- classes/class_multiplayerpeergdnative.rst | 3 + classes/class_mutex.rst | 3 + classes/class_nativescript.rst | 35 ++- classes/class_navigation.rst | 3 + classes/class_navigation2d.rst | 3 + classes/class_navigationmesh.rst | 15 +- classes/class_navigationmeshinstance.rst | 3 + classes/class_navigationpolygon.rst | 19 +- classes/class_navigationpolygoninstance.rst | 3 + classes/class_networkedmultiplayerenet.rst | 19 +- classes/class_networkedmultiplayerpeer.rst | 15 +- classes/class_ninepatchrect.rst | 7 +- classes/class_node.rst | 209 ++++++------- classes/class_node2d.rst | 57 ++-- classes/class_nodepath.rst | 3 + classes/class_noisetexture.rst | 3 + classes/class_object.rst | 133 +++++---- classes/class_occluderpolygon2d.rst | 3 + classes/class_omnilight.rst | 3 + classes/class_opensimplexnoise.rst | 3 + classes/class_optionbutton.rst | 45 +-- classes/class_os.rst | 263 +++++++++-------- classes/class_packeddatacontainer.rst | 7 +- classes/class_packeddatacontainerref.rst | 11 +- classes/class_packedscene.rst | 25 +- classes/class_packetpeer.rst | 11 +- classes/class_packetpeerdtls.rst | 7 +- classes/class_packetpeergdnative.rst | 3 + classes/class_packetpeerstream.rst | 3 + classes/class_packetpeerudp.rst | 19 +- classes/class_panel.rst | 3 + classes/class_panelcontainer.rst | 3 + classes/class_panoramasky.rst | 3 + classes/class_parallaxbackground.rst | 3 + classes/class_parallaxlayer.rst | 3 + classes/class_particles.rst | 11 +- classes/class_particles2d.rst | 15 +- classes/class_particlesmaterial.rst | 19 +- classes/class_path.rst | 3 + classes/class_path2d.rst | 3 + classes/class_pathfollow.rst | 3 + classes/class_pathfollow2d.rst | 3 + classes/class_pckpacker.rst | 3 + classes/class_performance.rst | 11 +- classes/class_phashtranslation.rst | 3 + classes/class_physicalbone.rst | 7 +- classes/class_physics2ddirectbodystate.rst | 103 +++---- classes/class_physics2ddirectspacestate.rst | 3 + classes/class_physics2dserver.rst | 129 ++++---- .../class_physics2dshapequeryparameters.rst | 5 +- classes/class_physics2dshapequeryresult.rst | 35 ++- classes/class_physics2dtestmotionresult.rst | 3 + classes/class_physicsbody.rst | 15 +- classes/class_physicsbody2d.rst | 15 +- classes/class_physicsdirectbodystate.rst | 103 +++---- classes/class_physicsdirectspacestate.rst | 3 + classes/class_physicsmaterial.rst | 3 + classes/class_physicsserver.rst | 155 +++++----- classes/class_physicsshapequeryparameters.rst | 5 +- classes/class_physicsshapequeryresult.rst | 35 ++- classes/class_pinjoint.rst | 7 +- classes/class_pinjoint2d.rst | 3 + classes/class_plane.rst | 3 + classes/class_planemesh.rst | 3 + classes/class_planeshape.rst | 3 + classes/class_pluginscript.rst | 11 +- classes/class_pointmesh.rst | 3 + classes/class_polygon2d.rst | 15 +- classes/class_polygonpathfinder.rst | 23 +- classes/class_poolbytearray.rst | 3 + classes/class_poolcolorarray.rst | 3 + classes/class_poolintarray.rst | 3 + classes/class_poolrealarray.rst | 3 + classes/class_poolstringarray.rst | 3 + classes/class_poolvector2array.rst | 3 + classes/class_poolvector3array.rst | 3 + classes/class_popup.rst | 5 + classes/class_popupdialog.rst | 3 + classes/class_popupmenu.rst | 75 ++--- classes/class_popuppanel.rst | 3 + classes/class_position2d.rst | 3 + classes/class_position3d.rst | 3 + classes/class_primitivemesh.rst | 11 +- classes/class_prismmesh.rst | 3 + classes/class_proceduralsky.rst | 3 + classes/class_progressbar.rst | 3 + classes/class_projectsettings.rst | 31 +- classes/class_proximitygroup.rst | 3 + classes/class_proxytexture.rst | 3 + classes/class_quadmesh.rst | 3 + classes/class_quat.rst | 3 + classes/class_randomnumbergenerator.rst | 3 + classes/class_range.rst | 3 + classes/class_raycast.rst | 29 +- classes/class_raycast2d.rst | 29 +- classes/class_rayshape.rst | 3 + classes/class_rayshape2d.rst | 3 + classes/class_rect2.rst | 3 + classes/class_rectangleshape2d.rst | 3 + classes/class_reference.rst | 3 + classes/class_referencerect.rst | 3 + classes/class_reflectionprobe.rst | 3 + classes/class_regex.rst | 55 ++-- classes/class_regexmatch.rst | 29 +- classes/class_remotetransform.rst | 3 + classes/class_remotetransform2d.rst | 3 + classes/class_resource.rst | 37 +-- classes/class_resourceformatloader.rst | 41 +-- classes/class_resourceformatsaver.rst | 23 +- classes/class_resourceimporter.rst | 3 + classes/class_resourceinteractiveloader.rst | 29 +- classes/class_resourceloader.rst | 3 + classes/class_resourcepreloader.rst | 15 +- classes/class_resourcesaver.rst | 3 + classes/class_richtexteffect.rst | 11 +- classes/class_richtextlabel.rst | 21 +- classes/class_rid.rst | 3 + classes/class_rigidbody.rst | 63 ++-- classes/class_rigidbody2d.rst | 15 +- classes/class_rootmotionview.rst | 3 + classes/class_scenestate.rst | 125 ++++---- classes/class_scenetree.rst | 43 +-- classes/class_scenetreetimer.rst | 3 + classes/class_script.rst | 31 +- classes/class_scriptcreatedialog.rst | 3 + classes/class_scripteditor.rst | 37 +-- classes/class_scrollbar.rst | 3 + classes/class_scrollcontainer.rst | 3 + classes/class_segmentshape2d.rst | 3 + classes/class_semaphore.rst | 3 + classes/class_separator.rst | 3 + classes/class_shader.rst | 39 +-- classes/class_shadermaterial.rst | 7 +- classes/class_shape.rst | 3 + classes/class_shape2d.rst | 3 + classes/class_shortcut.rst | 23 +- classes/class_skeleton.rst | 43 +-- classes/class_skeleton2d.rst | 11 +- classes/class_skeletonik.rst | 7 +- classes/class_skin.rst | 19 +- classes/class_skinreference.rst | 17 +- classes/class_sky.rst | 3 + classes/class_slider.rst | 5 + classes/class_sliderjoint.rst | 7 +- classes/class_softbody.rst | 15 +- classes/class_spatial.rst | 39 +-- classes/class_spatialgizmo.rst | 3 + classes/class_spatialmaterial.rst | 15 +- classes/class_spatialvelocitytracker.rst | 7 +- classes/class_spheremesh.rst | 3 + classes/class_sphereshape.rst | 3 + classes/class_spinbox.rst | 3 + classes/class_splitcontainer.rst | 3 + classes/class_spotlight.rst | 3 + classes/class_springarm.rst | 5 +- classes/class_sprite.rst | 17 +- classes/class_sprite3d.rst | 7 +- classes/class_spritebase3d.rst | 15 +- classes/class_spriteframes.rst | 29 +- classes/class_staticbody.rst | 3 + classes/class_staticbody2d.rst | 3 + classes/class_streampeer.rst | 7 +- classes/class_streampeerbuffer.rst | 15 +- classes/class_streampeergdnative.rst | 3 + classes/class_streampeerssl.rst | 7 +- classes/class_streampeertcp.rst | 15 +- classes/class_streamtexture.rst | 3 + classes/class_string.rst | 3 + classes/class_stylebox.rst | 35 ++- classes/class_styleboxempty.rst | 3 + classes/class_styleboxflat.rst | 19 +- classes/class_styleboxline.rst | 3 + classes/class_styleboxtexture.rst | 11 +- classes/class_surfacetool.rst | 3 + classes/class_tabcontainer.rst | 39 +-- classes/class_tabs.rst | 39 +-- classes/class_tcp_server.rst | 11 +- classes/class_textedit.rst | 97 +++--- classes/class_textfile.rst | 3 + classes/class_texture.rst | 55 ++-- classes/class_texture3d.rst | 3 + classes/class_texturearray.rst | 3 + classes/class_texturebutton.rst | 3 + classes/class_texturelayered.rst | 23 +- classes/class_textureprogress.rst | 7 +- classes/class_texturerect.rst | 3 + classes/class_theme.rst | 71 ++--- classes/class_thread.rst | 15 +- classes/class_tilemap.rst | 57 ++-- classes/class_tileset.rst | 131 ++++---- classes/class_timer.rst | 7 +- classes/class_toolbutton.rst | 3 + classes/class_touchscreenbutton.rst | 19 +- classes/class_transform.rst | 3 + classes/class_transform2d.rst | 3 + classes/class_translation.rst | 15 +- classes/class_translationserver.rst | 19 +- classes/class_tree.rst | 125 ++++---- classes/class_treeitem.rst | 103 +++---- classes/class_trianglemesh.rst | 3 + classes/class_tween.rst | 15 +- classes/class_udpserver.rst | 11 +- classes/class_undoredo.rst | 23 +- classes/class_upnp.rst | 61 ++-- classes/class_upnpdevice.rst | 29 +- classes/class_variant.rst | 3 + classes/class_vboxcontainer.rst | 3 + classes/class_vector2.rst | 7 +- classes/class_vector3.rst | 3 + classes/class_vehiclebody.rst | 3 + classes/class_vehiclewheel.rst | 23 +- classes/class_videoplayer.rst | 31 +- classes/class_videostream.rst | 3 + classes/class_videostreamgdnative.rst | 3 + classes/class_videostreamtheora.rst | 3 + classes/class_videostreamwebm.rst | 3 + classes/class_viewport.rst | 73 ++--- classes/class_viewportcontainer.rst | 3 + classes/class_viewporttexture.rst | 3 + classes/class_visibilityenabler.rst | 7 +- classes/class_visibilityenabler2d.rst | 7 +- classes/class_visibilitynotifier.rst | 11 +- classes/class_visibilitynotifier2d.rst | 11 +- classes/class_visualinstance.rst | 23 +- classes/class_visualscript.rst | 67 +++-- .../class_visualscriptbasictypeconstant.rst | 3 + classes/class_visualscriptbuiltinfunc.rst | 3 + classes/class_visualscriptclassconstant.rst | 3 + classes/class_visualscriptcomment.rst | 3 + classes/class_visualscriptcomposearray.rst | 3 + classes/class_visualscriptcondition.rst | 3 + classes/class_visualscriptconstant.rst | 3 + classes/class_visualscriptconstructor.rst | 11 +- classes/class_visualscriptcustomnode.rst | 89 +++--- classes/class_visualscriptdeconstruct.rst | 3 + classes/class_visualscripteditor.rst | 3 + classes/class_visualscriptemitsignal.rst | 3 + classes/class_visualscriptenginesingleton.rst | 3 + classes/class_visualscriptexpression.rst | 3 + classes/class_visualscriptfunction.rst | 3 + classes/class_visualscriptfunctioncall.rst | 3 + classes/class_visualscriptfunctionstate.rst | 7 +- classes/class_visualscriptglobalconstant.rst | 3 + classes/class_visualscriptindexget.rst | 3 + classes/class_visualscriptindexset.rst | 3 + classes/class_visualscriptinputaction.rst | 3 + classes/class_visualscriptiterator.rst | 3 + classes/class_visualscriptlists.rst | 3 + classes/class_visualscriptlocalvar.rst | 3 + classes/class_visualscriptlocalvarset.rst | 3 + classes/class_visualscriptmathconstant.rst | 3 + classes/class_visualscriptnode.rst | 11 +- classes/class_visualscriptoperator.rst | 3 + classes/class_visualscriptpreload.rst | 3 + classes/class_visualscriptpropertyget.rst | 3 + classes/class_visualscriptpropertyset.rst | 3 + classes/class_visualscriptresourcepath.rst | 3 + classes/class_visualscriptreturn.rst | 3 + classes/class_visualscriptscenenode.rst | 3 + classes/class_visualscriptscenetree.rst | 3 + classes/class_visualscriptselect.rst | 3 + classes/class_visualscriptself.rst | 3 + classes/class_visualscriptsequence.rst | 3 + classes/class_visualscriptsubcall.rst | 11 +- classes/class_visualscriptswitch.rst | 3 + classes/class_visualscripttypecast.rst | 3 + classes/class_visualscriptvariableget.rst | 3 + classes/class_visualscriptvariableset.rst | 3 + classes/class_visualscriptwhile.rst | 3 + classes/class_visualscriptyield.rst | 3 + classes/class_visualscriptyieldsignal.rst | 3 + classes/class_visualserver.rst | 279 +++++++++--------- classes/class_visualshader.rst | 83 +++--- classes/class_visualshadernode.rst | 11 +- .../class_visualshadernodebooleanconstant.rst | 3 + .../class_visualshadernodebooleanuniform.rst | 3 + .../class_visualshadernodecolorconstant.rst | 3 + classes/class_visualshadernodecolorfunc.rst | 3 + classes/class_visualshadernodecolorop.rst | 3 + .../class_visualshadernodecoloruniform.rst | 3 + classes/class_visualshadernodecompare.rst | 3 + classes/class_visualshadernodecubemap.rst | 3 + .../class_visualshadernodecubemapuniform.rst | 3 + classes/class_visualshadernodecustom.rst | 83 +++--- classes/class_visualshadernodedeterminant.rst | 3 + classes/class_visualshadernodedotproduct.rst | 3 + classes/class_visualshadernodeexpression.rst | 3 + classes/class_visualshadernodefaceforward.rst | 3 + classes/class_visualshadernodefresnel.rst | 3 + ...class_visualshadernodeglobalexpression.rst | 3 + classes/class_visualshadernodegroupbase.rst | 39 +-- classes/class_visualshadernodeif.rst | 3 + classes/class_visualshadernodeinput.rst | 11 +- classes/class_visualshadernodeis.rst | 3 + .../class_visualshadernodeouterproduct.rst | 3 + classes/class_visualshadernodeoutput.rst | 3 + classes/class_visualshadernodescalarclamp.rst | 3 + .../class_visualshadernodescalarconstant.rst | 3 + ...s_visualshadernodescalarderivativefunc.rst | 3 + classes/class_visualshadernodescalarfunc.rst | 3 + .../class_visualshadernodescalarinterp.rst | 3 + classes/class_visualshadernodescalarop.rst | 3 + ...class_visualshadernodescalarsmoothstep.rst | 3 + .../class_visualshadernodescalarswitch.rst | 3 + .../class_visualshadernodescalaruniform.rst | 3 + classes/class_visualshadernodeswitch.rst | 3 + classes/class_visualshadernodetexture.rst | 3 + .../class_visualshadernodetextureuniform.rst | 3 + ...isualshadernodetextureuniformtriplanar.rst | 3 + ...class_visualshadernodetransformcompose.rst | 3 + ...lass_visualshadernodetransformconstant.rst | 3 + ...ass_visualshadernodetransformdecompose.rst | 3 + .../class_visualshadernodetransformfunc.rst | 3 + .../class_visualshadernodetransformmult.rst | 3 + ...class_visualshadernodetransformuniform.rst | 3 + ...class_visualshadernodetransformvecmult.rst | 3 + classes/class_visualshadernodeuniform.rst | 3 + .../class_visualshadernodevec3constant.rst | 3 + classes/class_visualshadernodevec3uniform.rst | 3 + classes/class_visualshadernodevectorclamp.rst | 3 + .../class_visualshadernodevectorcompose.rst | 3 + .../class_visualshadernodevectordecompose.rst | 3 + ...s_visualshadernodevectorderivativefunc.rst | 3 + .../class_visualshadernodevectordistance.rst | 3 + classes/class_visualshadernodevectorfunc.rst | 3 + .../class_visualshadernodevectorinterp.rst | 3 + classes/class_visualshadernodevectorlen.rst | 3 + classes/class_visualshadernodevectorop.rst | 3 + .../class_visualshadernodevectorrefract.rst | 3 + .../class_visualshadernodevectorscalarmix.rst | 3 + ...visualshadernodevectorscalarsmoothstep.rst | 3 + ...class_visualshadernodevectorscalarstep.rst | 3 + ...class_visualshadernodevectorsmoothstep.rst | 3 + classes/class_vscrollbar.rst | 3 + classes/class_vseparator.rst | 3 + classes/class_vslider.rst | 5 + classes/class_vsplitcontainer.rst | 3 + classes/class_weakref.rst | 11 +- classes/class_webrtcdatachannel.rst | 67 +++-- classes/class_webrtcdatachannelgdnative.rst | 3 + classes/class_webrtcmultiplayer.rst | 3 + classes/class_webrtcpeerconnection.rst | 9 +- .../class_webrtcpeerconnectiongdnative.rst | 3 + classes/class_websocketclient.rst | 11 +- classes/class_websocketmultiplayerpeer.rst | 7 +- classes/class_websocketpeer.rst | 23 +- classes/class_websocketserver.rst | 19 +- classes/class_windowdialog.rst | 3 + classes/class_world.rst | 3 + classes/class_world2d.rst | 3 + classes/class_worldenvironment.rst | 3 + classes/class_x509certificate.rst | 3 + classes/class_xmlparser.rst | 95 +++--- classes/class_ysort.rst | 3 + 650 files changed, 6538 insertions(+), 4385 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 61dc64760..d1620d34b 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -126,19 +126,19 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print` **(** ... **)** vararg | +| void | :ref:`print` **(** ... **)** |vararg| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_debug` **(** ... **)** vararg | +| void | :ref:`print_debug` **(** ... **)** |vararg| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print_stack` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printerr` **(** ... **)** vararg | +| void | :ref:`printerr` **(** ... **)** |vararg| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printraw` **(** ... **)** vararg | +| void | :ref:`printraw` **(** ... **)** |vararg| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`prints` **(** ... **)** vararg | +| void | :ref:`prints` **(** ... **)** |vararg| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printt` **(** ... **)** vararg | +| void | :ref:`printt` **(** ... **)** |vararg| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_error` **(** :ref:`String` message **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -156,7 +156,7 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`randomize` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`range` **(** ... **)** vararg | +| :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 **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -178,7 +178,7 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`str` **(** ... **)** vararg | +| :ref:`String` | :ref:`str` **(** ... **)** |vararg| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -378,6 +378,8 @@ Rounds ``s`` upward (towards positive infinity), returning the smallest whole nu i = ceil(1.45) # i is 2 i = ceil(1.001) # i is 2 +See also :ref:`floor`, :ref:`round`, and :ref:`stepify`. + ---- .. _class_@GDScript_method_char: @@ -545,6 +547,8 @@ Rounds ``s`` downward (towards negative infinity), returning the largest whole n # a is -3.0 a = floor(-2.99) +See also :ref:`ceil`, :ref:`round`, and :ref:`stepify`. + **Note:** This method returns a float. If you need an integer, you can use ``int(s)`` directly. ---- @@ -572,26 +576,21 @@ Returns the floating-point modulus of ``a/b`` that wraps equally in positive and :: - var i = -6 - while i < 5: - prints(i, fposmod(i, 3)) - i += 1 + for i in 7: + var x = 0.5 * i - 1.5 + print("%4.1f %4.1f %4.1f" % [x, fmod(x, 1.5), fposmod(x, 1.5)]) Produces: :: - -6 0 - -5 1 - -4 2 - -3 0 - -2 1 - -1 2 - 0 0 - 1 1 - 2 2 - 3 0 - 4 1 + -1.5 -0.0 0.0 + -1.0 -1.0 0.5 + -0.5 -0.5 1.0 + 0.0 0.0 0.0 + 0.5 0.5 0.5 + 1.0 1.0 1.0 + 1.5 0.0 0.0 ---- @@ -917,19 +916,21 @@ This is the inverse of :ref:`char`. - :ref:`Variant` **parse_json** **(** :ref:`String` json **)** -Parse JSON text to a Variant (use :ref:`typeof` to check if it is what you expect). +Parse JSON text to a Variant. (Use :ref:`typeof` to check if the Variant's type is what you expect.) -Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to :ref:`float` types. +**Note:** The JSON specification does not define integer or float types, but only a *number* type. Therefore, parsing a JSON text will convert all numerical values to :ref:`float` types. -Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements: +**Note:** JSON objects do not preserve key order like Godot dictionaries, thus, you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements: :: - p = parse_json('["a", "b", "c"]') - if typeof(p) == TYPE_ARRAY: - print(p[0]) # Prints a + var p = JSON.parse('["hello", "world", "!"]') + if typeof(p.result) == TYPE_ARRAY: + print(p.result[0]) # Prints "hello" else: - print("unexpected results") + push_error("Unexpected results.") + +See also :ref:`JSON` for an alternative way to parse JSON text. ---- @@ -949,26 +950,20 @@ Returns the integer modulus of ``a/b`` that wraps equally in positive and negati :: - var i = -6 - while i < 5: - prints(i, posmod(i, 3)) - i += 1 + for i in range(-3, 4): + print("%2.0f %2.0f %2.0f" % [i, i % 3, posmod(i, 3)]) Produces: :: - -6 0 - -5 1 - -4 2 - -3 0 - -2 1 - -1 2 - 0 0 - 1 1 - 2 2 - 3 0 - 4 1 + -3 0 0 + -2 -2 1 + -1 -1 2 + 0 0 0 + 1 1 1 + 2 2 2 + 3 0 0 ---- @@ -1001,7 +996,7 @@ Returns a :ref:`Resource` from the filesystem located at ``path` .. _class_@GDScript_method_print: -- void **print** **(** ... **)** vararg +- void **print** **(** ... **)** |vararg| Converts one or more arguments to strings in the best way possible and prints them to the console. @@ -1014,7 +1009,7 @@ Converts one or more arguments to strings in the best way possible and prints th .. _class_@GDScript_method_print_debug: -- void **print_debug** **(** ... **)** vararg +- void **print_debug** **(** ... **)** |vararg| Like :ref:`print`, but prints only when used in debug mode. @@ -1036,7 +1031,7 @@ Output in the console would look something like this: .. _class_@GDScript_method_printerr: -- void **printerr** **(** ... **)** vararg +- void **printerr** **(** ... **)** |vararg| Prints one or more arguments to strings in the best way possible to standard error line. @@ -1048,7 +1043,7 @@ Prints one or more arguments to strings in the best way possible to standard err .. _class_@GDScript_method_printraw: -- void **printraw** **(** ... **)** vararg +- void **printraw** **(** ... **)** |vararg| Prints one or more arguments to strings in the best way possible to console. No newline is added at the end. @@ -1064,7 +1059,7 @@ Prints one or more arguments to strings in the best way possible to console. No .. _class_@GDScript_method_prints: -- void **prints** **(** ... **)** vararg +- void **prints** **(** ... **)** |vararg| Prints one or more arguments to the console with a space between each argument. @@ -1076,7 +1071,7 @@ Prints one or more arguments to the console with a space between each argument. .. _class_@GDScript_method_printt: -- void **printt** **(** ... **)** vararg +- void **printt** **(** ... **)** |vararg| Prints one or more arguments to the console with a tab between each argument. @@ -1184,35 +1179,23 @@ Randomizes the seed (or the internal state) of the random number generator. Curr .. _class_@GDScript_method_range: -- :ref:`Array` **range** **(** ... **)** vararg +- :ref:`Array` **range** **(** ... **)** |vararg| Returns an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). :: - for i in range(4): - print(i) - for i in range(2, 5): - print(i) - for i in range(0, 6, 2): - print(i) + print(range(4)) + print(range(2, 5)) + print(range(0, 6, 2)) Output: :: - 0 - 1 - 2 - 3 - - 2 - 3 - 4 - - 0 - 2 - 4 + [0, 1, 2, 3] + [2, 3, 4] + [0, 2, 4] ---- @@ -1238,6 +1221,8 @@ Rounds ``s`` to the nearest whole number, with halfway cases rounded away from z round(2.6) # Returns 3 +See also :ref:`floor`, :ref:`ceil`, and :ref:`stepify`. + ---- .. _class_@GDScript_method_seed: @@ -1348,11 +1333,13 @@ Snaps float value ``s`` to a given ``step``. This can also be used to round a fl stepify(100, 32) # Returns 96 stepify(3.14159, 0.01) # Returns 3.14 +See also :ref:`ceil`, :ref:`floor`, and :ref:`round`. + ---- .. _class_@GDScript_method_str: -- :ref:`String` **str** **(** ... **)** vararg +- :ref:`String` **str** **(** ... **)** |vararg| Converts one or more arguments to string in the best way possible. @@ -1408,13 +1395,19 @@ Returns the hyperbolic tangent of ``s``. - :ref:`String` **to_json** **(** :ref:`Variant` var **)** -Converts a Variant ``var`` to JSON text and return the result. Useful for serializing data to store or send over the network. +Converts a :ref:`Variant` ``var`` to JSON text and return the result. Useful for serializing data to store or send over the network. :: + # Both numbers below are integers. a = { "a": 1, "b": 2 } b = to_json(a) print(b) # {"a":1, "b":2} + # Both numbers above are floats, even if they display without any decimal places. + +**Note:** The JSON specification does not define integer or float types, but only a *number* type. Therefore, converting a :ref:`Variant` to JSON text will convert all numerical values to :ref:`float` types. + +See also :ref:`JSON` for an alternative way to convert a :ref:`Variant` to JSON text. ---- @@ -1458,9 +1451,9 @@ Checks that ``json`` is valid JSON data. Returns an empty string if valid, or an j = to_json([1, 2, 3]) v = validate_json(j) if not v: - print("valid") + print("Valid JSON.") else: - prints("invalid", v) + push_error("Invalid JSON: " + v) ---- @@ -1594,3 +1587,6 @@ When yielding on a function, the ``completed`` signal will be emitted automatica In order to yield on a function, the resulting function should also return a ``GDScriptFunctionState``. Notice ``yield(get_tree(), "idle_frame")`` from the above example. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 21667483f..a42aeb725 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -790,13 +790,13 @@ enum **KeyList**: - **KEY_DIRECTION_R** = **16777267** --- Right Direction key. -- **KEY_BACK** = **16777280** --- Back key. +- **KEY_BACK** = **16777280** --- Media back key. Not to be confused with the Back button on an Android device. -- **KEY_FORWARD** = **16777281** --- Forward key. +- **KEY_FORWARD** = **16777281** --- Media forward key. -- **KEY_STOP** = **16777282** --- Stop key. +- **KEY_STOP** = **16777282** --- Media stop key. -- **KEY_REFRESH** = **16777283** --- Refresh key. +- **KEY_REFRESH** = **16777283** --- Media refresh key. - **KEY_VOLUMEDOWN** = **16777284** --- Volume down key. @@ -2417,3 +2417,6 @@ The :ref:`VisualScriptEditor` singleton. The :ref:`VisualServer` singleton. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 045591c3a..96a227d5b 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -307,3 +307,6 @@ Returns ``true`` if this ``AABB`` and ``aabb`` are approximately equal, by calli Returns a larger ``AABB`` that contains both this ``AABB`` and ``with``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index d888769a3..2e235c9d4 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -159,3 +159,6 @@ Returns the OK :ref:`Button` instance. Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 2371dc8db..7fbcada43 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -18,6 +18,13 @@ Description Animations are created using a :ref:`SpriteFrames` resource, which can be configured in the editor via the SpriteFrames panel. +**Note:** You can associate a set of normal maps by creating additional :ref:`SpriteFrames` resources with a ``_normal`` suffix. For example, having 2 :ref:`SpriteFrames` resources ``run`` and ``run_normal`` will make it so the ``run`` animation uses the normal map. + +Tutorials +--------- + +- :doc:`../tutorials/2d/2d_sprite_animation` + Properties ---------- @@ -45,7 +52,7 @@ Methods ------- +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | +| :ref:`bool` | :ref:`is_playing` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`play` **(** :ref:`String` anim="", :ref:`bool` backwards=false **)** | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ @@ -213,7 +220,7 @@ Method Descriptions .. _class_AnimatedSprite_method_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** |const| Returns ``true`` if an animation is currently being played. @@ -233,3 +240,6 @@ Plays the animation named ``anim``. If no ``anim`` is provided, the current anim Stops the current animation (does not reset the frame counter). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index ec71e5a69..e416749fc 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -18,6 +18,11 @@ Description Animations are created using a :ref:`SpriteFrames` resource, which can be configured in the editor via the SpriteFrames panel. +Tutorials +--------- + +- :doc:`../tutorials/2d/2d_sprite_animation` + Properties ---------- @@ -35,7 +40,7 @@ Methods ------- +-------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | +| :ref:`bool` | :ref:`is_playing` **(** **)** |const| | +-------------------------+-------------------------------------------------------------------------------------------------+ | void | :ref:`play` **(** :ref:`String` anim="" **)** | +-------------------------+-------------------------------------------------------------------------------------------------+ @@ -115,7 +120,7 @@ Method Descriptions .. _class_AnimatedSprite3D_method_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** |const| Returns ``true`` if an animation is currently being played. @@ -135,3 +140,6 @@ Plays the animation named ``anim``. If no ``anim`` is provided, the current anim Stops the current animation (does not reset the frame counter). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index cdba042f3..f55d96c3f 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -20,7 +20,9 @@ Description The playback of the animation is controlled by the :ref:`fps` property as well as each frame's optional delay (see :ref:`set_frame_delay`). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame. -``AnimatedTexture`` currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one. Also, it doesn't support :ref:`AtlasTexture`. Each frame needs to be separate image. +``AnimatedTexture`` currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one. + +**Note:** AnimatedTexture doesn't support using :ref:`AtlasTexture`\ s. Each frame needs to be a separate :ref:`Texture`. Properties ---------- @@ -43,9 +45,9 @@ Methods ------- +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_frame_delay` **(** :ref:`int` frame **)** const | +| :ref:`float` | :ref:`get_frame_delay` **(** :ref:`int` frame **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame_texture` **(** :ref:`int` frame **)** const | +| :ref:`Texture` | :ref:`get_frame_texture` **(** :ref:`int` frame **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_frame_delay` **(** :ref:`int` frame, :ref:`float` delay **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -145,7 +147,7 @@ Method Descriptions .. _class_AnimatedTexture_method_get_frame_delay: -- :ref:`float` **get_frame_delay** **(** :ref:`int` frame **)** const +- :ref:`float` **get_frame_delay** **(** :ref:`int` frame **)** |const| Returns the given frame's delay value. @@ -153,7 +155,7 @@ Returns the given frame's delay value. .. _class_AnimatedTexture_method_get_frame_texture: -- :ref:`Texture` **get_frame_texture** **(** :ref:`int` frame **)** const +- :ref:`Texture` **get_frame_texture** **(** :ref:`int` frame **)** |const| Returns the given frame's :ref:`Texture`. @@ -184,3 +186,6 @@ Assigns a :ref:`Texture` to the given frame. Frame IDs start at 0 You can define any number of textures up to :ref:`MAX_FRAMES`, but keep in mind that only frames from 0 to :ref:`frames` - 1 will be part of the animation. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 3b7ff7b23..f67aea8b5 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -52,17 +52,17 @@ Methods +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`add_track` **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_track_get_key_animation` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`String` | :ref:`animation_track_get_key_animation` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`animation_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`String` animation **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`animation_track_set_key_animation` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`String` animation **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio_track_get_key_end_offset` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`float` | :ref:`audio_track_get_key_end_offset` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio_track_get_key_start_offset` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`float` | :ref:`audio_track_get_key_start_offset` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`audio_track_get_key_stream` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`Resource` | :ref:`audio_track_get_key_stream` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`audio_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,15 +72,15 @@ Methods +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`audio_track_set_key_stream` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Resource` stream **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`bezier_track_get_key_in_handle` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`Vector2` | :ref:`bezier_track_get_key_in_handle` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`bezier_track_get_key_out_handle` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`Vector2` | :ref:`bezier_track_get_key_out_handle` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bezier_track_get_key_value` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`float` | :ref:`bezier_track_get_key_value` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`bezier_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bezier_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time **)** const | +| :ref:`float` | :ref:`bezier_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`bezier_track_set_key_in_handle` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -92,41 +92,41 @@ Methods +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`copy_track` **(** :ref:`int` track_idx, :ref:`Animation` to_animation **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | +| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_track_count` **(** **)** const | +| :ref:`int` | :ref:`get_track_count` **(** **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_track` **(** :ref:`int` track_idx **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`bool` exact=false **)** const | +| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`bool` exact=false **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` track_idx **)** const | +| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` track_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InterpolationType` | :ref:`track_get_interpolation_type` **(** :ref:`int` track_idx **)** const | +| :ref:`InterpolationType` | :ref:`track_get_interpolation_type` **(** :ref:`int` track_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` track_idx **)** const | +| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` track_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` track_idx **)** const | +| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` track_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackType` | :ref:`track_get_type` **(** :ref:`int` track_idx **)** const | +| :ref:`TrackType` | :ref:`track_get_type` **(** :ref:`int` track_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_is_enabled` **(** :ref:`int` track_idx **)** const | +| :ref:`bool` | :ref:`track_is_enabled` **(** :ref:`int` track_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` track_idx **)** const | +| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` track_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_move_down` **(** :ref:`int` track_idx **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -158,11 +158,11 @@ Methods +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** const | +| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` track_idx **)** const | +| :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` track_idx **)** |const| | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`value_track_set_update_mode` **(** :ref:`int` track_idx, :ref:`UpdateMode` mode **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -311,7 +311,7 @@ Adds a track to the Animation. .. _class_Animation_method_animation_track_get_key_animation: -- :ref:`String` **animation_track_get_key_animation** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`String` **animation_track_get_key_animation** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the animation name at the key identified by ``key_idx``. The ``track_idx`` must be the index of an Animation Track. @@ -335,7 +335,7 @@ Sets the key identified by ``key_idx`` to value ``animation``. The ``track_idx`` .. _class_Animation_method_audio_track_get_key_end_offset: -- :ref:`float` **audio_track_get_key_end_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`float` **audio_track_get_key_end_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the end offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. @@ -345,7 +345,7 @@ End offset is the number of seconds cut off at the ending of the audio stream. .. _class_Animation_method_audio_track_get_key_start_offset: -- :ref:`float` **audio_track_get_key_start_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`float` **audio_track_get_key_start_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the start offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. @@ -355,7 +355,7 @@ Start offset is the number of seconds cut off at the beginning of the audio stre .. _class_Animation_method_audio_track_get_key_stream: -- :ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the audio stream of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. @@ -397,7 +397,7 @@ Sets the stream of the key identified by ``key_idx`` to value ``offset``. The `` .. _class_Animation_method_bezier_track_get_key_in_handle: -- :ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the in handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. @@ -405,7 +405,7 @@ Returns the in handle of the key identified by ``key_idx``. The ``track_idx`` mu .. _class_Animation_method_bezier_track_get_key_out_handle: -- :ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the out handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. @@ -413,7 +413,7 @@ Returns the out handle of the key identified by ``key_idx``. The ``track_idx`` m .. _class_Animation_method_bezier_track_get_key_value: -- :ref:`float` **bezier_track_get_key_value** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`float` **bezier_track_get_key_value** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the value of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. @@ -431,7 +431,7 @@ Inserts a Bezier Track key at the given ``time`` in seconds. The ``track_idx`` m .. _class_Animation_method_bezier_track_interpolate: -- :ref:`float` **bezier_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time **)** const +- :ref:`float` **bezier_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time **)** |const| Returns the interpolated value at the given ``time`` (in seconds). The ``track_idx`` must be the index of a Bezier Track. @@ -479,7 +479,7 @@ Adds a new track that is a copy of the given track from ``to_animation``. .. _class_Animation_method_find_track: -- :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const +- :ref:`int` **find_track** **(** :ref:`NodePath` path **)** |const| Returns the index of the specified track. If the track is not found, return -1. @@ -487,7 +487,7 @@ Returns the index of the specified track. If the track is not found, return -1. .. _class_Animation_method_get_track_count: -- :ref:`int` **get_track_count** **(** **)** const +- :ref:`int` **get_track_count** **(** **)** |const| Returns the amount of tracks in the animation. @@ -495,7 +495,7 @@ Returns the amount of tracks in the animation. .. _class_Animation_method_method_track_get_key_indices: -- :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** |const| Returns all the key indices of a method track, given a position and delta time. @@ -503,7 +503,7 @@ Returns all the key indices of a method track, given a position and delta time. .. _class_Animation_method_method_track_get_name: -- :ref:`String` **method_track_get_name** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`String` **method_track_get_name** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the method name of a method track. @@ -511,7 +511,7 @@ Returns the method name of a method track. .. _class_Animation_method_method_track_get_params: -- :ref:`Array` **method_track_get_params** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`Array` **method_track_get_params** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the arguments values to be called on a method track for a given key in a given track. @@ -527,7 +527,7 @@ Removes a track by specifying the track index. .. _class_Animation_method_track_find_key: -- :ref:`int` **track_find_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`bool` exact=false **)** const +- :ref:`int` **track_find_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`bool` exact=false **)** |const| Finds the key index by time in a given track. Optionally, only find it if the exact time is given. @@ -535,7 +535,7 @@ Finds the key index by time in a given track. Optionally, only find it if the ex .. _class_Animation_method_track_get_interpolation_loop_wrap: -- :ref:`bool` **track_get_interpolation_loop_wrap** **(** :ref:`int` track_idx **)** const +- :ref:`bool` **track_get_interpolation_loop_wrap** **(** :ref:`int` track_idx **)** |const| Returns ``true`` if the track at ``idx`` wraps the interpolation loop. New tracks wrap the interpolation loop by default. @@ -543,7 +543,7 @@ Returns ``true`` if the track at ``idx`` wraps the interpolation loop. New track .. _class_Animation_method_track_get_interpolation_type: -- :ref:`InterpolationType` **track_get_interpolation_type** **(** :ref:`int` track_idx **)** const +- :ref:`InterpolationType` **track_get_interpolation_type** **(** :ref:`int` track_idx **)** |const| Returns the interpolation type of a given track. @@ -551,7 +551,7 @@ Returns the interpolation type of a given track. .. _class_Animation_method_track_get_key_count: -- :ref:`int` **track_get_key_count** **(** :ref:`int` track_idx **)** const +- :ref:`int` **track_get_key_count** **(** :ref:`int` track_idx **)** |const| Returns the amount of keys in a given track. @@ -559,7 +559,7 @@ Returns the amount of keys in a given track. .. _class_Animation_method_track_get_key_time: -- :ref:`float` **track_get_key_time** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`float` **track_get_key_time** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the time at which the key is located. @@ -567,7 +567,7 @@ Returns the time at which the key is located. .. _class_Animation_method_track_get_key_transition: -- :ref:`float` **track_get_key_transition** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`float` **track_get_key_transition** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the transition curve (easing) for a specific key (see the built-in math function :ref:`@GDScript.ease`). @@ -575,7 +575,7 @@ Returns the transition curve (easing) for a specific key (see the built-in math .. _class_Animation_method_track_get_key_value: -- :ref:`Variant` **track_get_key_value** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`Variant` **track_get_key_value** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** |const| Returns the value of a given key in a given track. @@ -583,7 +583,7 @@ Returns the value of a given key in a given track. .. _class_Animation_method_track_get_path: -- :ref:`NodePath` **track_get_path** **(** :ref:`int` track_idx **)** const +- :ref:`NodePath` **track_get_path** **(** :ref:`int` track_idx **)** |const| Gets the path of a track. For more information on the path format, see :ref:`track_set_path`. @@ -591,7 +591,7 @@ Gets the path of a track. For more information on the path format, see :ref:`tra .. _class_Animation_method_track_get_type: -- :ref:`TrackType` **track_get_type** **(** :ref:`int` track_idx **)** const +- :ref:`TrackType` **track_get_type** **(** :ref:`int` track_idx **)** |const| Gets the type of a track. @@ -607,7 +607,7 @@ Insert a generic key in a given track. .. _class_Animation_method_track_is_enabled: -- :ref:`bool` **track_is_enabled** **(** :ref:`int` track_idx **)** const +- :ref:`bool` **track_is_enabled** **(** :ref:`int` track_idx **)** |const| Returns ``true`` if the track at index ``idx`` is enabled. @@ -615,7 +615,7 @@ Returns ``true`` if the track at index ``idx`` is enabled. .. _class_Animation_method_track_is_imported: -- :ref:`bool` **track_is_imported** **(** :ref:`int` track_idx **)** const +- :ref:`bool` **track_is_imported** **(** :ref:`int` track_idx **)** |const| Returns ``true`` if the given track is imported. Else, return ``false``. @@ -745,7 +745,7 @@ Insert a transform key for a transform track. .. _class_Animation_method_transform_track_interpolate: -- :ref:`Array` **transform_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** const +- :ref:`Array` **transform_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time_sec **)** |const| Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3`), rotation (:ref:`Quat`) and scale (:ref:`Vector3`). @@ -753,7 +753,7 @@ Returns the interpolated value of a transform track at a given time (in seconds) .. _class_Animation_method_value_track_get_key_indices: -- :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** |const| Returns all the key indices of a value track, given a position and delta time. @@ -761,7 +761,7 @@ Returns all the key indices of a value track, given a position and delta time. .. _class_Animation_method_value_track_get_update_mode: -- :ref:`UpdateMode` **value_track_get_update_mode** **(** :ref:`int` track_idx **)** const +- :ref:`UpdateMode` **value_track_get_update_mode** **(** :ref:`int` track_idx **)** |const| Returns the update mode of a value track. @@ -773,3 +773,6 @@ Returns the update mode of a value track. Sets the update mode (see :ref:`UpdateMode`) of a value track. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index f3ec90946..9cff141ac 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -46,27 +46,27 @@ Methods +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`blend_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_caption` **(** **)** virtual | +| :ref:`String` | :ref:`get_caption` **(** **)** |virtual| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_child_by_name` **(** :ref:`String` name **)** virtual | +| :ref:`Object` | :ref:`get_child_by_name` **(** :ref:`String` name **)** |virtual| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_child_nodes` **(** **)** virtual | +| :ref:`Dictionary` | :ref:`get_child_nodes` **(** **)** |virtual| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_input_count` **(** **)** const | +| :ref:`int` | :ref:`get_input_count` **(** **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_parameter` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_parameter` **(** :ref:`String` name **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_parameter_default_value` **(** :ref:`String` name **)** virtual | +| :ref:`Variant` | :ref:`get_parameter_default_value` **(** :ref:`String` name **)** |virtual| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_parameter_list` **(** **)** virtual | +| :ref:`Array` | :ref:`get_parameter_list` **(** **)** |virtual| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`has_filter` **(** **)** virtual | +| :ref:`String` | :ref:`has_filter` **(** **)** |virtual| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | +| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** virtual | +| void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** |virtual| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_input` **(** :ref:`int` index **)** | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -167,7 +167,7 @@ Blend another animation node (in case this node contains children animation node .. _class_AnimationNode_method_get_caption: -- :ref:`String` **get_caption** **(** **)** virtual +- :ref:`String` **get_caption** **(** **)** |virtual| Gets the text caption for this node (used by some editors). @@ -175,7 +175,7 @@ Gets the text caption for this node (used by some editors). .. _class_AnimationNode_method_get_child_by_name: -- :ref:`Object` **get_child_by_name** **(** :ref:`String` name **)** virtual +- :ref:`Object` **get_child_by_name** **(** :ref:`String` name **)** |virtual| Gets a child node by index (used by editors inheriting from :ref:`AnimationRootNode`). @@ -183,7 +183,7 @@ Gets a child node by index (used by editors inheriting from :ref:`AnimationRootN .. _class_AnimationNode_method_get_child_nodes: -- :ref:`Dictionary` **get_child_nodes** **(** **)** virtual +- :ref:`Dictionary` **get_child_nodes** **(** **)** |virtual| Gets all children nodes in order as a ``name: node`` dictionary. Only useful when inheriting :ref:`AnimationRootNode`. @@ -191,7 +191,7 @@ Gets all children nodes in order as a ``name: node`` dictionary. Only useful whe .. _class_AnimationNode_method_get_input_count: -- :ref:`int` **get_input_count** **(** **)** const +- :ref:`int` **get_input_count** **(** **)** |const| Amount of inputs in this node, only useful for nodes that go into :ref:`AnimationNodeBlendTree`. @@ -207,7 +207,7 @@ Gets the name of an input by index. .. _class_AnimationNode_method_get_parameter: -- :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** |const| Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. @@ -215,7 +215,7 @@ Gets the value of a parameter. Parameters are custom local memory used for your .. _class_AnimationNode_method_get_parameter_default_value: -- :ref:`Variant` **get_parameter_default_value** **(** :ref:`String` name **)** virtual +- :ref:`Variant` **get_parameter_default_value** **(** :ref:`String` name **)** |virtual| Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. @@ -223,7 +223,7 @@ Gets the default value of a parameter. Parameters are custom local memory used f .. _class_AnimationNode_method_get_parameter_list: -- :ref:`Array` **get_parameter_list** **(** **)** virtual +- :ref:`Array` **get_parameter_list** **(** **)** |virtual| Gets the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to :ref:`Object.get_property_list`. @@ -231,7 +231,7 @@ Gets the property information for parameter. Parameters are custom local memory .. _class_AnimationNode_method_has_filter: -- :ref:`String` **has_filter** **(** **)** virtual +- :ref:`String` **has_filter** **(** **)** |virtual| Returns ``true`` whether you want the blend tree editor to display filter editing on this node. @@ -239,7 +239,7 @@ Returns ``true`` whether you want the blend tree editor to display filter editin .. _class_AnimationNode_method_is_path_filtered: -- :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const +- :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** |const| Returns ``true`` whether a given path is filtered. @@ -247,7 +247,7 @@ Returns ``true`` whether a given path is filtered. .. _class_AnimationNode_method_process: -- void **process** **(** :ref:`float` time, :ref:`bool` seek **)** virtual +- void **process** **(** :ref:`float` time, :ref:`bool` seek **)** |virtual| User-defined callback called when a custom node is processed. The ``time`` parameter is a relative delta, unless ``seek`` is ``true``, in which case it is absolute. @@ -279,3 +279,6 @@ Adds or removes a path for the filter. Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index 0e6f7004c..cbc30a0b1 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -47,3 +47,6 @@ Property Descriptions If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input`, forcing the blended animations to update every frame. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index 061e7c17d..a3f4cd3ab 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -55,3 +55,6 @@ Property Descriptions If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input`, forcing the blended animations to update every frame. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index ea63600b5..730ca765d 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -47,3 +47,6 @@ Property Descriptions Animation to use as an output. It is one of the animations provided by :ref:`AnimationTree.anim_player`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index 8e829a6e3..789cfdd5b 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -47,3 +47,6 @@ Property Descriptions If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input`, forcing the blended animations to update every frame. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index d2905646a..5baa201a6 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -55,3 +55,6 @@ Property Descriptions If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input`, forcing the blended animations to update every frame. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index f2921b2fb..cc85dd858 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -48,11 +48,11 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_point_count` **(** **)** const | +| :ref:`int` | :ref:`get_blend_point_count` **(** **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | +| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** const | +| :ref:`float` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -139,7 +139,7 @@ Adds a new point that represents a ``node`` on the virtual axis at a given posit .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count: -- :ref:`int` **get_blend_point_count** **(** **)** const +- :ref:`int` **get_blend_point_count** **(** **)** |const| Returns the number of points on the blend axis. @@ -147,7 +147,7 @@ Returns the number of points on the blend axis. .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node: -- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const +- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** |const| Returns the :ref:`AnimationNode` referenced by the point at index ``point``. @@ -155,7 +155,7 @@ Returns the :ref:`AnimationNode` referenced by the point at .. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position: -- :ref:`float` **get_blend_point_position** **(** :ref:`int` point **)** const +- :ref:`float` **get_blend_point_position** **(** :ref:`int` point **)** |const| Returns the position of the point at index ``point``. @@ -183,3 +183,6 @@ Changes the :ref:`AnimationNode` referenced by the point at Updates the position of the point at index ``point`` on the blend axis. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index df5a476a3..27c56981e 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -54,13 +54,13 @@ Methods +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_triangle` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` at_index=-1 **)** | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_point_count` **(** **)** const | +| :ref:`int` | :ref:`get_blend_point_count` **(** **)** |const| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | +| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** |const| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** const | +| :ref:`Vector2` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** |const| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_triangle_count` **(** **)** const | +| :ref:`int` | :ref:`get_triangle_count` **(** **)** |const| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_triangle_point` **(** :ref:`int` triangle, :ref:`int` point **)** | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -235,7 +235,7 @@ Creates a new triangle using three points ``x``, ``y``, and ``z``. Triangles can .. _class_AnimationNodeBlendSpace2D_method_get_blend_point_count: -- :ref:`int` **get_blend_point_count** **(** **)** const +- :ref:`int` **get_blend_point_count** **(** **)** |const| Returns the number of points in the blend space. @@ -243,7 +243,7 @@ Returns the number of points in the blend space. .. _class_AnimationNodeBlendSpace2D_method_get_blend_point_node: -- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const +- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** |const| Returns the :ref:`AnimationRootNode` referenced by the point at index ``point``. @@ -251,7 +251,7 @@ Returns the :ref:`AnimationRootNode` referenced by the .. _class_AnimationNodeBlendSpace2D_method_get_blend_point_position: -- :ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** const +- :ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** |const| Returns the position of the point at index ``point``. @@ -259,7 +259,7 @@ Returns the position of the point at index ``point``. .. _class_AnimationNodeBlendSpace2D_method_get_triangle_count: -- :ref:`int` **get_triangle_count** **(** **)** const +- :ref:`int` **get_triangle_count** **(** **)** |const| Returns the number of triangles in the blend space. @@ -303,3 +303,6 @@ Changes the :ref:`AnimationNode` referenced by the point at Updates the position of the point at index ``point`` on the blend axis. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 695862e1c..8edb6fd97 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -40,11 +40,11 @@ Methods +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_node` **(** :ref:`String` input_node, :ref:`int` input_index **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** |const| | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** |const| | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** |const| | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_node` **(** :ref:`String` name **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -126,7 +126,7 @@ Disconnects the node connected to the specified input. .. _class_AnimationNodeBlendTree_method_get_node: -- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const +- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** |const| Returns the sub-node with the specified ``name``. @@ -134,7 +134,7 @@ Returns the sub-node with the specified ``name``. .. _class_AnimationNodeBlendTree_method_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** |const| Returns the position of the sub-node with the specified ``name``. @@ -142,7 +142,7 @@ Returns the position of the sub-node with the specified ``name``. .. _class_AnimationNodeBlendTree_method_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` name **)** const +- :ref:`bool` **has_node** **(** :ref:`String` name **)** |const| Returns ``true`` if a sub-node with specified ``name`` exists. @@ -170,3 +170,6 @@ Changes the name of a sub-node. Modifies the position of a sub-node. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index be8bd9c05..b64304ac2 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -44,7 +44,7 @@ Methods ------- +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MixMode` | :ref:`get_mix_mode` **(** **)** const | +| :ref:`MixMode` | :ref:`get_mix_mode` **(** **)** |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_mix_mode` **(** :ref:`MixMode` mode **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ @@ -160,7 +160,7 @@ Method Descriptions .. _class_AnimationNodeOneShot_method_get_mix_mode: -- :ref:`MixMode` **get_mix_mode** **(** **)** const +- :ref:`MixMode` **get_mix_mode** **(** **)** |const| ---- @@ -168,3 +168,6 @@ Method Descriptions - void **set_mix_mode** **(** :ref:`MixMode` mode **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst index ab5c4937d..b4135fce8 100644 --- a/classes/class_animationnodeoutput.rst +++ b/classes/class_animationnodeoutput.rst @@ -18,3 +18,6 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index 2873a0142..dca1983d4 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -38,29 +38,29 @@ Methods +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_transition` **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_end_node` **(** **)** const | +| :ref:`String` | :ref:`get_end_node` **(** **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** const | +| :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** const | +| :ref:`String` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_start_node` **(** **)** const | +| :ref:`String` | :ref:`get_start_node` **(** **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** const | +| :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_transition_count` **(** **)** const | +| :ref:`int` | :ref:`get_transition_count` **(** **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_transition_from` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_transition_from` **(** :ref:`int` idx **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_transition_to` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_transition_to` **(** :ref:`int` idx **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_transition` **(** :ref:`String` from, :ref:`String` to **)** const | +| :ref:`bool` | :ref:`has_transition` **(** :ref:`String` from, :ref:`String` to **)** |const| | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_node` **(** :ref:`String` name **)** | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -102,7 +102,7 @@ Adds a transition between the given nodes. .. _class_AnimationNodeStateMachine_method_get_end_node: -- :ref:`String` **get_end_node** **(** **)** const +- :ref:`String` **get_end_node** **(** **)** |const| Returns the graph's end node. @@ -110,7 +110,7 @@ Returns the graph's end node. .. _class_AnimationNodeStateMachine_method_get_graph_offset: -- :ref:`Vector2` **get_graph_offset** **(** **)** const +- :ref:`Vector2` **get_graph_offset** **(** **)** |const| Returns the draw offset of the graph. Used for display in the editor. @@ -118,7 +118,7 @@ Returns the draw offset of the graph. Used for display in the editor. .. _class_AnimationNodeStateMachine_method_get_node: -- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const +- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** |const| Returns the animation node with the given name. @@ -126,7 +126,7 @@ Returns the animation node with the given name. .. _class_AnimationNodeStateMachine_method_get_node_name: -- :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const +- :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** |const| Returns the given animation node's name. @@ -134,7 +134,7 @@ Returns the given animation node's name. .. _class_AnimationNodeStateMachine_method_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** |const| Returns the given node's coordinates. Used for display in the editor. @@ -142,7 +142,7 @@ Returns the given node's coordinates. Used for display in the editor. .. _class_AnimationNodeStateMachine_method_get_start_node: -- :ref:`String` **get_start_node** **(** **)** const +- :ref:`String` **get_start_node** **(** **)** |const| Returns the graph's end node. @@ -150,7 +150,7 @@ Returns the graph's end node. .. _class_AnimationNodeStateMachine_method_get_transition: -- :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** const +- :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** |const| Returns the given transition. @@ -158,7 +158,7 @@ Returns the given transition. .. _class_AnimationNodeStateMachine_method_get_transition_count: -- :ref:`int` **get_transition_count** **(** **)** const +- :ref:`int` **get_transition_count** **(** **)** |const| Returns the number of connections in the graph. @@ -166,7 +166,7 @@ Returns the number of connections in the graph. .. _class_AnimationNodeStateMachine_method_get_transition_from: -- :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const +- :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** |const| Returns the given transition's start node. @@ -174,7 +174,7 @@ Returns the given transition's start node. .. _class_AnimationNodeStateMachine_method_get_transition_to: -- :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const +- :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** |const| Returns the given transition's end node. @@ -182,7 +182,7 @@ Returns the given transition's end node. .. _class_AnimationNodeStateMachine_method_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` name **)** const +- :ref:`bool` **has_node** **(** :ref:`String` name **)** |const| Returns ``true`` if the graph contains the given node. @@ -190,7 +190,7 @@ Returns ``true`` if the graph contains the given node. .. _class_AnimationNodeStateMachine_method_has_transition: -- :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const +- :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** |const| Returns ``true`` if there is a transition between the given nodes. @@ -266,3 +266,6 @@ Sets the node's coordinates. Used for display in the editor. Sets the given node as the graph start point. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 777088d08..60decaf41 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -41,11 +41,11 @@ Methods ------- +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_node` **(** **)** const | +| :ref:`String` | :ref:`get_current_node` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_travel_path` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_travel_path` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | +| :ref:`bool` | :ref:`is_playing` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`start` **(** :ref:`String` node **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ @@ -59,7 +59,7 @@ Method Descriptions .. _class_AnimationNodeStateMachinePlayback_method_get_current_node: -- :ref:`String` **get_current_node** **(** **)** const +- :ref:`String` **get_current_node** **(** **)** |const| Returns the currently playing animation state. @@ -67,7 +67,7 @@ Returns the currently playing animation state. .. _class_AnimationNodeStateMachinePlayback_method_get_travel_path: -- :ref:`PoolStringArray` **get_travel_path** **(** **)** const +- :ref:`PoolStringArray` **get_travel_path** **(** **)** |const| Returns the current travel path as computed internally by the A\* algorithm. @@ -75,7 +75,7 @@ Returns the current travel path as computed internally by the A\* algorithm. .. _class_AnimationNodeStateMachinePlayback_method_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** |const| Returns ``true`` if an animation is playing. @@ -103,3 +103,6 @@ Stops the currently playing animation. Transitions from the current state to another one, following the shortest path. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 5791103cf..096727e65 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -164,3 +164,6 @@ The transition type. The time to cross-fade between this state and the next. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst index a169254cb..660c17993 100644 --- a/classes/class_animationnodetimescale.rst +++ b/classes/class_animationnodetimescale.rst @@ -23,3 +23,6 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst index 94ed1abac..616ae0551 100644 --- a/classes/class_animationnodetimeseek.rst +++ b/classes/class_animationnodetimeseek.rst @@ -23,3 +23,6 @@ Tutorials - :doc:`../tutorials/animation/animation_tree` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index 4878bc86c..ed1ba133b 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -36,9 +36,9 @@ Methods ------- +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_input_caption` **(** :ref:`int` input **)** const | +| :ref:`String` | :ref:`get_input_caption` **(** :ref:`int` input **)** |const| | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_set_as_auto_advance` **(** :ref:`int` input **)** const | +| :ref:`bool` | :ref:`is_input_set_as_auto_advance` **(** :ref:`int` input **)** |const| | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_input_as_auto_advance` **(** :ref:`int` input, :ref:`bool` enable **)** | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -83,13 +83,13 @@ Method Descriptions .. _class_AnimationNodeTransition_method_get_input_caption: -- :ref:`String` **get_input_caption** **(** :ref:`int` input **)** const +- :ref:`String` **get_input_caption** **(** :ref:`int` input **)** |const| ---- .. _class_AnimationNodeTransition_method_is_input_set_as_auto_advance: -- :ref:`bool` **is_input_set_as_auto_advance** **(** :ref:`int` input **)** const +- :ref:`bool` **is_input_set_as_auto_advance** **(** :ref:`int` input **)** |const| ---- @@ -103,3 +103,6 @@ Method Descriptions - void **set_input_caption** **(** :ref:`int` input, :ref:`String` caption **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 1dda2ff9a..fb3e3b63a 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -27,6 +27,8 @@ Tutorials - :doc:`../getting_started/step_by_step/animations` +- :doc:`../tutorials/2d/2d_sprite_animation` + - :doc:`../tutorials/animation/index` Properties @@ -64,7 +66,7 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`advance` **(** :ref:`float` delta **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | +| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,21 +74,21 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_queue` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | +| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | +| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | +| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playing_speed` **(** **)** const | +| :ref:`float` | :ref:`get_playing_speed` **(** **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_queue` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | +| :ref:`bool` | :ref:`is_playing` **(** **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -216,7 +218,9 @@ The name of the animation to play when the scene loads. | *Getter* | get_current_animation() | +-----------+------------------------------+ -The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play`. +The name of the currently playing animation. If no animation is playing, the property's value is an empty string. Changing this value does not restart the animation. See :ref:`play` for more information on playing animations. + +**Note**: while this property appears in the inspector, it's not meant to be edited and it's not saved in the scene. This property is mainly used to get the currently playing animation, and internally for animation playback tracks. For more information, see :ref:`Animation`. ---- @@ -357,7 +361,7 @@ Shifts position in the animation timeline and immediately updates the animation. .. _class_AnimationPlayer_method_animation_get_next: -- :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const +- :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** |const| Returns the name of the next animation in the queue. @@ -389,7 +393,7 @@ Clears all queued, unplayed animations. .. _class_AnimationPlayer_method_find_animation: -- :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const +- :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** |const| Returns the name of ``animation`` or an empty string if not found. @@ -397,7 +401,7 @@ Returns the name of ``animation`` or an empty string if not found. .. _class_AnimationPlayer_method_get_animation: -- :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const +- :ref:`Animation` **get_animation** **(** :ref:`String` name **)** |const| Returns the :ref:`Animation` with key ``name`` or ``null`` if not found. @@ -405,7 +409,7 @@ Returns the :ref:`Animation` with key ``name`` or ``null`` if n .. _class_AnimationPlayer_method_get_animation_list: -- :ref:`PoolStringArray` **get_animation_list** **(** **)** const +- :ref:`PoolStringArray` **get_animation_list** **(** **)** |const| Returns the list of stored animation names. @@ -413,7 +417,7 @@ Returns the list of stored animation names. .. _class_AnimationPlayer_method_get_blend_time: -- :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const +- :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** |const| Gets the blend time (in seconds) between two animations, referenced by their names. @@ -421,7 +425,7 @@ Gets the blend time (in seconds) between two animations, referenced by their nam .. _class_AnimationPlayer_method_get_playing_speed: -- :ref:`float` **get_playing_speed** **(** **)** const +- :ref:`float` **get_playing_speed** **(** **)** |const| Gets the actual playing speed of current animation or 0 if not playing. This speed is the :ref:`playback_speed` property multiplied by ``custom_speed`` argument specified when calling the :ref:`play` method. @@ -437,7 +441,7 @@ Returns a list of the animation names that are currently queued to play. .. _class_AnimationPlayer_method_has_animation: -- :ref:`bool` **has_animation** **(** :ref:`String` name **)** const +- :ref:`bool` **has_animation** **(** :ref:`String` name **)** |const| Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation` with key ``name``. @@ -445,7 +449,7 @@ Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** |const| Returns ``true`` if playing an animation. @@ -523,3 +527,6 @@ Stops or pauses the currently playing animation. If ``reset`` is ``true``, the a If ``reset`` is ``false``, the :ref:`current_animation_position` will be kept and calling :ref:`play` or :ref:`play_backwards` without arguments or with the same animation name as :ref:`assigned_animation` will resume the animation. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index ece1f97a6..bdb39eb20 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -15,3 +15,6 @@ AnimationRootNode +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationtrackeditplugin.rst b/classes/class_animationtrackeditplugin.rst index aa91f849a..3c87d6138 100644 --- a/classes/class_animationtrackeditplugin.rst +++ b/classes/class_animationtrackeditplugin.rst @@ -13,3 +13,6 @@ AnimationTrackEditPlugin +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index de50ddf01..9bd115122 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -46,7 +46,7 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`advance` **(** :ref:`float` delta **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_root_motion_transform` **(** **)** const | +| :ref:`Transform` | :ref:`get_root_motion_transform` **(** **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rename_parameter` **(** :ref:`String` old_name, :ref:`String` new_name **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -164,7 +164,7 @@ Manually advance the animations by the specified time (in seconds). .. _class_AnimationTree_method_get_root_motion_transform: -- :ref:`Transform` **get_root_motion_transform** **(** **)** const +- :ref:`Transform` **get_root_motion_transform** **(** **)** |const| Retrieve the motion of the :ref:`root_motion_track` as a :ref:`Transform` that can be used elsewhere. If :ref:`root_motion_track` is not a path to a track of type :ref:`Animation.TYPE_TRANSFORM`, returns an identity transformation. @@ -174,3 +174,6 @@ Retrieve the motion of the :ref:`root_motion_track` old_name, :ref:`String` new_name **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index d3cb5497c..033d77c17 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -46,11 +46,11 @@ Methods +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`advance` **(** :ref:`float` delta **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`animation_node_get_animation` **(** :ref:`String` id **)** const | +| :ref:`Animation` | :ref:`animation_node_get_animation` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_node_get_master_animation` **(** :ref:`String` id **)** const | +| :ref:`String` | :ref:`animation_node_get_master_animation` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`animation_node_get_position` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`animation_node_get_position` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,19 +58,19 @@ Methods +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`animation_node_set_master_animation` **(** :ref:`String` id, :ref:`String` source **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_nodes_connected` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const | +| :ref:`bool` | :ref:`are_nodes_connected` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend2_node_get_amount` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`blend2_node_get_amount` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`blend2_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`blend2_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend3_node_get_amount` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`blend3_node_get_amount` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | +| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -80,35 +80,35 @@ Methods +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mix_node_set_amount` **(** :ref:`String` id, :ref:`float` ratio **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`node_exists` **(** :ref:`String` node **)** const | +| :ref:`bool` | :ref:`node_exists` **(** :ref:`String` node **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_get_input_count` **(** :ref:`String` id **)** const | +| :ref:`int` | :ref:`node_get_input_count` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** const | +| :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`node_get_position` **(** :ref:`String` id **)** const | +| :ref:`Vector2` | :ref:`node_get_position` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodeType` | :ref:`node_get_type` **(** :ref:`String` id **)** const | +| :ref:`NodeType` | :ref:`node_get_type` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`node_rename` **(** :ref:`String` node, :ref:`String` new_name **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`node_set_position` **(** :ref:`String` id, :ref:`Vector2` screen_position **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_random_delay` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`oneshot_node_get_autorestart_random_delay` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadein_time` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`oneshot_node_get_fadein_time` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadeout_time` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`oneshot_node_get_fadeout_time` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_has_autorestart` **(** :ref:`String` id **)** const | +| :ref:`bool` | :ref:`oneshot_node_has_autorestart` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_is_active` **(** :ref:`String` id **)** const | +| :ref:`bool` | :ref:`oneshot_node_is_active` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`oneshot_node_set_autorestart` **(** :ref:`String` id, :ref:`bool` enable **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -132,7 +132,7 @@ Methods +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reset` **(** **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -140,13 +140,13 @@ Methods +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`transition_node_delete_input` **(** :ref:`String` id, :ref:`int` input_idx **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_current` **(** :ref:`String` id **)** const | +| :ref:`int` | :ref:`transition_node_get_current` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_input_count` **(** :ref:`String` id **)** const | +| :ref:`int` | :ref:`transition_node_get_input_count` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`transition_node_get_xfade_time` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`transition_node_get_xfade_time` **(** :ref:`String` id **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`transition_node_has_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx **)** const | +| :ref:`bool` | :ref:`transition_node_has_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx **)** |const| | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -308,7 +308,7 @@ Shifts position in the animation timeline. ``delta`` is the time in seconds to s .. _class_AnimationTreePlayer_method_animation_node_get_animation: -- :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** const +- :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** |const| Returns the :ref:`AnimationPlayer`'s :ref:`Animation` bound to the ``AnimationTreePlayer``'s animation node with name ``id``. @@ -316,7 +316,7 @@ Returns the :ref:`AnimationPlayer`'s :ref:`Animation` **animation_node_get_master_animation** **(** :ref:`String` id **)** const +- :ref:`String` **animation_node_get_master_animation** **(** :ref:`String` id **)** |const| Returns the name of the :ref:`master_player`'s :ref:`Animation` bound to this animation node. @@ -324,7 +324,7 @@ Returns the name of the :ref:`master_player` **animation_node_get_position** **(** :ref:`String` id **)** const +- :ref:`float` **animation_node_get_position** **(** :ref:`String` id **)** |const| Returns the absolute playback timestamp of the animation node with name ``id``. @@ -356,7 +356,7 @@ Binds the :ref:`Animation` named ``source`` from :ref:`master_p .. _class_AnimationTreePlayer_method_are_nodes_connected: -- :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const +- :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** |const| Returns whether node ``id`` and ``dst_id`` are connected at the specified slot. @@ -364,7 +364,7 @@ Returns whether node ``id`` and ``dst_id`` are connected at the specified slot. .. _class_AnimationTreePlayer_method_blend2_node_get_amount: -- :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** |const| Returns the blend amount of a Blend2 node given its name. @@ -392,7 +392,7 @@ If ``enable`` is ``true``, the Blend2 node with name ``id`` turns off the track .. _class_AnimationTreePlayer_method_blend3_node_get_amount: -- :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** |const| Returns the blend amount of a Blend3 node given its name. @@ -412,7 +412,7 @@ At -1, output is input B-. From -1 to 0, the influence of B- gets lessened, the .. _class_AnimationTreePlayer_method_blend4_node_get_amount: -- :ref:`Vector2` **blend4_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`Vector2` **blend4_node_get_amount** **(** :ref:`String` id **)** |const| Returns the blend amount of a Blend4 node given its name. @@ -456,7 +456,7 @@ Returns a :ref:`PoolStringArray` containing the name of a .. _class_AnimationTreePlayer_method_mix_node_get_amount: -- :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** |const| Returns the mix amount of a Mix node given its name. @@ -474,7 +474,7 @@ A Mix node adds input b to input a by the amount given by ratio. .. _class_AnimationTreePlayer_method_node_exists: -- :ref:`bool` **node_exists** **(** :ref:`String` node **)** const +- :ref:`bool` **node_exists** **(** :ref:`String` node **)** |const| Check if a node exists (by name). @@ -482,7 +482,7 @@ Check if a node exists (by name). .. _class_AnimationTreePlayer_method_node_get_input_count: -- :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** const +- :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** |const| Returns the input count for a given node. Different types of nodes have different amount of inputs. @@ -490,7 +490,7 @@ Returns the input count for a given node. Different types of nodes have differen .. _class_AnimationTreePlayer_method_node_get_input_source: -- :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** const +- :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** |const| Returns the input source for a given node input. @@ -498,7 +498,7 @@ Returns the input source for a given node input. .. _class_AnimationTreePlayer_method_node_get_position: -- :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** const +- :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** |const| Returns position of a node in the graph given its name. @@ -506,7 +506,7 @@ Returns position of a node in the graph given its name. .. _class_AnimationTreePlayer_method_node_get_type: -- :ref:`NodeType` **node_get_type** **(** :ref:`String` id **)** const +- :ref:`NodeType` **node_get_type** **(** :ref:`String` id **)** |const| Gets the node type, will return from :ref:`NodeType` enum. @@ -530,7 +530,7 @@ Sets the position of a node in the graph given its name and position. .. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay: -- :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** |const| Returns the autostart delay of a OneShot node given its name. @@ -538,7 +538,7 @@ Returns the autostart delay of a OneShot node given its name. .. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay: -- :ref:`float` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String` id **)** |const| Returns the autostart random delay of a OneShot node given its name. @@ -546,7 +546,7 @@ Returns the autostart random delay of a OneShot node given its name. .. _class_AnimationTreePlayer_method_oneshot_node_get_fadein_time: -- :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** |const| Returns the fade in time of a OneShot node given its name. @@ -554,7 +554,7 @@ Returns the fade in time of a OneShot node given its name. .. _class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time: -- :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** |const| Returns the fade out time of a OneShot node given its name. @@ -562,7 +562,7 @@ Returns the fade out time of a OneShot node given its name. .. _class_AnimationTreePlayer_method_oneshot_node_has_autorestart: -- :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** const +- :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** |const| Returns whether a OneShot node will auto restart given its name. @@ -570,7 +570,7 @@ Returns whether a OneShot node will auto restart given its name. .. _class_AnimationTreePlayer_method_oneshot_node_is_active: -- :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** const +- :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** |const| Returns whether a OneShot node is active given its name. @@ -666,7 +666,7 @@ Resets this ``AnimationTreePlayer``. .. _class_AnimationTreePlayer_method_timescale_node_get_scale: -- :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const +- :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** |const| Returns the time scale value of the TimeScale node with name ``id``. @@ -704,7 +704,7 @@ Deletes the input at ``input_idx`` for the transition node with name ``id``. .. _class_AnimationTreePlayer_method_transition_node_get_current: -- :ref:`int` **transition_node_get_current** **(** :ref:`String` id **)** const +- :ref:`int` **transition_node_get_current** **(** :ref:`String` id **)** |const| Returns the index of the currently evaluated input for the transition node with name ``id``. @@ -712,7 +712,7 @@ Returns the index of the currently evaluated input for the transition node with .. _class_AnimationTreePlayer_method_transition_node_get_input_count: -- :ref:`int` **transition_node_get_input_count** **(** :ref:`String` id **)** const +- :ref:`int` **transition_node_get_input_count** **(** :ref:`String` id **)** |const| Returns the number of inputs for the transition node with name ``id``. You can add inputs by right-clicking on the transition node. @@ -720,7 +720,7 @@ Returns the number of inputs for the transition node with name ``id``. You can a .. _class_AnimationTreePlayer_method_transition_node_get_xfade_time: -- :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** const +- :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** |const| Returns the cross fade time for the transition node with name ``id``. @@ -728,7 +728,7 @@ Returns the cross fade time for the transition node with name ``id``. .. _class_AnimationTreePlayer_method_transition_node_has_input_auto_advance: -- :ref:`bool` **transition_node_has_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx **)** const +- :ref:`bool` **transition_node_has_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx **)** |const| Returns ``true`` if the input at ``input_idx`` on the transition node with name ``id`` is set to automatically advance to the next input upon completion. @@ -764,3 +764,6 @@ Resizes the number of inputs available for the transition node with name ``id``. The transition node with name ``id`` sets its cross fade time to ``time_sec``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_area.rst b/classes/class_area.rst index 381d5dd05..883f82e80 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -63,17 +63,17 @@ Methods ------- +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_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_areas` **(** **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -243,7 +243,7 @@ If ``true``, the area's audio bus overrides the default audio bus. | *Getter* | get_collision_layer() | +-----------+----------------------------+ -The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask`. +The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask`. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -259,7 +259,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The physics layers this area scans to determine collision detection. +The physics layers this area scans to determine collision detection. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -474,7 +474,7 @@ Method Descriptions .. _class_Area_method_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the layer mask. @@ -482,7 +482,7 @@ Returns an individual bit on the layer mask. .. _class_Area_method_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the collision mask. @@ -490,7 +490,7 @@ Returns an individual bit on the collision mask. .. _class_Area_method_get_overlapping_areas: -- :ref:`Array` **get_overlapping_areas** **(** **)** const +- :ref:`Array` **get_overlapping_areas** **(** **)** |const| Returns a list of intersecting ``Area``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. @@ -498,7 +498,7 @@ Returns a list of intersecting ``Area``\ s. For performance reasons (collisions .. _class_Area_method_get_overlapping_bodies: -- :ref:`Array` **get_overlapping_bodies** **(** **)** const +- :ref:`Array` **get_overlapping_bodies** **(** **)** |const| Returns a list of intersecting :ref:`PhysicsBody`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. @@ -506,7 +506,7 @@ Returns a list of intersecting :ref:`PhysicsBody`\ s. For per .. _class_Area_method_overlaps_area: -- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const +- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** |const| If ``true``, the given area overlaps the Area. @@ -516,7 +516,7 @@ If ``true``, the given area overlaps the Area. .. _class_Area_method_overlaps_body: -- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const +- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** |const| If ``true``, the given physics body overlaps the Area. @@ -540,3 +540,6 @@ Set/clear individual bits on the layer mask. This simplifies editing this ``Area Set/clear individual bits on the collision mask. This simplifies editing which ``Area`` layers this ``Area`` scans. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 1d128a047..b0f0ee70e 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -60,17 +60,17 @@ Methods ------- +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_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_areas` **(** **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -240,7 +240,7 @@ If ``true``, the area's audio bus overrides the default audio bus. | *Getter* | get_collision_layer() | +-----------+----------------------------+ -The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask`. +The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask`. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -256,7 +256,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The physics layers this area scans to determine collision detection. +The physics layers this area scans to determine collision detection. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -407,7 +407,7 @@ Method Descriptions .. _class_Area2D_method_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. @@ -415,7 +415,7 @@ Returns an individual bit on the layer mask. Describes whether other areas will .. _class_Area2D_method_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. @@ -423,7 +423,7 @@ Returns an individual bit on the collision mask. Describes whether this area wil .. _class_Area2D_method_get_overlapping_areas: -- :ref:`Array` **get_overlapping_areas** **(** **)** const +- :ref:`Array` **get_overlapping_areas** **(** **)** |const| Returns a list of intersecting ``Area2D``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. @@ -431,7 +431,7 @@ Returns a list of intersecting ``Area2D``\ s. For performance reasons (collision .. _class_Area2D_method_get_overlapping_bodies: -- :ref:`Array` **get_overlapping_bodies** **(** **)** const +- :ref:`Array` **get_overlapping_bodies** **(** **)** |const| Returns a list of intersecting :ref:`PhysicsBody2D`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. @@ -439,7 +439,7 @@ Returns a list of intersecting :ref:`PhysicsBody2D`\ s. For .. _class_Area2D_method_overlaps_area: -- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const +- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** |const| If ``true``, the given area overlaps the Area2D. @@ -449,7 +449,7 @@ If ``true``, the given area overlaps the Area2D. .. _class_Area2D_method_overlaps_body: -- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const +- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** |const| If ``true``, the given physics body overlaps the Area2D. @@ -473,3 +473,6 @@ Set/clear individual bits on the layer mask. This makes getting an area in/out o Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_array.rst b/classes/class_array.rst index 29a6d3e40..5c882b398 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -175,7 +175,9 @@ Appends an element at the end of the array (alias of :ref:`push_back` **back** **(** **)** -Returns the last element of the array, or ``null`` if the array is empty. +Returns the last element of the array. Prints an error and returns ``null`` if the array is empty. + +**Note:** Calling this function is not the same as writing ``array[-1]``. If the array is empty, accessing by index will pause project execution when running from the editor. ---- @@ -261,7 +263,9 @@ Searches the array in reverse order for a value and returns its index or ``-1`` - :ref:`Variant` **front** **(** **)** -Returns the first element of the array, or ``null`` if the array is empty. +Returns the first element of the array. Prints an error and returns ``null`` if the array is empty. + +**Note:** Calling this function is not the same as writing ``array[0]``. If the array is empty, accessing by index will pause project execution when running from the editor. ---- @@ -332,7 +336,7 @@ Returns the minimum value contained in the array if all elements are of comparab - :ref:`Variant` **pop_back** **(** **)** -Removes and returns the last element of the array. Returns ``null`` if the array is empty. +Removes and returns the last element of the array. Returns ``null`` if the array is empty, without printing an error message. ---- @@ -340,7 +344,7 @@ Removes and returns the last element of the array. Returns ``null`` if the array - :ref:`Variant` **pop_front** **(** **)** -Removes and returns the first element of the array. Returns ``null`` if the array is empty. +Removes and returns the first element of the array. Returns ``null`` if the array is empty, wwithout printing an error message. ---- @@ -364,7 +368,7 @@ Adds an element at the beginning of the array. - void **remove** **(** :ref:`int` position **)** -Removes an element from the array by index. +Removes an element from the array by index. If the index does not exist in the array, nothing happens. ---- @@ -444,3 +448,6 @@ Sorts the array using a custom method. The arguments are an object that holds th my_items.sort_custom(MyCustomSorter, "sort_ascending") print(my_items) # Prints [[4, Tomato], [5, Potato], [9, Rice]]. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index e3954b18c..202aeb356 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -66,25 +66,25 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_blend_shapes` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | +| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform` transform, :ref:`float` texel_size **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`regen_normalmaps` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | +| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | +| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | +| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PrimitiveType` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | +| :ref:`PrimitiveType` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -263,7 +263,7 @@ Removes all blend shapes from this ``ArrayMesh``. .. _class_ArrayMesh_method_get_blend_shape_count: -- :ref:`int` **get_blend_shape_count** **(** **)** const +- :ref:`int` **get_blend_shape_count** **(** **)** |const| Returns the number of blend shapes that the ``ArrayMesh`` holds. @@ -271,7 +271,7 @@ Returns the number of blend shapes that the ``ArrayMesh`` holds. .. _class_ArrayMesh_method_get_blend_shape_name: -- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const +- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** |const| Returns the name of the blend shape at this index. @@ -295,7 +295,7 @@ Will regenerate normal maps for the ``ArrayMesh``. .. _class_ArrayMesh_method_surface_find_by_name: -- :ref:`int` **surface_find_by_name** **(** :ref:`String` name **)** const +- :ref:`int` **surface_find_by_name** **(** :ref:`String` name **)** |const| Returns the index of the first surface with this name held within this ``ArrayMesh``. If none are found, -1 is returned. @@ -303,7 +303,7 @@ Returns the index of the first surface with this name held within this ``ArrayMe .. _class_ArrayMesh_method_surface_get_array_index_len: -- :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const +- :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** |const| Returns the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays`). @@ -311,7 +311,7 @@ Returns the length in indices of the index array in the requested surface (see : .. _class_ArrayMesh_method_surface_get_array_len: -- :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const +- :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** |const| Returns the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). @@ -319,7 +319,7 @@ Returns the length in vertices of the vertex array in the requested surface (see .. _class_ArrayMesh_method_surface_get_format: -- :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const +- :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** |const| Returns the format mask of the requested surface (see :ref:`add_surface_from_arrays`). @@ -327,7 +327,7 @@ Returns the format mask of the requested surface (see :ref:`add_surface_from_arr .. _class_ArrayMesh_method_surface_get_name: -- :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const +- :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** |const| Gets the name assigned to this surface. @@ -335,7 +335,7 @@ Gets the name assigned to this surface. .. _class_ArrayMesh_method_surface_get_primitive_type: -- :ref:`PrimitiveType` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const +- :ref:`PrimitiveType` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** |const| Returns the primitive type of the requested surface (see :ref:`add_surface_from_arrays`). @@ -365,3 +365,6 @@ Updates a specified region of mesh arrays on the GPU. **Warning:** Only use if you know what you are doing. You can easily cause crashes by calling this function with improper arguments. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index c956e708f..ac2ab51f5 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -32,17 +32,17 @@ Properties Methods ------- -+-------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_active` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_plane` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_anchor_name` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_active` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_mesh` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`get_plane` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------+ Signals ------- @@ -75,7 +75,7 @@ Method Descriptions .. _class_ARVRAnchor_method_get_anchor_name: -- :ref:`String` **get_anchor_name** **(** **)** const +- :ref:`String` **get_anchor_name** **(** **)** |const| Returns the name given to this anchor. @@ -83,7 +83,7 @@ Returns the name given to this anchor. .. _class_ARVRAnchor_method_get_is_active: -- :ref:`bool` **get_is_active** **(** **)** const +- :ref:`bool` **get_is_active** **(** **)** |const| Returns ``true`` if the anchor is being tracked and ``false`` if no anchor with this ID is currently known. @@ -91,7 +91,7 @@ Returns ``true`` if the anchor is being tracked and ``false`` if no anchor with .. _class_ARVRAnchor_method_get_mesh: -- :ref:`Mesh` **get_mesh** **(** **)** const +- :ref:`Mesh` **get_mesh** **(** **)** |const| If provided by the :ref:`ARVRInterface`, this returns a mesh object for the anchor. For an anchor, this can be a shape related to the object being tracked or it can be a mesh that provides topology related to the anchor and can be used to create shadows/reflections on surfaces or for generating collision shapes. @@ -99,7 +99,7 @@ If provided by the :ref:`ARVRInterface`, this returns a mes .. _class_ARVRAnchor_method_get_plane: -- :ref:`Plane` **get_plane** **(** **)** const +- :ref:`Plane` **get_plane** **(** **)** |const| Returns a plane aligned with our anchor; handy for intersection testing. @@ -107,7 +107,10 @@ Returns a plane aligned with our anchor; handy for intersection testing. .. _class_ARVRAnchor_method_get_size: -- :ref:`Vector3` **get_size** **(** **)** const +- :ref:`Vector3` **get_size** **(** **)** |const| 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. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_arvrcamera.rst b/classes/class_arvrcamera.rst index af9cef27b..ab49969dd 100644 --- a/classes/class_arvrcamera.rst +++ b/classes/class_arvrcamera.rst @@ -25,3 +25,6 @@ Tutorials - :doc:`../tutorials/vr/index` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 02526a4a1..08cee547f 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -39,21 +39,21 @@ Properties Methods ------- -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_controller_name` **(** **)** const | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerHand` | :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:`Mesh` | :ref:`get_mesh` **(** **)** const | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_controller_name` **(** **)** |const| | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TrackerHand` | :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:`Mesh` | :ref:`get_mesh` **(** **)** |const| | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** |const| | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -126,7 +126,7 @@ Method Descriptions .. _class_ARVRController_method_get_controller_name: -- :ref:`String` **get_controller_name** **(** **)** const +- :ref:`String` **get_controller_name** **(** **)** |const| If active, returns the name of the associated controller if provided by the AR/VR SDK used. @@ -134,7 +134,7 @@ If active, returns the name of the associated controller if provided by the AR/V .. _class_ARVRController_method_get_hand: -- :ref:`TrackerHand` **get_hand** **(** **)** const +- :ref:`TrackerHand` **get_hand** **(** **)** |const| Returns the hand holding this controller, if known. See :ref:`TrackerHand`. @@ -142,7 +142,7 @@ Returns the hand holding this controller, if known. See :ref:`TrackerHand` **get_is_active** **(** **)** const +- :ref:`bool` **get_is_active** **(** **)** |const| Returns ``true`` if the bound controller is active. ARVR systems attempt to track active controllers. @@ -150,7 +150,7 @@ Returns ``true`` if the bound controller is active. ARVR systems attempt to trac .. _class_ARVRController_method_get_joystick_axis: -- :ref:`float` **get_joystick_axis** **(** :ref:`int` axis **)** const +- :ref:`float` **get_joystick_axis** **(** :ref:`int` axis **)** |const| Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller. @@ -158,7 +158,7 @@ Returns the value of the given axis for things like triggers, touchpads, etc. th .. _class_ARVRController_method_get_joystick_id: -- :ref:`int` **get_joystick_id** **(** **)** const +- :ref:`int` **get_joystick_id** **(** **)** |const| Returns the ID of the joystick object bound to this. Every controller tracked by the :ref:`ARVRServer` 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. @@ -166,7 +166,7 @@ Returns the ID of the joystick object bound to this. Every controller tracked by .. _class_ARVRController_method_get_mesh: -- :ref:`Mesh` **get_mesh** **(** **)** const +- :ref:`Mesh` **get_mesh** **(** **)** |const| If provided by the :ref:`ARVRInterface`, this returns a mesh associated with the controller. This can be used to visualize the controller. @@ -174,7 +174,10 @@ If provided by the :ref:`ARVRInterface`, this returns a mes .. _class_ARVRController_method_is_button_pressed: -- :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const +- :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** |const| Returns ``true`` if the button at index ``button`` is pressed. See :ref:`JoystickList`, in particular the ``JOY_VR_*`` constants. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 50b546c27..eba45143b 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -41,23 +41,23 @@ Properties Methods ------- -+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_camera_feed_id` **(** **)** | -+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_capabilities` **(** **)** const | -+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_render_targetsize` **(** **)** | -+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Tracking_status` | :ref:`get_tracking_status` **(** **)** const | -+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`initialize` **(** **)** | -+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stereo` **(** **)** | -+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`uninitialize` **(** **)** | -+------------------------------------------------------------+----------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_camera_feed_id` **(** **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_capabilities` **(** **)** |const| | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** |const| | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_render_targetsize` **(** **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`Tracking_status` | :ref:`get_tracking_status` **(** **)** |const| | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stereo` **(** **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`uninitialize` **(** **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -192,7 +192,7 @@ If this is an AR interface that requires displaying a camera feed as the backgro .. _class_ARVRInterface_method_get_capabilities: -- :ref:`int` **get_capabilities** **(** **)** const +- :ref:`int` **get_capabilities** **(** **)** |const| Returns a combination of :ref:`Capabilities` flags providing information about the capabilities of this interface. @@ -200,7 +200,7 @@ Returns a combination of :ref:`Capabilities` fl .. _class_ARVRInterface_method_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** |const| Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). @@ -216,7 +216,7 @@ Returns the resolution at which we should render our intermediate results before .. _class_ARVRInterface_method_get_tracking_status: -- :ref:`Tracking_status` **get_tracking_status** **(** **)** const +- :ref:`Tracking_status` **get_tracking_status** **(** **)** |const| If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking. @@ -252,3 +252,6 @@ Returns ``true`` if the current output of this interface is in stereo. Turns the interface off. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_arvrinterfacegdnative.rst b/classes/class_arvrinterfacegdnative.rst index 9a58256b2..55ec47d92 100644 --- a/classes/class_arvrinterfacegdnative.rst +++ b/classes/class_arvrinterfacegdnative.rst @@ -18,3 +18,6 @@ Description This is a wrapper class for GDNative implementations of the ARVR interface. To use a GDNative ARVR interface, simply instantiate this object and set your GDNative library containing the ARVR interface implementation. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index ff6dc23d1..87211e7ac 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -55,3 +55,6 @@ Allows you to adjust the scale to your game's units. Most AR/VR platforms assume **Note:** This method is a passthrough to the :ref:`ARVRServer` itself. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index b8dfb2434..cf3a1dc9b 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -37,29 +37,29 @@ Properties Methods ------- -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerHand` | :ref:`get_hand` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_id` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`get_orientation` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_position` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tracker_id` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tracks_orientation` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tracks_position` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** :ref:`bool` adjust_by_reference_frame **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerType` | :ref:`get_type` **(** **)** const | -+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TrackerHand` | :ref:`get_hand` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_id` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_mesh` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`get_orientation` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_position` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tracker_id` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tracks_orientation` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tracks_position` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform` **(** :ref:`bool` adjust_by_reference_frame **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TrackerType` | :ref:`get_type` **(** **)** |const| | ++------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -102,7 +102,7 @@ Method Descriptions .. _class_ARVRPositionalTracker_method_get_hand: -- :ref:`TrackerHand` **get_hand** **(** **)** const +- :ref:`TrackerHand` **get_hand** **(** **)** |const| Returns the hand holding this tracker, if known. See :ref:`TrackerHand` constants. @@ -110,7 +110,7 @@ Returns the hand holding this tracker, if known. See :ref:`TrackerHand` **get_joy_id** **(** **)** const +- :ref:`int` **get_joy_id** **(** **)** |const| If this is a controller that is being tracked, the controller will also be represented by a joystick entry with this ID. @@ -118,7 +118,7 @@ If this is a controller that is being tracked, the controller will also be repre .. _class_ARVRPositionalTracker_method_get_mesh: -- :ref:`Mesh` **get_mesh** **(** **)** const +- :ref:`Mesh` **get_mesh** **(** **)** |const| Returns the mesh related to a controller or anchor point if one is available. @@ -126,7 +126,7 @@ Returns the mesh related to a controller or anchor point if one is available. .. _class_ARVRPositionalTracker_method_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** |const| Returns the controller or anchor point's name if available. @@ -134,7 +134,7 @@ Returns the controller or anchor point's name if available. .. _class_ARVRPositionalTracker_method_get_orientation: -- :ref:`Basis` **get_orientation** **(** **)** const +- :ref:`Basis` **get_orientation** **(** **)** |const| Returns the controller's orientation matrix. @@ -142,7 +142,7 @@ Returns the controller's orientation matrix. .. _class_ARVRPositionalTracker_method_get_position: -- :ref:`Vector3` **get_position** **(** **)** const +- :ref:`Vector3` **get_position** **(** **)** |const| Returns the world-space controller position. @@ -150,7 +150,7 @@ Returns the world-space controller position. .. _class_ARVRPositionalTracker_method_get_tracker_id: -- :ref:`int` **get_tracker_id** **(** **)** const +- :ref:`int` **get_tracker_id** **(** **)** |const| Returns the internal tracker ID. This uniquely identifies the tracker per tracker type and matches the ID you need to specify for nodes such as the :ref:`ARVRController` and :ref:`ARVRAnchor` nodes. @@ -158,7 +158,7 @@ Returns the internal tracker ID. This uniquely identifies the tracker per tracke .. _class_ARVRPositionalTracker_method_get_tracks_orientation: -- :ref:`bool` **get_tracks_orientation** **(** **)** const +- :ref:`bool` **get_tracks_orientation** **(** **)** |const| Returns ``true`` if this device tracks orientation. @@ -166,7 +166,7 @@ Returns ``true`` if this device tracks orientation. .. _class_ARVRPositionalTracker_method_get_tracks_position: -- :ref:`bool` **get_tracks_position** **(** **)** const +- :ref:`bool` **get_tracks_position** **(** **)** |const| Returns ``true`` if this device tracks position. @@ -174,7 +174,7 @@ Returns ``true`` if this device tracks position. .. _class_ARVRPositionalTracker_method_get_transform: -- :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const +- :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** |const| Returns the transform combining this device's orientation and position. @@ -182,7 +182,10 @@ Returns the transform combining this device's orientation and position. .. _class_ARVRPositionalTracker_method_get_type: -- :ref:`TrackerType` **get_type** **(** **)** const +- :ref:`TrackerType` **get_type** **(** **)** |const| Returns the tracker's type. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index eb937d617..9b709b427 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -38,15 +38,15 @@ Methods +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`center_on_hmd` **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRInterface` | :ref:`find_interface` **(** :ref:`String` name **)** const | +| :ref:`ARVRInterface` | :ref:`find_interface` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`get_hmd_transform` **(** **)** | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRInterface` | :ref:`get_interface` **(** :ref:`int` idx **)** const | +| :ref:`ARVRInterface` | :ref:`get_interface` **(** :ref:`int` idx **)** |const| | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_interface_count` **(** **)** const | +| :ref:`int` | :ref:`get_interface_count` **(** **)** |const| | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_interfaces` **(** **)** const | +| :ref:`Array` | :ref:`get_interfaces` **(** **)** |const| | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_last_commit_usec` **(** **)** | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,11 +54,11 @@ Methods +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_last_process_usec` **(** **)** | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_reference_frame` **(** **)** const | +| :ref:`Transform` | :ref:`get_reference_frame` **(** **)** |const| | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** const | +| :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** |const| | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tracker_count` **(** **)** const | +| :ref:`int` | :ref:`get_tracker_count` **(** **)** |const| | +-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -197,7 +197,7 @@ You should call this method after a few seconds have passed. For instance, when .. _class_ARVRServer_method_find_interface: -- :ref:`ARVRInterface` **find_interface** **(** :ref:`String` name **)** const +- :ref:`ARVRInterface` **find_interface** **(** :ref:`String` name **)** |const| Finds an interface by its name. For instance, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it. @@ -213,7 +213,7 @@ Returns the primary interface's transformation. .. _class_ARVRServer_method_get_interface: -- :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** const +- :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** |const| Returns the interface registered at a given index in our list of interfaces. @@ -221,7 +221,7 @@ Returns the interface registered at a given index in our list of interfaces. .. _class_ARVRServer_method_get_interface_count: -- :ref:`int` **get_interface_count** **(** **)** const +- :ref:`int` **get_interface_count** **(** **)** |const| Returns the number of interfaces currently registered with the AR/VR server. If your project supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try to initialize each interface and use the first one that returns ``true``. @@ -229,7 +229,7 @@ Returns the number of interfaces currently registered with the AR/VR server. If .. _class_ARVRServer_method_get_interfaces: -- :ref:`Array` **get_interfaces** **(** **)** const +- :ref:`Array` **get_interfaces** **(** **)** |const| Returns a list of available interfaces the ID and name of each interface. @@ -261,7 +261,7 @@ Returns the absolute timestamp (in μs) of the last ``ARVRServer`` process callb .. _class_ARVRServer_method_get_reference_frame: -- :ref:`Transform` **get_reference_frame** **(** **)** const +- :ref:`Transform` **get_reference_frame** **(** **)** |const| Returns the reference frame transform. Mostly used internally and exposed for GDNative build interfaces. @@ -269,7 +269,7 @@ Returns the reference frame transform. Mostly used internally and exposed for GD .. _class_ARVRServer_method_get_tracker: -- :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const +- :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** |const| Returns the positional tracker at the given ID. @@ -277,7 +277,10 @@ Returns the positional tracker at the given ID. .. _class_ARVRServer_method_get_tracker_count: -- :ref:`int` **get_tracker_count** **(** **)** const +- :ref:`int` **get_tracker_count** **(** **)** |const| Returns the number of trackers currently registered. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 5da07bde3..70253903e 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -38,64 +38,64 @@ It is also possible to use non-Euclidean distances. To do so, create a class tha Methods ------- -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position, :ref:`bool` include_disabled=false **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_capacity` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_points` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector3` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position, :ref:`bool` include_disabled=false **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_capacity` **(** **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_points` **(** **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector3` position **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_AStar_method__compute_cost: -- :ref:`float` **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual +- :ref:`float` **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| Called when computing the cost between two connected points. @@ -105,7 +105,7 @@ Note that this function is hidden in the default ``AStar`` class. .. _class_AStar_method__estimate_cost: -- :ref:`float` **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual +- :ref:`float` **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| Called when estimating the cost between a point and the path's ending point. @@ -130,7 +130,7 @@ If there already exists a point for the given ``id``, its position and weight sc .. _class_AStar_method_are_points_connected: -- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** const +- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** |const| Returns whether the two given points are directly connected by a segment. If ``bidirectional`` is ``false``, returns whether movement from ``id`` to ``to_id`` is possible through this segment. @@ -169,7 +169,7 @@ Deletes the segment between the given points. If ``bidirectional`` is ``false``, .. _class_AStar_method_get_available_point_id: -- :ref:`int` **get_available_point_id** **(** **)** const +- :ref:`int` **get_available_point_id** **(** **)** |const| Returns the next available point ID with no point associated to it. @@ -177,7 +177,7 @@ Returns the next available point ID with no point associated to it. .. _class_AStar_method_get_closest_point: -- :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_position, :ref:`bool` include_disabled=false **)** const +- :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_position, :ref:`bool` include_disabled=false **)** |const| Returns the ID of the closest point to ``to_position``, optionally taking disabled points into account. Returns ``-1`` if there are no points in the points pool. @@ -187,7 +187,7 @@ Returns the ID of the closest point to ``to_position``, optionally taking disabl .. _class_AStar_method_get_closest_position_in_segment: -- :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const +- :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** |const| Returns the closest position to ``to_position`` that resides inside a segment between two connected points. @@ -230,7 +230,7 @@ If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` .. _class_AStar_method_get_point_capacity: -- :ref:`int` **get_point_capacity** **(** **)** const +- :ref:`int` **get_point_capacity** **(** **)** |const| Returns the capacity of the structure backing the points, useful in conjunction with ``reserve_space``. @@ -259,7 +259,7 @@ Returns an array with the IDs of the points that form the connection with the gi .. _class_AStar_method_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** |const| Returns the number of points currently in the points pool. @@ -275,7 +275,7 @@ Returns an array with the points that are in the path found by AStar between the .. _class_AStar_method_get_point_position: -- :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** const +- :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** |const| Returns the position of the point associated with the given ``id``. @@ -283,7 +283,7 @@ Returns the position of the point associated with the given ``id``. .. _class_AStar_method_get_point_weight_scale: -- :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const +- :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** |const| Returns the weight scale of the point associated with the given ``id``. @@ -299,7 +299,7 @@ Returns an array of all points. .. _class_AStar_method_has_point: -- :ref:`bool` **has_point** **(** :ref:`int` id **)** const +- :ref:`bool` **has_point** **(** :ref:`int` id **)** |const| Returns whether a point associated with the given ``id`` exists. @@ -307,7 +307,7 @@ Returns whether a point associated with the given ``id`` exists. .. _class_AStar_method_is_point_disabled: -- :ref:`bool` **is_point_disabled** **(** :ref:`int` id **)** const +- :ref:`bool` **is_point_disabled** **(** :ref:`int` id **)** |const| Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. @@ -351,3 +351,6 @@ Sets the ``position`` for the point with the given ``id``. Sets the ``weight_scale`` for the point with the given ``id``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index 4baa654eb..d273cf769 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -21,64 +21,64 @@ This is a wrapper for the :ref:`AStar` class which uses 2D vectors Methods ------- -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector2` to_position **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_capacity` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_points` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector2` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector2` to_position **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_capacity` **(** **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_points` **(** **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** |const| | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector2` position **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_AStar2D_method__compute_cost: -- :ref:`float` **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual +- :ref:`float` **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| Called when computing the cost between two connected points. @@ -88,7 +88,7 @@ Note that this function is hidden in the default ``AStar2D`` class. .. _class_AStar2D_method__estimate_cost: -- :ref:`float` **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual +- :ref:`float` **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** |virtual| Called when estimating the cost between a point and the path's ending point. @@ -113,7 +113,7 @@ If there already exists a point for the given ``id``, its position and weight sc .. _class_AStar2D_method_are_points_connected: -- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const +- :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** |const| Returns whether there is a connection/segment between the given points. @@ -152,7 +152,7 @@ Deletes the segment between the given points. .. _class_AStar2D_method_get_available_point_id: -- :ref:`int` **get_available_point_id** **(** **)** const +- :ref:`int` **get_available_point_id** **(** **)** |const| Returns the next available point ID with no point associated to it. @@ -160,7 +160,7 @@ Returns the next available point ID with no point associated to it. .. _class_AStar2D_method_get_closest_point: -- :ref:`int` **get_closest_point** **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** const +- :ref:`int` **get_closest_point** **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** |const| Returns the ID of the closest point to ``to_position``, optionally taking disabled points into account. Returns ``-1`` if there are no points in the points pool. @@ -170,7 +170,7 @@ Returns the ID of the closest point to ``to_position``, optionally taking disabl .. _class_AStar2D_method_get_closest_position_in_segment: -- :ref:`Vector2` **get_closest_position_in_segment** **(** :ref:`Vector2` to_position **)** const +- :ref:`Vector2` **get_closest_position_in_segment** **(** :ref:`Vector2` to_position **)** |const| Returns the closest position to ``to_position`` that resides inside a segment between two connected points. @@ -213,7 +213,7 @@ If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` .. _class_AStar2D_method_get_point_capacity: -- :ref:`int` **get_point_capacity** **(** **)** const +- :ref:`int` **get_point_capacity** **(** **)** |const| Returns the capacity of the structure backing the points, useful in conjunction with ``reserve_space``. @@ -242,7 +242,7 @@ Returns an array with the IDs of the points that form the connection with the gi .. _class_AStar2D_method_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** |const| Returns the number of points currently in the points pool. @@ -258,7 +258,7 @@ Returns an array with the points that are in the path found by AStar2D between t .. _class_AStar2D_method_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` id **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` id **)** |const| Returns the position of the point associated with the given ``id``. @@ -266,7 +266,7 @@ Returns the position of the point associated with the given ``id``. .. _class_AStar2D_method_get_point_weight_scale: -- :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const +- :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** |const| Returns the weight scale of the point associated with the given ``id``. @@ -282,7 +282,7 @@ Returns an array of all points. .. _class_AStar2D_method_has_point: -- :ref:`bool` **has_point** **(** :ref:`int` id **)** const +- :ref:`bool` **has_point** **(** :ref:`int` id **)** |const| Returns whether a point associated with the given ``id`` exists. @@ -290,7 +290,7 @@ Returns whether a point associated with the given ``id`` exists. .. _class_AStar2D_method_is_point_disabled: -- :ref:`bool` **is_point_disabled** **(** :ref:`int` id **)** const +- :ref:`bool` **is_point_disabled** **(** :ref:`int` id **)** |const| Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. @@ -334,3 +334,6 @@ Sets the ``position`` for the point with the given ``id``. Sets the ``weight_scale`` for the point with the given ``id``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 6fe0d4425..120a25d0f 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -96,3 +96,6 @@ The margin around the region. The :ref:`Rect2`'s :ref:`Rect2.size` for usage. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 10b6c3115..fd24b78f7 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -20,3 +20,6 @@ Description Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index 4ba61f794..6c448fbd3 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -44,3 +44,6 @@ Property Descriptions Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index 251edfe1e..ccbc39f97 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -18,3 +18,6 @@ Description Limits the frequencies in a range around the :ref:`AudioEffectFilter.cutoff_hz` and allows frequencies outside of this range to pass. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index c07d1c4d3..e36754932 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -18,3 +18,6 @@ Description Attenuates the frequencies inside of a range around the :ref:`AudioEffectFilter.cutoff_hz` and cuts frequencies outside of this band. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 150767232..90abc59b3 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -81,17 +81,17 @@ Methods ------- +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_cutoff_hz` **(** :ref:`int` voice_idx **)** 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_delay_ms` **(** :ref:`int` voice_idx **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_depth_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_level_db` **(** :ref:`int` voice_idx **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_voice_pan` **(** :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_voice_rate_hz` **(** :ref:`int` voice_idx **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_voice_cutoff_hz` **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -520,37 +520,37 @@ Method Descriptions .. _class_AudioEffectChorus_method_get_voice_cutoff_hz: -- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** |const| ---- .. _class_AudioEffectChorus_method_get_voice_delay_ms: -- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** |const| ---- .. _class_AudioEffectChorus_method_get_voice_depth_ms: -- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** |const| ---- .. _class_AudioEffectChorus_method_get_voice_level_db: -- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** |const| ---- .. _class_AudioEffectChorus_method_get_voice_pan: -- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** |const| ---- .. _class_AudioEffectChorus_method_get_voice_rate_hz: -- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** const +- :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** |const| ---- @@ -588,3 +588,6 @@ Method Descriptions - void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 7a7763d2a..c9d678b6d 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -162,3 +162,6 @@ Reduce the sound level using another audio bus for threshold detection. The level above which compression is applied to the audio. Value can range from -60 to 0. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 35d41b3da..92aeb3060 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -260,3 +260,6 @@ Sound level for ``tap2``. Pan position for ``tap2``. Value can range from -1 (fully left) to 1 (fully right). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index a46c87e37..f8bfb7110 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -13,15 +13,20 @@ AudioEffectDistortion Adds a distortion audio effect to an Audio bus. -Modify the sound to make it dirty. +Modify the sound to make it distorted. Description ----------- -Modify the sound and make it dirty. Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape. +Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape. 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. +Tutorials +--------- + +- :doc:`../tutorials/audio/audio_buses` + Properties ---------- @@ -145,3 +150,6 @@ Increases or decreases the volume after the effect. Value can range from -80 to Increases or decreases the volume before the effect. Value can range from -60 to 60. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index 1ca800425..b93a8c1b4 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -26,9 +26,9 @@ Methods ------- +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_band_count` **(** **)** const | +| :ref:`int` | :ref:`get_band_count` **(** **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_band_gain_db` **(** :ref:`int` band_idx **)** const | +| :ref:`float` | :ref:`get_band_gain_db` **(** :ref:`int` band_idx **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_band_gain_db` **(** :ref:`int` band_idx, :ref:`float` volume_db **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -38,7 +38,7 @@ Method Descriptions .. _class_AudioEffectEQ_method_get_band_count: -- :ref:`int` **get_band_count** **(** **)** const +- :ref:`int` **get_band_count** **(** **)** |const| Returns the number of bands of the equalizer. @@ -46,7 +46,7 @@ Returns the number of bands of the equalizer. .. _class_AudioEffectEQ_method_get_band_gain_db: -- :ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** const +- :ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** |const| Returns the band's gain at the specified index, in dB. @@ -58,3 +58,6 @@ Returns the band's gain at the specified index, in dB. Sets band's gain at the specified index, in dB. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index 5148d9316..4cb9fdaa2 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -42,3 +42,6 @@ Band 10: 16000 Hz See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index 501575136..6171d6895 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -64,3 +64,6 @@ Band 21: 22000 Hz See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ10`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index e4677ee64..60925c381 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -34,3 +34,6 @@ Band 6: 10000 Hz See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ10`, :ref:`AudioEffectEQ21`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 01ab714f6..95b2303e5 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -20,6 +20,11 @@ Description Allows frequencies other than the :ref:`cutoff_hz` to pass. +Tutorials +--------- + +- :doc:`../tutorials/audio/audio_buses` + Properties ---------- @@ -117,5 +122,8 @@ Gain amount of the frequencies after the filter. | *Getter* | get_resonance() | +-----------+----------------------+ -Amount of boost in the overtones near the cutoff frequency. +Amount of boost in the frequency range near the cutoff frequency. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index c5a37b83f..2b853d0ec 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -18,3 +18,6 @@ Description Cuts frequencies lower than the :ref:`AudioEffectFilter.cutoff_hz` and allows higher frequencies to pass. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst index 1e24a4f49..093f89fae 100644 --- a/classes/class_audioeffecthighshelffilter.rst +++ b/classes/class_audioeffecthighshelffilter.rst @@ -13,3 +13,6 @@ AudioEffectHighShelfFilter +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectinstance.rst b/classes/class_audioeffectinstance.rst index 5cc23c220..a89edde59 100644 --- a/classes/class_audioeffectinstance.rst +++ b/classes/class_audioeffectinstance.rst @@ -15,3 +15,6 @@ AudioEffectInstance +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 8ac78d527..063c03d8c 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -96,3 +96,6 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index 53a9d49d1..53604e3b3 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -18,3 +18,6 @@ Description Cuts frequencies higher than the :ref:`AudioEffectFilter.cutoff_hz` and allows lower frequencies to pass. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst index aa0265432..b798f0dfa 100644 --- a/classes/class_audioeffectlowshelffilter.rst +++ b/classes/class_audioeffectlowshelffilter.rst @@ -13,3 +13,6 @@ AudioEffectLowShelfFilter +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 92adb4be8..351241246 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -18,3 +18,6 @@ Description Attenuates frequencies in a narrow band around the :ref:`AudioEffectFilter.cutoff_hz` and cuts frequencies outside of this range. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index 1e947be1d..c8fb92a9f 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -42,3 +42,6 @@ Property Descriptions Pan position. Value can range from -1 (fully left) to 1 (fully right). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 617e2f146..763c2544b 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -116,3 +116,6 @@ Determines the minimum frequency affected by the LFO modulations, in Hz. Value c Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 91339af5a..d5689e279 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -107,3 +107,6 @@ Property Descriptions Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index 377c4eb9b..3d93f27b8 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -34,9 +34,9 @@ Methods ------- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStreamSample` | :ref:`get_recording` **(** **)** const | +| :ref:`AudioStreamSample` | :ref:`get_recording` **(** **)** |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_recording_active` **(** **)** const | +| :ref:`bool` | :ref:`is_recording_active` **(** **)** |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_recording_active` **(** :ref:`bool` record **)** | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ @@ -63,7 +63,7 @@ Method Descriptions .. _class_AudioEffectRecord_method_get_recording: -- :ref:`AudioStreamSample` **get_recording** **(** **)** const +- :ref:`AudioStreamSample` **get_recording** **(** **)** |const| Returns the recorded sample. @@ -71,7 +71,7 @@ Returns the recorded sample. .. _class_AudioEffectRecord_method_is_recording_active: -- :ref:`bool` **is_recording_active** **(** **)** const +- :ref:`bool` **is_recording_active** **(** **)** |const| Returns whether the recording is active or not. @@ -83,3 +83,6 @@ Returns whether the recording is active or not. If ``true``, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index b0ea1157a..824052c64 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -170,3 +170,6 @@ Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Val Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index 565fc7287..37cb48c1c 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -98,3 +98,6 @@ Property Descriptions | *Getter* | get_tap_back_pos() | +-----------+-------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectspectrumanalyzerinstance.rst b/classes/class_audioeffectspectrumanalyzerinstance.rst index 5160d104a..12993800f 100644 --- a/classes/class_audioeffectspectrumanalyzerinstance.rst +++ b/classes/class_audioeffectspectrumanalyzerinstance.rst @@ -16,9 +16,9 @@ AudioEffectSpectrumAnalyzerInstance Methods ------- -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_magnitude_for_frequency_range` **(** :ref:`float` from_hz, :ref:`float` to_hz, :ref:`MagnitudeMode` mode=1 **)** const | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_magnitude_for_frequency_range` **(** :ref:`float` from_hz, :ref:`float` to_hz, :ref:`MagnitudeMode` mode=1 **)** |const| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -40,5 +40,8 @@ Method Descriptions .. _class_AudioEffectSpectrumAnalyzerInstance_method_get_magnitude_for_frequency_range: -- :ref:`Vector2` **get_magnitude_for_frequency_range** **(** :ref:`float` from_hz, :ref:`float` to_hz, :ref:`MagnitudeMode` mode=1 **)** const +- :ref:`Vector2` **get_magnitude_for_frequency_range** **(** :ref:`float` from_hz, :ref:`float` to_hz, :ref:`MagnitudeMode` mode=1 **)** |const| +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 08866c2bc..98903726d 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -67,3 +67,6 @@ Property Descriptions | *Getter* | get_time_pullout() | +-----------+-------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 09f77509f..7ae33334b 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -48,9 +48,9 @@ Methods +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`capture_set_device` **(** :ref:`String` name **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | +| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_channels` **(** :ref:`int` bus_idx **)** const | +| :ref:`int` | :ref:`get_bus_channels` **(** :ref:`int` bus_idx **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,37 +58,37 @@ Methods +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioEffectInstance` | :ref:`get_bus_effect_instance` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` channel=0 **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | +| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | +| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | +| :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | +| :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | +| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | +| :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_device_list` **(** **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | +| :ref:`float` | :ref:`get_mix_rate` **(** **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_output_latency` **(** **)** const | +| :ref:`float` | :ref:`get_output_latency` **(** **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpeakerMode` | :ref:`get_speaker_mode` **(** **)** const | +| :ref:`SpeakerMode` | :ref:`get_speaker_mode` **(** **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_since_last_mix` **(** **)** const | +| :ref:`float` | :ref:`get_time_since_last_mix` **(** **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_to_next_mix` **(** **)** const | +| :ref:`float` | :ref:`get_time_to_next_mix` **(** **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** const | +| :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const | +| :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** const | +| :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | +| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lock` **(** **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -245,7 +245,7 @@ Sets which audio input device is used for audio capture. .. _class_AudioServer_method_generate_bus_layout: -- :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const +- :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** |const| Generates an :ref:`AudioBusLayout` using the available buses and effects. @@ -253,7 +253,7 @@ Generates an :ref:`AudioBusLayout` using the available bus .. _class_AudioServer_method_get_bus_channels: -- :ref:`int` **get_bus_channels** **(** :ref:`int` bus_idx **)** const +- :ref:`int` **get_bus_channels** **(** :ref:`int` bus_idx **)** |const| Returns the amount of channels of the bus at index ``bus_idx``. @@ -285,7 +285,7 @@ Returns the :ref:`AudioEffectInstance` assigned to th .. _class_AudioServer_method_get_bus_index: -- :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const +- :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** |const| Returns the index of the bus with the name ``bus_name``. @@ -293,7 +293,7 @@ Returns the index of the bus with the name ``bus_name``. .. _class_AudioServer_method_get_bus_name: -- :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const +- :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** |const| Returns the name of the bus with the index ``bus_idx``. @@ -301,7 +301,7 @@ Returns the name of the bus with the index ``bus_idx``. .. _class_AudioServer_method_get_bus_peak_volume_left_db: -- :ref:`float` **get_bus_peak_volume_left_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** const +- :ref:`float` **get_bus_peak_volume_left_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** |const| Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``. @@ -309,7 +309,7 @@ Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel .. _class_AudioServer_method_get_bus_peak_volume_right_db: -- :ref:`float` **get_bus_peak_volume_right_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** const +- :ref:`float` **get_bus_peak_volume_right_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** |const| Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``. @@ -317,7 +317,7 @@ Returns the peak volume of the right speaker at bus index ``bus_idx`` and channe .. _class_AudioServer_method_get_bus_send: -- :ref:`String` **get_bus_send** **(** :ref:`int` bus_idx **)** const +- :ref:`String` **get_bus_send** **(** :ref:`int` bus_idx **)** |const| Returns the name of the bus that the bus at index ``bus_idx`` sends to. @@ -325,7 +325,7 @@ Returns the name of the bus that the bus at index ``bus_idx`` sends to. .. _class_AudioServer_method_get_bus_volume_db: -- :ref:`float` **get_bus_volume_db** **(** :ref:`int` bus_idx **)** const +- :ref:`float` **get_bus_volume_db** **(** :ref:`int` bus_idx **)** |const| Returns the volume of the bus at index ``bus_idx`` in dB. @@ -341,7 +341,7 @@ Returns the names of all audio devices detected on the system. .. _class_AudioServer_method_get_mix_rate: -- :ref:`float` **get_mix_rate** **(** **)** const +- :ref:`float` **get_mix_rate** **(** **)** |const| Returns the sample rate at the output of the ``AudioServer``. @@ -349,7 +349,7 @@ Returns the sample rate at the output of the ``AudioServer``. .. _class_AudioServer_method_get_output_latency: -- :ref:`float` **get_output_latency** **(** **)** const +- :ref:`float` **get_output_latency** **(** **)** |const| Returns the audio driver's output latency. @@ -357,7 +357,7 @@ Returns the audio driver's output latency. .. _class_AudioServer_method_get_speaker_mode: -- :ref:`SpeakerMode` **get_speaker_mode** **(** **)** const +- :ref:`SpeakerMode` **get_speaker_mode** **(** **)** |const| Returns the speaker configuration. @@ -365,7 +365,7 @@ Returns the speaker configuration. .. _class_AudioServer_method_get_time_since_last_mix: -- :ref:`float` **get_time_since_last_mix** **(** **)** const +- :ref:`float` **get_time_since_last_mix** **(** **)** |const| Returns the relative time since the last mix occurred. @@ -373,7 +373,7 @@ Returns the relative time since the last mix occurred. .. _class_AudioServer_method_get_time_to_next_mix: -- :ref:`float` **get_time_to_next_mix** **(** **)** const +- :ref:`float` **get_time_to_next_mix** **(** **)** |const| Returns the relative time until the next mix occurs. @@ -381,7 +381,7 @@ Returns the relative time until the next mix occurs. .. _class_AudioServer_method_is_bus_bypassing_effects: -- :ref:`bool` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** const +- :ref:`bool` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** |const| If ``true``, the bus at index ``bus_idx`` is bypassing effects. @@ -389,7 +389,7 @@ If ``true``, the bus at index ``bus_idx`` is bypassing effects. .. _class_AudioServer_method_is_bus_effect_enabled: -- :ref:`bool` **is_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const +- :ref:`bool` **is_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** |const| If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. @@ -397,7 +397,7 @@ If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` .. _class_AudioServer_method_is_bus_mute: -- :ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** const +- :ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** |const| If ``true``, the bus at index ``bus_idx`` is muted. @@ -405,7 +405,7 @@ If ``true``, the bus at index ``bus_idx`` is muted. .. _class_AudioServer_method_is_bus_solo: -- :ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** const +- :ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** |const| If ``true``, the bus at index ``bus_idx`` is in solo mode. @@ -523,3 +523,6 @@ Swaps the position of two effects in bus ``bus_idx``. Unlocks the audio driver's main loop. (After locking it, you should always unlock it.) +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index e4dab81c1..6799dad5d 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -28,16 +28,19 @@ Tutorials Methods ------- -+---------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+---------------------------+--------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** |const| | ++---------------------------+----------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_AudioStream_method_get_length: -- :ref:`float` **get_length** **(** **)** const +- :ref:`float` **get_length** **(** **)** |const| Returns the length of the audio stream in seconds. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamgenerator.rst b/classes/class_audiostreamgenerator.rst index f6da08a01..d357a01f8 100644 --- a/classes/class_audiostreamgenerator.rst +++ b/classes/class_audiostreamgenerator.rst @@ -56,3 +56,6 @@ Property Descriptions | *Getter* | get_mix_rate() | +-----------+---------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst index 84ea1d1e9..cdfca4732 100644 --- a/classes/class_audiostreamgeneratorplayback.rst +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -22,13 +22,13 @@ Methods ------- +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_push_buffer` **(** :ref:`int` amount **)** const | +| :ref:`bool` | :ref:`can_push_buffer` **(** :ref:`int` amount **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_buffer` **(** **)** | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frames_available` **(** **)** const | +| :ref:`int` | :ref:`get_frames_available` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_skips` **(** **)** const | +| :ref:`int` | :ref:`get_skips` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`push_buffer` **(** :ref:`PoolVector2Array` frames **)** | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ @@ -40,7 +40,7 @@ Method Descriptions .. _class_AudioStreamGeneratorPlayback_method_can_push_buffer: -- :ref:`bool` **can_push_buffer** **(** :ref:`int` amount **)** const +- :ref:`bool` **can_push_buffer** **(** :ref:`int` amount **)** |const| ---- @@ -52,13 +52,13 @@ Method Descriptions .. _class_AudioStreamGeneratorPlayback_method_get_frames_available: -- :ref:`int` **get_frames_available** **(** **)** const +- :ref:`int` **get_frames_available** **(** **)** |const| ---- .. _class_AudioStreamGeneratorPlayback_method_get_skips: -- :ref:`int` **get_skips** **(** **)** const +- :ref:`int` **get_skips** **(** **)** |const| ---- @@ -72,3 +72,6 @@ Method Descriptions - :ref:`bool` **push_frame** **(** :ref:`Vector2` frame **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreammicrophone.rst b/classes/class_audiostreammicrophone.rst index 8a4707c5c..a07ba5e5f 100644 --- a/classes/class_audiostreammicrophone.rst +++ b/classes/class_audiostreammicrophone.rst @@ -13,3 +13,6 @@ AudioStreamMicrophone +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index a4cfbb959..78fb2a742 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -78,3 +78,6 @@ If ``true``, the stream will automatically loop when it reaches the end. Time in seconds at which the stream starts after being looped. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index 4c54f31bb..1a76f4d2b 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -20,3 +20,6 @@ Description Can play, loop, pause a scroll through audio. See :ref:`AudioStream` and :ref:`AudioStreamOGGVorbis` for usage. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst index d09ff003e..f69318fdc 100644 --- a/classes/class_audiostreamplaybackresampled.rst +++ b/classes/class_audiostreamplaybackresampled.rst @@ -15,3 +15,6 @@ AudioStreamPlaybackResampled +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index a263cf252..ca8e65cde 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -253,3 +253,6 @@ Sets the position from which audio will be played, in seconds. Stops the audio. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 2ec5760e5..05846038e 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -270,3 +270,6 @@ Sets the position from which audio will be played, in seconds. Stops the audio. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index d24419afe..984a1b3c3 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -18,6 +18,8 @@ Description Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. +By default, audio is heard from the camera position. This can be changed by adding a :ref:`Listener` node to the scene and enabling it by calling :ref:`Listener.make_current` on it. + Tutorials --------- @@ -487,3 +489,6 @@ Sets the position from which audio will be played, in seconds. Stops the audio. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index e3f9b9137..81f4eb900 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -58,3 +58,6 @@ The current :ref:`AudioStream`. The intensity of random pitch variation. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index c0bb933bc..66c6fbf4a 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -213,3 +213,6 @@ Saves the AudioStreamSample as a WAV file to ``path``. Samples with IMA ADPCM fo **Note:** A ``.wav`` extension is automatically appended to ``path`` if it is missing. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 558dd37b1..aadbb7d88 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -81,3 +81,6 @@ Buffer mode. See :ref:`CopyMode` constants. The area covered by the BackBufferCopy. Only used if :ref:`copy_mode` is :ref:`COPY_MODE_RECT`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index bc396ac21..ae2c04bc5 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -312,3 +312,6 @@ Bakes the lightmaps within the currently edited scene. Returns a :ref:`BakeError Executes a dry run bake of lightmaps within the currently edited scene. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_bakedlightmapdata.rst b/classes/class_bakedlightmapdata.rst index 216fe5357..9dc807885 100644 --- a/classes/class_bakedlightmapdata.rst +++ b/classes/class_bakedlightmapdata.rst @@ -36,11 +36,11 @@ Methods +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_users` **(** **)** | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_user_count` **(** **)** const | +| :ref:`int` | :ref:`get_user_count` **(** **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_user_lightmap` **(** :ref:`int` user_idx **)** const | +| :ref:`Texture` | :ref:`get_user_lightmap` **(** :ref:`int` user_idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_user_path` **(** :ref:`int` user_idx **)** const | +| :ref:`NodePath` | :ref:`get_user_path` **(** :ref:`int` user_idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions @@ -131,17 +131,20 @@ Method Descriptions .. _class_BakedLightmapData_method_get_user_count: -- :ref:`int` **get_user_count** **(** **)** const +- :ref:`int` **get_user_count** **(** **)** |const| ---- .. _class_BakedLightmapData_method_get_user_lightmap: -- :ref:`Texture` **get_user_lightmap** **(** :ref:`int` user_idx **)** const +- :ref:`Texture` **get_user_lightmap** **(** :ref:`int` user_idx **)** |const| ---- .. _class_BakedLightmapData_method_get_user_path: -- :ref:`NodePath` **get_user_path** **(** :ref:`int` user_idx **)** const +- :ref:`NodePath` **get_user_path** **(** :ref:`int` user_idx **)** |const| +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index bfd4a5ee0..9238d4feb 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -50,15 +50,15 @@ Properties Methods ------- -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_pressed` **(** **)** virtual | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_toggled` **(** :ref:`bool` button_pressed **)** virtual | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`DrawMode` | :ref:`get_draw_mode` **(** **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hovered` **(** **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_pressed` **(** **)** |virtual| | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_toggled` **(** :ref:`bool` button_pressed **)** |virtual| | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`DrawMode` | :ref:`get_draw_mode` **(** **)** |const| | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hovered` **(** **)** |const| | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -302,7 +302,7 @@ Method Descriptions .. _class_BaseButton_method__pressed: -- void **_pressed** **(** **)** virtual +- void **_pressed** **(** **)** |virtual| Called when the button is pressed. If you need to know the button's pressed state (and :ref:`toggle_mode` is active), use :ref:`_toggled` instead. @@ -310,7 +310,7 @@ Called when the button is pressed. If you need to know the button's pressed stat .. _class_BaseButton_method__toggled: -- void **_toggled** **(** :ref:`bool` button_pressed **)** virtual +- void **_toggled** **(** :ref:`bool` button_pressed **)** |virtual| Called when the button is toggled (only if :ref:`toggle_mode` is active). @@ -318,7 +318,7 @@ Called when the button is toggled (only if :ref:`toggle_mode` **get_draw_mode** **(** **)** const +- :ref:`DrawMode` **get_draw_mode** **(** **)** |const| Returns 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 :ref:`DrawMode` enum. @@ -326,7 +326,10 @@ Returns the visual state used to draw the button. This is useful mainly when imp .. _class_BaseButton_method_is_hovered: -- :ref:`bool` **is_hovered** **(** **)** const +- :ref:`bool` **is_hovered** **(** **)** |const| Returns ``true`` if the mouse has entered the button and has not left it yet. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 1227640dc..f06c96260 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -316,3 +316,6 @@ Returns a vector transformed (multiplied) by the transposed basis matrix. **Note:** This results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 957545a75..e4444680b 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -26,15 +26,15 @@ Methods +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from_image_alpha` **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** const | +| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_size` **(** **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_true_bit_count` **(** **)** const | +| :ref:`int` | :ref:`get_true_bit_count` **(** **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grow_mask` **(** :ref:`int` pixels, :ref:`Rect2` rect **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`opaque_to_polygons` **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const | +| :ref:`Array` | :ref:`opaque_to_polygons` **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -62,7 +62,7 @@ Creates a bitmap that matches the given image dimensions, every element of the b .. _class_BitMap_method_get_bit: -- :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const +- :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** |const| Returns bitmap's value at the specified position. @@ -70,7 +70,7 @@ Returns bitmap's value at the specified position. .. _class_BitMap_method_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** |const| Returns bitmap's dimensions. @@ -78,7 +78,7 @@ Returns bitmap's dimensions. .. _class_BitMap_method_get_true_bit_count: -- :ref:`int` **get_true_bit_count** **(** **)** const +- :ref:`int` **get_true_bit_count** **(** **)** |const| Returns the amount of bitmap elements that are set to ``true``. @@ -88,11 +88,13 @@ Returns the amount of bitmap elements that are set to ``true``. - void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** +Applies morphological dilation to the bitmap. The first argument is the dilation amount, Rect2 is the area where the dilation will be applied. + ---- .. _class_BitMap_method_opaque_to_polygons: -- :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const +- :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** |const| ---- @@ -110,3 +112,6 @@ Sets the bitmap's element at the specified position, to the specified value. Sets a rectangular portion of the bitmap to the specified value. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 9a70e1405..6d2f0f5b1 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -47,11 +47,11 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** 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:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_count` **(** **)** const | +| :ref:`int` | :ref:`get_texture_count` **(** **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions @@ -162,7 +162,7 @@ Creates a BitmapFont from the ``*.fnt`` file at ``path``. .. _class_BitmapFont_method_get_kerning_pair: -- :ref:`int` **get_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b **)** const +- :ref:`int` **get_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b **)** |const| Returns a kerning pair as a difference. @@ -170,7 +170,7 @@ Returns a kerning pair as a difference. .. _class_BitmapFont_method_get_texture: -- :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** |const| Returns the font atlas texture at index ``idx``. @@ -178,7 +178,10 @@ Returns the font atlas texture at index ``idx``. .. _class_BitmapFont_method_get_texture_count: -- :ref:`int` **get_texture_count** **(** **)** const +- :ref:`int` **get_texture_count** **(** **)** |const| Returns the number of textures in the BitmapFont atlas. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index 560c9d869..e667facfb 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -36,13 +36,13 @@ Properties Methods ------- -+---------------------------------------+-------------------------------------------------------------------------------------------+ -| void | :ref:`apply_rest` **(** **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index_in_skeleton` **(** **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_skeleton_rest` **(** **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------+ ++---------------------------------------+---------------------------------------------------------------------------------------------+ +| void | :ref:`apply_rest` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index_in_skeleton` **(** **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_skeleton_rest` **(** **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -90,7 +90,7 @@ Stores the node's current transforms in :ref:`rest`. .. _class_Bone2D_method_get_index_in_skeleton: -- :ref:`int` **get_index_in_skeleton** **(** **)** const +- :ref:`int` **get_index_in_skeleton** **(** **)** |const| Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D`. @@ -98,7 +98,10 @@ Returns the node's index as part of the entire skeleton. See :ref:`Skeleton2D` **get_skeleton_rest** **(** **)** const +- :ref:`Transform2D` **get_skeleton_rest** **(** **)** |const| Returns the node's :ref:`rest` ``Transform2D`` if it doesn't have a parent, or its rest pose relative to its parent. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index d61bb8f92..825068c8e 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -42,3 +42,6 @@ Property Descriptions The name of the attached bone. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_bool.rst b/classes/class_bool.rst index fb9f52dfc..0a5a28db3 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -88,3 +88,6 @@ Cast a :ref:`String` value to a boolean value, this method will re Examples: ``bool("False")`` returns ``true``, ``bool("")`` returns ``false``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 412a587f6..9c5e3aadb 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -81,3 +81,6 @@ Method Descriptions Adds a control to the box as a spacer. If ``true``, ``begin`` will insert the spacer control in front of other children. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index 00cb4f9fa..0b3d8ab65 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -42,3 +42,6 @@ Property Descriptions The box's half extents. The width, height and depth of this shape is twice the half extents. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_bulletphysicsserver.rst b/classes/class_bulletphysicsserver.rst index 47ef924ed..a778a4582 100644 --- a/classes/class_bulletphysicsserver.rst +++ b/classes/class_bulletphysicsserver.rst @@ -13,3 +13,6 @@ BulletPhysicsServer +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_button.rst b/classes/class_button.rst index dbf1d9e3d..d2ac56441 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -20,6 +20,21 @@ Description Button is the standard themed button. It can contain text and an icon, and will display them according to the current :ref:`Theme`. +**Example of creating a button and assigning an action when pressed by code:** + +:: + + func _ready(): + var button = Button.new() + button.text = "Click me" + button.connect("pressed", self, "_button_pressed") + add_child(button) + + func _button_pressed(): + print("Hello world!") + +Buttons (like all Control nodes) can also be created in the editor, but some situations may require creating them from code. + Properties ---------- @@ -178,3 +193,6 @@ Button's icon, if text is present the icon will be placed before the text. The button's text that will be displayed inside the button's area. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index bf30b40dd..8fb2199e5 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -53,3 +53,6 @@ Returns an :ref:`Array` of :ref:`Button`\ s who have Returns the current pressed button. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 30aff5787..31f53f819 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -57,25 +57,25 @@ Methods +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_camera_rid` **(** **)** const | +| :ref:`RID` | :ref:`get_camera_rid` **(** **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | +| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_cull_mask_bit` **(** :ref:`int` layer **)** const | +| :ref:`bool` | :ref:`get_cull_mask_bit` **(** :ref:`int` layer **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_frustum` **(** **)** const | +| :ref:`Array` | :ref:`get_frustum` **(** **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** const | +| :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_current` **(** **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point, :ref:`float` z_depth **)** const | +| :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point, :ref:`float` z_depth **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cull_mask_bit` **(** :ref:`int` layer, :ref:`bool` enable **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -85,7 +85,7 @@ Methods +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** const | +| :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations @@ -359,7 +359,7 @@ If this is the current camera, remove it from being current. If ``enable_next`` .. _class_Camera_method_get_camera_rid: -- :ref:`RID` **get_camera_rid** **(** **)** const +- :ref:`RID` **get_camera_rid** **(** **)** |const| Returns the camera's RID from the :ref:`VisualServer`. @@ -367,7 +367,7 @@ Returns the camera's RID from the :ref:`VisualServer`. .. _class_Camera_method_get_camera_transform: -- :ref:`Transform` **get_camera_transform** **(** **)** const +- :ref:`Transform` **get_camera_transform** **(** **)** |const| Gets the camera transform. Subclassed cameras such as :ref:`InterpolatedCamera` may provide different transforms than the :ref:`Node` transform. @@ -375,7 +375,7 @@ Gets the camera transform. Subclassed cameras such as :ref:`InterpolatedCamera` **get_cull_mask_bit** **(** :ref:`int` layer **)** const +- :ref:`bool` **get_cull_mask_bit** **(** :ref:`int` layer **)** |const| Returns ``true`` if the given ``layer`` in the :ref:`cull_mask` is enabled, ``false`` otherwise. @@ -383,7 +383,7 @@ Returns ``true`` if the given ``layer`` in the :ref:`cull_mask` **get_frustum** **(** **)** const +- :ref:`Array` **get_frustum** **(** **)** |const| Returns the camera's frustum planes in world-space units as an array of :ref:`Plane`\ s in the following order: near, far, left, top, right, bottom. Not to be confused with :ref:`frustum_offset`. @@ -391,7 +391,7 @@ Returns the camera's frustum planes in world-space units as an array of :ref:`Pl .. _class_Camera_method_is_position_behind: -- :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** const +- :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** |const| Returns ``true`` if the given position is behind the camera. @@ -409,7 +409,7 @@ Makes this camera the current camera for the :ref:`Viewport` (se .. _class_Camera_method_project_local_ray_normal: -- :ref:`Vector3` **project_local_ray_normal** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_local_ray_normal** **(** :ref:`Vector2` screen_point **)** |const| Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. @@ -417,7 +417,7 @@ Returns a normal vector from the screen point location directed along the camera .. _class_Camera_method_project_position: -- :ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point, :ref:`float` z_depth **)** const +- :ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point, :ref:`float` z_depth **)** |const| Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport` rectangle on a plane that is the given ``z_depth`` distance into the scene away from the camera. @@ -425,7 +425,7 @@ Returns the 3D point in worldspace that maps to the given 2D coordinate in the : .. _class_Camera_method_project_ray_normal: -- :ref:`Vector3` **project_ray_normal** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_ray_normal** **(** :ref:`Vector2` screen_point **)** |const| Returns a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. @@ -433,7 +433,7 @@ Returns a normal vector in worldspace, that is the result of projecting a point .. _class_Camera_method_project_ray_origin: -- :ref:`Vector3` **project_ray_origin** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_ray_origin** **(** :ref:`Vector2` screen_point **)** |const| Returns a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. @@ -473,7 +473,10 @@ Sets the camera projection to perspective mode (see :ref:`PROJECTION_PERSPECTIVE .. _class_Camera_method_unproject_position: -- :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** const +- :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** |const| Returns the 2D coordinate in the :ref:`Viewport` rectangle that maps to the given 3D point in worldspace. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index c76d1b4fa..d0d8b98d2 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -87,13 +87,13 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_update_scroll` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | +| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | +| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`Margin` margin **)** const | +| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`Margin` margin **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_limit` **(** :ref:`Margin` margin **)** const | +| :ref:`int` | :ref:`get_limit` **(** :ref:`Margin` margin **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_current` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -563,7 +563,7 @@ Forces the camera to update scroll immediately. .. _class_Camera2D_method_get_camera_position: -- :ref:`Vector2` **get_camera_position** **(** **)** const +- :ref:`Vector2` **get_camera_position** **(** **)** |const| Returns the camera position. @@ -571,7 +571,7 @@ Returns the camera position. .. _class_Camera2D_method_get_camera_screen_center: -- :ref:`Vector2` **get_camera_screen_center** **(** **)** const +- :ref:`Vector2` **get_camera_screen_center** **(** **)** |const| Returns the location of the ``Camera2D``'s screen-center, relative to the origin. @@ -579,7 +579,7 @@ Returns the location of the ``Camera2D``'s screen-center, relative to the origin .. _class_Camera2D_method_get_drag_margin: -- :ref:`float` **get_drag_margin** **(** :ref:`Margin` margin **)** const +- :ref:`float` **get_drag_margin** **(** :ref:`Margin` margin **)** |const| Returns the specified margin. See also :ref:`drag_margin_bottom`, :ref:`drag_margin_top`, :ref:`drag_margin_left`, and :ref:`drag_margin_right`. @@ -587,7 +587,7 @@ Returns the specified margin. See also :ref:`drag_margin_bottom` **get_limit** **(** :ref:`Margin` margin **)** const +- :ref:`int` **get_limit** **(** :ref:`Margin` margin **)** |const| Returns the specified camera limit. See also :ref:`limit_bottom`, :ref:`limit_top`, :ref:`limit_left`, and :ref:`limit_right`. @@ -625,3 +625,6 @@ Sets the specified margin. See also :ref:`drag_margin_bottom`, :ref:`limit_top`, :ref:`limit_left`, and :ref:`limit_right`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index 49d8253fd..1dddd2909 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -32,13 +32,13 @@ Properties Methods ------- -+---------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_id` **(** **)** const | -+---------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+---------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`FeedPosition` | :ref:`get_position` **(** **)** const | -+---------------------------------------------------+-----------------------------------------------------------------------------+ ++---------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`FeedPosition` | :ref:`get_position` **(** **)** |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------+ Enumerations ------------ @@ -119,7 +119,7 @@ Method Descriptions .. _class_CameraFeed_method_get_id: -- :ref:`int` **get_id** **(** **)** const +- :ref:`int` **get_id** **(** **)** |const| Returns the unique ID for this feed. @@ -127,7 +127,7 @@ Returns the unique ID for this feed. .. _class_CameraFeed_method_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** |const| Returns the camera's name. @@ -135,7 +135,10 @@ Returns the camera's name. .. _class_CameraFeed_method_get_position: -- :ref:`FeedPosition` **get_position** **(** **)** const +- :ref:`FeedPosition` **get_position** **(** **)** |const| Returns the position of camera on the device. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_cameraserver.rst b/classes/class_cameraserver.rst index 258655537..36c8f9524 100644 --- a/classes/class_cameraserver.rst +++ b/classes/class_cameraserver.rst @@ -116,3 +116,6 @@ Returns the number of :ref:`CameraFeed`\ s registered. Removes a :ref:`CameraFeed`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index 8721a4f5e..c47dc8bdc 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -82,3 +82,6 @@ Convenience property that gives access to the active property of the :ref:`Camer Which image within the :ref:`CameraFeed` we want access to, important if the camera image is split in a Y and CbCr component. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index fbaf892c6..92fbb8751 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -62,7 +62,7 @@ Methods ------- +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_draw` **(** **)** virtual | +| void | :ref:`_draw` **(** **)** |virtual| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_arc` **(** :ref:`Vector2` center, :ref:`float` radius, :ref:`float` start_angle, :ref:`float` end_angle, :ref:`int` point_count, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -108,41 +108,41 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_update_transform` **(** **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | +| :ref:`RID` | :ref:`get_canvas` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | +| :ref:`RID` | :ref:`get_canvas_item` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | +| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | +| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hide` **(** **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | +| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -368,7 +368,7 @@ Method Descriptions .. _class_CanvasItem_method__draw: -- void **_draw** **(** **)** virtual +- void **_draw** **(** **)** |virtual| Overridable function called by the engine (if defined) to draw the canvas item. @@ -570,7 +570,7 @@ Forces the transform to update. Transform changes in physics are not instant for .. _class_CanvasItem_method_get_canvas: -- :ref:`RID` **get_canvas** **(** **)** const +- :ref:`RID` **get_canvas** **(** **)** |const| Returns the :ref:`RID` of the :ref:`World2D` canvas where this item is in. @@ -578,7 +578,7 @@ Returns the :ref:`RID` of the :ref:`World2D` canvas wh .. _class_CanvasItem_method_get_canvas_item: -- :ref:`RID` **get_canvas_item** **(** **)** const +- :ref:`RID` **get_canvas_item** **(** **)** |const| Returns the canvas item RID used by :ref:`VisualServer` for this item. @@ -586,7 +586,7 @@ Returns the canvas item RID used by :ref:`VisualServer` for .. _class_CanvasItem_method_get_canvas_transform: -- :ref:`Transform2D` **get_canvas_transform** **(** **)** const +- :ref:`Transform2D` **get_canvas_transform** **(** **)** |const| Returns the transform matrix of this item's canvas. @@ -594,7 +594,7 @@ Returns the transform matrix of this item's canvas. .. _class_CanvasItem_method_get_global_mouse_position: -- :ref:`Vector2` **get_global_mouse_position** **(** **)** const +- :ref:`Vector2` **get_global_mouse_position** **(** **)** |const| Returns the global position of the mouse. @@ -602,7 +602,7 @@ Returns the global position of the mouse. .. _class_CanvasItem_method_get_global_transform: -- :ref:`Transform2D` **get_global_transform** **(** **)** const +- :ref:`Transform2D` **get_global_transform** **(** **)** |const| Returns the global transform matrix of this item. @@ -610,7 +610,7 @@ Returns the global transform matrix of this item. .. _class_CanvasItem_method_get_global_transform_with_canvas: -- :ref:`Transform2D` **get_global_transform_with_canvas** **(** **)** const +- :ref:`Transform2D` **get_global_transform_with_canvas** **(** **)** |const| Returns the global transform matrix of this item in relation to the canvas. @@ -618,7 +618,7 @@ Returns the global transform matrix of this item in relation to the canvas. .. _class_CanvasItem_method_get_local_mouse_position: -- :ref:`Vector2` **get_local_mouse_position** **(** **)** const +- :ref:`Vector2` **get_local_mouse_position** **(** **)** |const| Returns the mouse position relative to this item's position. @@ -626,7 +626,7 @@ Returns the mouse position relative to this item's position. .. _class_CanvasItem_method_get_transform: -- :ref:`Transform2D` **get_transform** **(** **)** const +- :ref:`Transform2D` **get_transform** **(** **)** |const| Returns the transform matrix of this item. @@ -634,7 +634,7 @@ Returns the transform matrix of this item. .. _class_CanvasItem_method_get_viewport_rect: -- :ref:`Rect2` **get_viewport_rect** **(** **)** const +- :ref:`Rect2` **get_viewport_rect** **(** **)** |const| Returns the viewport's boundaries as a :ref:`Rect2`. @@ -642,7 +642,7 @@ Returns the viewport's boundaries as a :ref:`Rect2`. .. _class_CanvasItem_method_get_viewport_transform: -- :ref:`Transform2D` **get_viewport_transform** **(** **)** const +- :ref:`Transform2D` **get_viewport_transform** **(** **)** |const| Returns this item's transform in relation to the viewport. @@ -650,7 +650,7 @@ Returns this item's transform in relation to the viewport. .. _class_CanvasItem_method_get_world_2d: -- :ref:`World2D` **get_world_2d** **(** **)** const +- :ref:`World2D` **get_world_2d** **(** **)** |const| Returns the :ref:`World2D` where this item is in. @@ -666,7 +666,7 @@ Hide the ``CanvasItem`` if it's currently visible. .. _class_CanvasItem_method_is_local_transform_notification_enabled: -- :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const +- :ref:`bool` **is_local_transform_notification_enabled** **(** **)** |const| Returns ``true`` if local transform notifications are communicated to children. @@ -674,7 +674,7 @@ Returns ``true`` if local transform notifications are communicated to children. .. _class_CanvasItem_method_is_set_as_toplevel: -- :ref:`bool` **is_set_as_toplevel** **(** **)** const +- :ref:`bool` **is_set_as_toplevel** **(** **)** |const| Returns ``true`` if the node is set as top-level. See :ref:`set_as_toplevel`. @@ -682,7 +682,7 @@ Returns ``true`` if the node is set as top-level. See :ref:`set_as_toplevel` **is_transform_notification_enabled** **(** **)** const +- :ref:`bool` **is_transform_notification_enabled** **(** **)** |const| Returns ``true`` if global transform notifications are communicated to children. @@ -690,7 +690,7 @@ Returns ``true`` if global transform notifications are communicated to children. .. _class_CanvasItem_method_is_visible_in_tree: -- :ref:`bool` **is_visible_in_tree** **(** **)** const +- :ref:`bool` **is_visible_in_tree** **(** **)** |const| Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree. @@ -698,7 +698,7 @@ Returns ``true`` if the node is present in the :ref:`SceneTree` .. _class_CanvasItem_method_make_canvas_position_local: -- :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** |const| Assigns ``screen_point`` as this node's new local transform. @@ -706,7 +706,7 @@ Assigns ``screen_point`` as this node's new local transform. .. _class_CanvasItem_method_make_input_local: -- :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const +- :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** |const| Transformations issued by ``event``'s inputs are applied in local space instead of global space. @@ -750,3 +750,6 @@ Show the ``CanvasItem`` if it's currently hidden. For controls that inherit :ref Queue the ``CanvasItem`` for update. :ref:`NOTIFICATION_DRAW` will be called on idle time to request redraw. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 973be6526..44e552b40 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -179,3 +179,6 @@ If ``true``, enable spritesheet-based animation features when assigned to :ref:` This property (and other ``particles_anim_*`` properties that depend on it) has no effect on other types of nodes. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index fff1109e3..1ac293fca 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -53,9 +53,9 @@ Properties Methods ------- -+-----------------------+--------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | -+-----------------------+--------------------------------------------------------------------------+ ++-----------------------+----------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** |const| | ++-----------------------+----------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -205,7 +205,10 @@ Method Descriptions .. _class_CanvasLayer_method_get_canvas: -- :ref:`RID` **get_canvas** **(** **)** const +- :ref:`RID` **get_canvas** **(** **)** |const| Returns the RID of the canvas used by this layer. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index a659d6120..273f80255 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -42,3 +42,6 @@ Property Descriptions The tint color to apply. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 60cc04a9d..995355a61 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -96,3 +96,6 @@ Radius of the capsule mesh. Number of rings along the height of the capsule. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 313f5a8c2..08ad8ae7d 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -60,3 +60,6 @@ The capsule's height. The capsule's radius. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index cf5962aaf..e8d006384 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -60,3 +60,6 @@ The capsule's height. The capsule's radius. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 635f7dbb9..fd3a9945f 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -42,3 +42,6 @@ Property Descriptions If ``true``, centers children relative to the ``CenterContainer``'s top left corner. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_charfxtransform.rst b/classes/class_charfxtransform.rst index ddd0f5d94..f53f743fd 100644 --- a/classes/class_charfxtransform.rst +++ b/classes/class_charfxtransform.rst @@ -189,3 +189,6 @@ The index of the current character (starting from 0). Setting this property won' If ``true``, the character will be drawn. If ``false``, the character will be hidden. Characters around hidden characters will reflow to take the space of hidden characters. If this is not desired, set their :ref:`color` to ``Color(1, 1, 1, 0)`` instead. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index c3c03b98e..27ae648bd 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -68,3 +68,6 @@ Theme Properties | :ref:`Texture` | unchecked | | +---------------------------------+--------------------------+------------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index a788bef4e..7a4836d10 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -68,3 +68,6 @@ Theme Properties | :ref:`StyleBox` | pressed | | +---------------------------------+--------------------------+------------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index a4052cb5e..df9078201 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -42,3 +42,6 @@ Property Descriptions The circle's radius. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index e8ba1aa71..06007fad3 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -21,54 +21,54 @@ Provides access to metadata stored for every available class. Methods ------- -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_ClassDB_method_can_instance: -- :ref:`bool` **can_instance** **(** :ref:`String` class **)** const +- :ref:`bool` **can_instance** **(** :ref:`String` class **)** |const| Returns ``true`` if you can instance objects from the specified ``class``, ``false`` in other case. @@ -76,7 +76,7 @@ Returns ``true`` if you can instance objects from the specified ``class``, ``fal .. _class_ClassDB_method_class_exists: -- :ref:`bool` **class_exists** **(** :ref:`String` class **)** const +- :ref:`bool` **class_exists** **(** :ref:`String` class **)** |const| Returns whether the specified ``class`` is available or not. @@ -84,7 +84,7 @@ Returns whether the specified ``class`` is available or not. .. _class_ClassDB_method_class_get_category: -- :ref:`String` **class_get_category** **(** :ref:`String` class **)** const +- :ref:`String` **class_get_category** **(** :ref:`String` class **)** |const| Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. @@ -92,7 +92,7 @@ Returns a category associated with the class for use in documentation and the As .. _class_ClassDB_method_class_get_integer_constant: -- :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const +- :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** |const| Returns the value of the integer constant ``name`` of ``class`` or its ancestry. Always returns 0 when the constant could not be found. @@ -100,7 +100,7 @@ Returns the value of the integer constant ``name`` of ``class`` or its ancestry. .. _class_ClassDB_method_class_get_integer_constant_list: -- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** |const| Returns an array with the names all the integer constants of ``class`` or its ancestry. @@ -108,7 +108,7 @@ Returns an array with the names all the integer constants of ``class`` or its an .. _class_ClassDB_method_class_get_method_list: -- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** |const| Returns an array with all the methods of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``. @@ -116,7 +116,7 @@ Returns an array with all the methods of ``class`` or its ancestry if ``no_inher .. _class_ClassDB_method_class_get_property: -- :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const +- :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** |const| Returns the value of ``property`` of ``class`` or its ancestry. @@ -124,7 +124,7 @@ Returns the value of ``property`` of ``class`` or its ancestry. .. _class_ClassDB_method_class_get_property_list: -- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** |const| Returns an array with all the properties of ``class`` or its ancestry if ``no_inheritance`` is ``false``. @@ -132,7 +132,7 @@ Returns an array with all the properties of ``class`` or its ancestry if ``no_in .. _class_ClassDB_method_class_get_signal: -- :ref:`Dictionary` **class_get_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +- :ref:`Dictionary` **class_get_signal** **(** :ref:`String` class, :ref:`String` signal **)** |const| Returns the ``signal`` data of ``class`` or its ancestry. The returned value is a :ref:`Dictionary` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``. @@ -140,7 +140,7 @@ Returns the ``signal`` data of ``class`` or its ancestry. The returned value is .. _class_ClassDB_method_class_get_signal_list: -- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** |const| Returns an array with all the signals of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary` as described in :ref:`class_get_signal`. @@ -148,7 +148,7 @@ Returns an array with all the signals of ``class`` or its ancestry if ``no_inher .. _class_ClassDB_method_class_has_integer_constant: -- :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const +- :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** |const| Returns whether ``class`` or its ancestry has an integer constant called ``name`` or not. @@ -156,7 +156,7 @@ Returns whether ``class`` or its ancestry has an integer constant called ``name` .. _class_ClassDB_method_class_has_method: -- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const +- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** |const| Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) has a method called ``method`` or not. @@ -164,7 +164,7 @@ Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) h .. _class_ClassDB_method_class_has_signal: -- :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +- :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** |const| Returns whether ``class`` or its ancestry has a signal called ``signal`` or not. @@ -172,7 +172,7 @@ Returns whether ``class`` or its ancestry has a signal called ``signal`` or not. .. _class_ClassDB_method_class_set_property: -- :ref:`Error` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const +- :ref:`Error` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** |const| Sets ``property`` value of ``class`` to ``value``. @@ -180,7 +180,7 @@ Sets ``property`` value of ``class`` to ``value``. .. _class_ClassDB_method_get_class_list: -- :ref:`PoolStringArray` **get_class_list** **(** **)** const +- :ref:`PoolStringArray` **get_class_list** **(** **)** |const| Returns the names of all the classes available. @@ -188,7 +188,7 @@ Returns the names of all the classes available. .. _class_ClassDB_method_get_inheriters_from_class: -- :ref:`PoolStringArray` **get_inheriters_from_class** **(** :ref:`String` class **)** const +- :ref:`PoolStringArray` **get_inheriters_from_class** **(** :ref:`String` class **)** |const| Returns the names of all the classes that directly or indirectly inherit from ``class``. @@ -196,7 +196,7 @@ Returns the names of all the classes that directly or indirectly inherit from `` .. _class_ClassDB_method_get_parent_class: -- :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const +- :ref:`String` **get_parent_class** **(** :ref:`String` class **)** |const| Returns the parent class of ``class``. @@ -204,7 +204,7 @@ Returns the parent class of ``class``. .. _class_ClassDB_method_instance: -- :ref:`Variant` **instance** **(** :ref:`String` class **)** const +- :ref:`Variant` **instance** **(** :ref:`String` class **)** |const| Creates an instance of ``class``. @@ -212,7 +212,7 @@ Creates an instance of ``class``. .. _class_ClassDB_method_is_class_enabled: -- :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const +- :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** |const| Returns whether this ``class`` is enabled or not. @@ -220,7 +220,10 @@ Returns whether this ``class`` is enabled or not. .. _class_ClassDB_method_is_parent_class: -- :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const +- :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** |const| Returns whether ``inherits`` is an ancestor of ``class`` or not. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_clippedcamera.rst b/classes/class_clippedcamera.rst index 630220bc1..a308a751b 100644 --- a/classes/class_clippedcamera.rst +++ b/classes/class_clippedcamera.rst @@ -43,9 +43,9 @@ Methods +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_exceptions` **(** **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_clip_offset` **(** **)** const | +| :ref:`float` | :ref:`get_clip_offset` **(** **)** |const| | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_exception` **(** :ref:`Object` node **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -116,7 +116,7 @@ If ``true``, the camera stops on contact with :ref:`PhysicsBody`_ in the documentation for more information. ---- @@ -179,7 +179,7 @@ Removes all collision exceptions. .. _class_ClippedCamera_method_get_clip_offset: -- :ref:`float` **get_clip_offset** **(** **)** const +- :ref:`float` **get_clip_offset** **(** **)** |const| Returns the distance the camera has been offset due to a collision. @@ -187,7 +187,7 @@ Returns the distance the camera has been offset due to a collision. .. _class_ClippedCamera_method_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns ``true`` if the specified bit index is on. @@ -219,3 +219,6 @@ Sets the specified bit index to the ``value``. **Note:** Bit indices range from 0-19. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 08e09cc02..d2043bf98 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -32,41 +32,41 @@ Properties Methods ------- -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** |virtual| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** |const| | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -131,7 +131,7 @@ Method Descriptions .. _class_CollisionObject_method__input_event: -- void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual +- void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** |virtual| Accepts unhandled :ref:`InputEvent`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events. @@ -147,7 +147,7 @@ Creates a new shape owner for the given object. Returns ``owner_id`` of the new .. _class_CollisionObject_method_get_rid: -- :ref:`RID` **get_rid** **(** **)** const +- :ref:`RID` **get_rid** **(** **)** |const| Returns the object's :ref:`RID`. @@ -163,7 +163,7 @@ Returns an :ref:`Array` of ``owner_id`` identifiers. You can use th .. _class_CollisionObject_method_is_shape_owner_disabled: -- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const +- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** |const| If ``true``, the shape owner and its shapes are disabled. @@ -179,7 +179,7 @@ Removes the given shape owner. .. _class_CollisionObject_method_shape_find_owner: -- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const +- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** |const| Returns the ``owner_id`` of the given shape. @@ -203,7 +203,7 @@ Removes all shapes from the shape owner. .. _class_CollisionObject_method_shape_owner_get_owner: -- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const +- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** |const| Returns the parent object of the given shape owner. @@ -211,7 +211,7 @@ Returns the parent object of the given shape owner. .. _class_CollisionObject_method_shape_owner_get_shape: -- :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| Returns the :ref:`Shape` with the given id from the given shape owner. @@ -219,7 +219,7 @@ Returns the :ref:`Shape` with the given id from the given shape own .. _class_CollisionObject_method_shape_owner_get_shape_count: -- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const +- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** |const| Returns the number of shapes the given shape owner contains. @@ -227,7 +227,7 @@ Returns the number of shapes the given shape owner contains. .. _class_CollisionObject_method_shape_owner_get_shape_index: -- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| Returns the child index of the :ref:`Shape` with the given id from the given shape owner. @@ -235,7 +235,7 @@ Returns the child index of the :ref:`Shape` with the given id from .. _class_CollisionObject_method_shape_owner_get_transform: -- :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const +- :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** |const| Returns the shape owner's :ref:`Transform`. @@ -263,3 +263,6 @@ If ``true``, disables the given shape owner. Sets the :ref:`Transform` of the given shape owner. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index f0b84ab40..971a34d25 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -30,49 +30,49 @@ Properties Methods ------- -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shape_owner_one_way_collision_margin` **(** :ref:`int` owner_id **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_one_way_collision` **(** :ref:`int` owner_id, :ref:`bool` enable **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_one_way_collision_margin` **(** :ref:`int` owner_id, :ref:`float` margin **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** |virtual| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_shape_owner_one_way_collision_margin` **(** :ref:`int` owner_id **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** |const| | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_one_way_collision` **(** :ref:`int` owner_id, :ref:`bool` enable **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_one_way_collision_margin` **(** :ref:`int` owner_id, :ref:`float` margin **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -121,7 +121,7 @@ Method Descriptions .. _class_CollisionObject2D_method__input_event: -- void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual +- void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** |virtual| Accepts unhandled :ref:`InputEvent`\ s. Requires :ref:`input_pickable` to be ``true``. ``shape_idx`` is the child index of the clicked :ref:`Shape2D`. Connect to the ``input_event`` signal to easily pick up these events. @@ -137,7 +137,7 @@ Creates a new shape owner for the given object. Returns ``owner_id`` of the new .. _class_CollisionObject2D_method_get_rid: -- :ref:`RID` **get_rid** **(** **)** const +- :ref:`RID` **get_rid** **(** **)** |const| Returns the object's :ref:`RID`. @@ -145,7 +145,7 @@ Returns the object's :ref:`RID`. .. _class_CollisionObject2D_method_get_shape_owner_one_way_collision_margin: -- :ref:`float` **get_shape_owner_one_way_collision_margin** **(** :ref:`int` owner_id **)** const +- :ref:`float` **get_shape_owner_one_way_collision_margin** **(** :ref:`int` owner_id **)** |const| Returns the ``one_way_collision_margin`` of the shape owner identified by given ``owner_id``. @@ -161,7 +161,7 @@ Returns an :ref:`Array` of ``owner_id`` identifiers. You can use th .. _class_CollisionObject2D_method_is_shape_owner_disabled: -- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const +- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** |const| If ``true``, the shape owner and its shapes are disabled. @@ -169,7 +169,7 @@ If ``true``, the shape owner and its shapes are disabled. .. _class_CollisionObject2D_method_is_shape_owner_one_way_collision_enabled: -- :ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** const +- :ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** |const| Returns ``true`` if collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. @@ -185,7 +185,7 @@ Removes the given shape owner. .. _class_CollisionObject2D_method_shape_find_owner: -- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const +- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** |const| Returns the ``owner_id`` of the given shape. @@ -209,7 +209,7 @@ Removes all shapes from the shape owner. .. _class_CollisionObject2D_method_shape_owner_get_owner: -- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const +- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** |const| Returns the parent object of the given shape owner. @@ -217,7 +217,7 @@ Returns the parent object of the given shape owner. .. _class_CollisionObject2D_method_shape_owner_get_shape: -- :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| Returns the :ref:`Shape2D` with the given id from the given shape owner. @@ -225,7 +225,7 @@ Returns the :ref:`Shape2D` with the given id from the given shape .. _class_CollisionObject2D_method_shape_owner_get_shape_count: -- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const +- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** |const| Returns the number of shapes the given shape owner contains. @@ -233,7 +233,7 @@ Returns the number of shapes the given shape owner contains. .. _class_CollisionObject2D_method_shape_owner_get_shape_index: -- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| Returns the child index of the :ref:`Shape2D` with the given id from the given shape owner. @@ -241,7 +241,7 @@ Returns the child index of the :ref:`Shape2D` with the given id f .. _class_CollisionObject2D_method_shape_owner_get_transform: -- :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const +- :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** |const| Returns the shape owner's :ref:`Transform2D`. @@ -285,3 +285,6 @@ Sets the ``one_way_collision_margin`` of the shape owner identified by given ``o Sets the :ref:`Transform2D` of the given shape owner. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 932a5e7d5..51178d2ce 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -80,3 +80,6 @@ Array of vertices which define the polygon. **Note:** The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the ``polygon`` member. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 802069b6f..853cb04a1 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -129,3 +129,6 @@ The margin used for one-way collision (in pixels). Higher values will make the s The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the :ref:`PoolVector2Array`, not a reference. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 845696652..3f33e2ec0 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -89,3 +89,6 @@ 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. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 0b6cc1530..e0d5f2839 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -51,7 +51,7 @@ Property Descriptions | *Getter* | is_disabled() | +-----------+---------------------+ -A disabled collision shape has no effect in the world. +A disabled collision shape has no effect in the world. This property should be changed with :ref:`Object.set_deferred`. ---- @@ -99,3 +99,6 @@ The margin used for one-way collision (in pixels). Higher values will make the s The actual shape owned by this collision shape. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_color.rst b/classes/class_color.rst index b7aaf4f70..9105e4b33 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -1070,3 +1070,6 @@ Returns the color's 64-bit integer in RGBA format (each word represents a compon var c = Color(1, 0.5, 0.2) print(c.to_rgba64()) # Prints -140736629309441 +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index ba305cbf9..5ef38730e 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -45,7 +45,7 @@ Methods +---------------------------------------------+--------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_preset` **(** :ref:`Color` color **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`get_presets` **(** **)** const | +| :ref:`PoolColorArray` | :ref:`get_presets` **(** **)** |const| | +---------------------------------------------+--------------------------------------------------------------------------------------------------------+ Theme Properties @@ -240,7 +240,10 @@ Removes the given color from the list of color presets of this color picker. .. _class_ColorPicker_method_get_presets: -- :ref:`PoolColorArray` **get_presets** **(** **)** const +- :ref:`PoolColorArray` **get_presets** **(** **)** |const| Returns the list of colors in the presets of the color picker. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index e4b9a2bf3..088f59d4f 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -142,3 +142,6 @@ Returns the :ref:`ColorPicker` that this node toggles. Returns the control's :ref:`PopupPanel` which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 3f858016b..925c0e7ee 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -46,3 +46,6 @@ The fill color. $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index 87a153001..69eeb16b7 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -24,7 +24,7 @@ Methods ------- +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** |const| | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_faces` **(** :ref:`PoolVector3Array` faces **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ @@ -34,7 +34,7 @@ Method Descriptions .. _class_ConcavePolygonShape_method_get_faces: -- :ref:`PoolVector3Array` **get_faces** **(** **)** const +- :ref:`PoolVector3Array` **get_faces** **(** **)** |const| Returns the faces (an array of triangles). @@ -46,3 +46,6 @@ Returns the faces (an array of triangles). Sets the faces (an array of triangles). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 4b59d5a05..37998f384 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -44,3 +44,6 @@ Property Descriptions The array of points that make up the ``ConcavePolygonShape2D``'s line segments. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index dc895133e..3376fdfac 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -41,7 +41,7 @@ Methods ------- +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** const | +| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -175,7 +175,7 @@ Method Descriptions .. _class_ConeTwistJoint_method_get_param: -- :ref:`float` **get_param** **(** :ref:`Param` param **)** const +- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| ---- @@ -183,3 +183,6 @@ Method Descriptions - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 5787da75a..8e15c7e50 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -49,37 +49,37 @@ ConfigFiles can also contain manually written comment lines starting with a semi Methods ------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_section` **(** :ref:`String` section **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_section_key` **(** :ref:`String` section, :ref:`String` key **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_sections` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_encrypted` **(** :ref:`String` path, :ref:`PoolByteArray` key **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_encrypted_pass` **(** :ref:`String` path, :ref:`String` password **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`parse` **(** :ref:`String` data **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save` **(** :ref:`String` path **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_encrypted` **(** :ref:`String` path, :ref:`PoolByteArray` key **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_encrypted_pass` **(** :ref:`String` path, :ref:`String` password **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_section` **(** :ref:`String` section **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_section_key` **(** :ref:`String` section, :ref:`String` key **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_sections` **(** **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_encrypted` **(** :ref:`String` path, :ref:`PoolByteArray` key **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_encrypted_pass` **(** :ref:`String` path, :ref:`String` password **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`parse` **(** :ref:`String` data **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save` **(** :ref:`String` path **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_encrypted` **(** :ref:`String` path, :ref:`PoolByteArray` key **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_encrypted_pass` **(** :ref:`String` path, :ref:`String` password **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -102,7 +102,7 @@ Deletes the specified key in a section. Raises an error if either the section or .. _class_ConfigFile_method_get_section_keys: -- :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** const +- :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** |const| Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist. @@ -110,7 +110,7 @@ Returns an array of all defined key identifiers in the specified section. Raises .. _class_ConfigFile_method_get_sections: -- :ref:`PoolStringArray` **get_sections** **(** **)** const +- :ref:`PoolStringArray` **get_sections** **(** **)** |const| Returns an array of all defined section identifiers. @@ -118,7 +118,7 @@ Returns an array of all defined section identifiers. .. _class_ConfigFile_method_get_value: -- :ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const +- :ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** |const| Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback ``default`` value. If ``default`` is not specified or set to ``null``, an error is also raised. @@ -126,7 +126,7 @@ Returns the current value for the specified section and key. If either the secti .. _class_ConfigFile_method_has_section: -- :ref:`bool` **has_section** **(** :ref:`String` section **)** const +- :ref:`bool` **has_section** **(** :ref:`String` section **)** |const| Returns ``true`` if the specified section exists. @@ -134,7 +134,7 @@ Returns ``true`` if the specified section exists. .. _class_ConfigFile_method_has_section_key: -- :ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** const +- :ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** |const| Returns ``true`` if the specified section-key pair exists. @@ -216,3 +216,6 @@ Returns one of the :ref:`Error` code constants (``OK`` Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 597f48023..a4227f9b6 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -51,3 +51,6 @@ Method Descriptions Returns the cancel button. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_container.rst b/classes/class_container.rst index e0110e2f5..8463982c7 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -64,3 +64,6 @@ Fit a child control in a given rect. This is mainly a helper for creating custom Queue resort of the contained children. This is called automatically anyway, but can be called upon request. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_control.rst b/classes/class_control.rst index f054399aa..fbbd22f40 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -32,6 +32,8 @@ Sets :ref:`mouse_filter` to :ref:`MOUSE_FIL :ref:`Theme` resources change the Control's appearance. If you change the :ref:`Theme` on a ``Control`` node, it affects all of its children. To override some of the theme's parameters, call one of the ``add_*_override`` methods, like :ref:`add_font_override`. You can override the theme with the inspector. +**Note:** Theme items are *not* :ref:`Object` properties. This means you can't access their values using :ref:`Object.get` and :ref:`Object.set`. Instead, use :ref:`get_color`, :ref:`get_constant`, :ref:`get_font`, :ref:`get_icon`, :ref:`get_stylebox`, and the ``add_*_override`` methods provided by this class. + Tutorials --------- @@ -112,13 +114,13 @@ Methods ------- +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_clips_input` **(** **)** virtual | +| :ref:`bool` | :ref:`_clips_input` **(** **)** |virtual| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | +| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** |virtual| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | +| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** |virtual| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`_make_custom_tooltip` **(** :ref:`String` for_text **)** virtual | +| :ref:`Object` | :ref:`_make_custom_tooltip` **(** :ref:`String` for_text **)** |virtual| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`accept_event` **(** **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -134,83 +136,83 @@ Methods +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_stylebox_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | +| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** |virtual| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | +| void | :ref:`drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** |virtual| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_anchor` **(** :ref:`Margin` margin **)** const | +| :ref:`float` | :ref:`get_anchor` **(** :ref:`Margin` margin **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | +| :ref:`Vector2` | :ref:`get_begin` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CursorShape` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const | +| :ref:`CursorShape` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** virtual | +| :ref:`Variant` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** |virtual| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_end` **(** **)** const | +| :ref:`Vector2` | :ref:`get_end` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_focus_neighbour` **(** :ref:`Margin` margin **)** const | +| :ref:`NodePath` | :ref:`get_focus_neighbour` **(** :ref:`Margin` margin **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | +| :ref:`Control` | :ref:`get_focus_owner` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`Margin` margin **)** const | +| :ref:`float` | :ref:`get_margin` **(** :ref:`Margin` margin **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | +| :ref:`Control` | :ref:`get_parent_control` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_rect` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | +| :ref:`float` | :ref:`get_rotation` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const | +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grab_click_focus` **(** **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grab_focus` **(** **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_focus` **(** **)** const | +| :ref:`bool` | :ref:`has_focus` **(** **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** |virtual| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_shader_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_shader_override` **(** :ref:`String` name **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** |const| | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`minimum_size_changed` **(** **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1140,7 +1142,7 @@ Method Descriptions .. _class_Control_method__clips_input: -- :ref:`bool` **_clips_input** **(** **)** virtual +- :ref:`bool` **_clips_input** **(** **)** |virtual| Virtual method to be implemented by the user. Returns whether :ref:`_gui_input` should not be called for children controls outside this control's rectangle. Input will be clipped to the Rect of this ``Control``. Similar to :ref:`rect_clip_content`, but doesn't affect visibility. @@ -1150,7 +1152,7 @@ If not overridden, defaults to ``false``. .. _class_Control_method__get_minimum_size: -- :ref:`Vector2` **_get_minimum_size** **(** **)** virtual +- :ref:`Vector2` **_get_minimum_size** **(** **)** |virtual| Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to :ref:`rect_min_size` for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately). @@ -1160,7 +1162,7 @@ If not overridden, defaults to :ref:`Vector2.ZERO`. .. _class_Control_method__gui_input: -- void **_gui_input** **(** :ref:`InputEvent` event **)** virtual +- void **_gui_input** **(** :ref:`InputEvent` event **)** |virtual| Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See :ref:`accept_event`. @@ -1189,7 +1191,7 @@ The event won't trigger if: .. _class_Control_method__make_custom_tooltip: -- :ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** virtual +- :ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** |virtual| Virtual method to be implemented by the user. Returns a ``Control`` node that should be used as a tooltip instead of the default one. Use ``for_text`` parameter to determine what text the tooltip should contain (likely the contents of :ref:`hint_tooltip`). @@ -1229,7 +1231,20 @@ Marks an input event as handled. Once you accept an input event, it stops propag - void **add_color_override** **(** :ref:`String` name, :ref:`Color` color **)** -Overrides the :ref:`Color` with given ``name`` in the :ref:`theme` resource the control uses. If the ``color`` is empty or invalid, the override is cleared and the color from assigned :ref:`Theme` is used. +Overrides the :ref:`Color` with given ``name`` in the :ref:`theme` resource the control uses. + +**Note:** Unlike other theme overrides, there is no way to undo a color override without manually assigning the previous color. + +**Example of overriding a label's color and resetting it later:** + +:: + + # Override the child node "MyLabel"'s font color to orange. + $MyLabel.add_color_override("font_color", Color(1, 0.5, 0)) + + # Reset the color by creating a new node to get the default value: + var default_label_color = Label.new().get_color("font_color") + $MyLabel.add_color_override("font_color", default_label_color) ---- @@ -1237,7 +1252,7 @@ Overrides the :ref:`Color` with given ``name`` in the :ref:`theme` name, :ref:`int` constant **)** -Overrides an integer constant with given ``name`` in the :ref:`theme` resource the control uses. If the ``constant`` is empty or invalid, the override is cleared and the constant from assigned :ref:`Theme` is used. +Overrides an integer constant with given ``name`` in the :ref:`theme` resource the control uses. If the ``constant`` is ``0``, the override is cleared and the constant from assigned :ref:`Theme` is used. ---- @@ -1245,7 +1260,7 @@ Overrides an integer constant with given ``name`` in the :ref:`theme` name, :ref:`Font` font **)** -Overrides the font with given ``name`` in the :ref:`theme` resource the control uses. If ``font`` is empty or invalid, the override is cleared and the font from assigned :ref:`Theme` is used. +Overrides the font with given ``name`` in the :ref:`theme` resource the control uses. If ``font`` is ``null`` or invalid, the override is cleared and the font from assigned :ref:`Theme` is used. ---- @@ -1253,7 +1268,7 @@ Overrides the font with given ``name`` in the :ref:`theme` name, :ref:`Texture` texture **)** -Overrides the icon with given ``name`` in the :ref:`theme` resource the control uses. If ``icon`` is empty or invalid, the override is cleared and the icon from assigned :ref:`Theme` is used. +Overrides the icon with given ``name`` in the :ref:`theme` resource the control uses. If ``icon`` is ``null`` or invalid, the override is cleared and the icon from assigned :ref:`Theme` is used. ---- @@ -1261,7 +1276,7 @@ Overrides the icon with given ``name`` in the :ref:`theme` name, :ref:`Shader` shader **)** -Overrides the :ref:`Shader` with given ``name`` in the :ref:`theme` resource the control uses. If ``shader`` is empty or invalid, the override is cleared and the shader from assigned :ref:`Theme` is used. +Overrides the :ref:`Shader` with given ``name`` in the :ref:`theme` resource the control uses. If ``shader`` is ``null`` or invalid, the override is cleared and the shader from assigned :ref:`Theme` is used. ---- @@ -1271,11 +1286,26 @@ Overrides the :ref:`Shader` with given ``name`` in the :ref:`theme Overrides the :ref:`StyleBox` with given ``name`` in the :ref:`theme` resource the control uses. If ``stylebox`` is empty or invalid, the override is cleared and the :ref:`StyleBox` from assigned :ref:`Theme` is used. +**Example of modifying a property in a StyleBox by duplicating it:** + +:: + + # The snippet below assumes the child node MyButton has a StyleBoxFlat assigned. + # Resources are shared across instances, so we need to duplicate it + # to avoid modifying the appearance of all other buttons. + var new_stylebox_normal = $MyButton.get_stylebox("normal").duplicate() + new_stylebox_normal.border_width_top = 3 + new_stylebox_normal.border_color = Color(0, 1, 0.5) + $MyButton.add_stylebox_override("normal", new_stylebox_normal) + + # Remove the stylebox override: + $MyButton.add_stylebox_override("normal", null) + ---- .. _class_Control_method_can_drop_data: -- :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual +- :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** |virtual| Godot calls this method to test if ``data`` from a control's :ref:`get_drag_data` can be dropped at ``position``. ``position`` is local to this control. @@ -1292,7 +1322,7 @@ This method should only be used to test the data. Process the data in :ref:`drop .. _class_Control_method_drop_data: -- void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual +- void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** |virtual| Godot calls this method to pass you the ``data`` from a control's :ref:`get_drag_data` result. Godot first calls :ref:`can_drop_data` to test if ``data`` is allowed to drop at ``position`` where ``position`` is local to this control. @@ -1318,7 +1348,7 @@ The methods :ref:`can_drop_data` and :ref:`d .. _class_Control_method_get_anchor: -- :ref:`float` **get_anchor** **(** :ref:`Margin` margin **)** const +- :ref:`float` **get_anchor** **(** :ref:`Margin` margin **)** |const| Returns the anchor identified by ``margin`` constant from :ref:`Margin` enum. A getter method for :ref:`anchor_bottom`, :ref:`anchor_left`, :ref:`anchor_right` and :ref:`anchor_top`. @@ -1326,7 +1356,7 @@ Returns the anchor identified by ``margin`` constant from :ref:`Margin` **get_begin** **(** **)** const +- :ref:`Vector2` **get_begin** **(** **)** |const| Returns :ref:`margin_left` and :ref:`margin_top`. See also :ref:`rect_position`. @@ -1334,7 +1364,7 @@ Returns :ref:`margin_left` and :ref:`margin_ .. _class_Control_method_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns a color from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1347,7 +1377,7 @@ Returns a color from assigned :ref:`Theme` with given ``name`` and .. _class_Control_method_get_combined_minimum_size: -- :ref:`Vector2` **get_combined_minimum_size** **(** **)** const +- :ref:`Vector2` **get_combined_minimum_size** **(** **)** |const| Returns combined minimum size from :ref:`rect_min_size` and :ref:`get_minimum_size`. @@ -1355,7 +1385,7 @@ Returns combined minimum size from :ref:`rect_min_size` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns a constant from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1363,7 +1393,7 @@ Returns a constant from assigned :ref:`Theme` with given ``name`` a .. _class_Control_method_get_cursor_shape: -- :ref:`CursorShape` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const +- :ref:`CursorShape` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** |const| Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape`. @@ -1371,7 +1401,7 @@ Returns the mouse cursor shape the control displays on mouse hover. See :ref:`Cu .. _class_Control_method_get_drag_data: -- :ref:`Variant` **get_drag_data** **(** :ref:`Vector2` position **)** virtual +- :ref:`Variant` **get_drag_data** **(** :ref:`Vector2` position **)** |virtual| Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns ``null`` if there is no data to drag. Controls that want to receive drop data should implement :ref:`can_drop_data` and :ref:`drop_data`. ``position`` is local to this control. Drag may be forced with :ref:`force_drag`. @@ -1388,7 +1418,7 @@ A preview that will follow the mouse that should represent the data can be set w .. _class_Control_method_get_end: -- :ref:`Vector2` **get_end** **(** **)** const +- :ref:`Vector2` **get_end** **(** **)** |const| Returns :ref:`margin_right` and :ref:`margin_bottom`. @@ -1396,7 +1426,7 @@ Returns :ref:`margin_right` and :ref:`margi .. _class_Control_method_get_focus_neighbour: -- :ref:`NodePath` **get_focus_neighbour** **(** :ref:`Margin` margin **)** const +- :ref:`NodePath` **get_focus_neighbour** **(** :ref:`Margin` margin **)** |const| Returns the focus neighbour identified by ``margin`` constant from :ref:`Margin` enum. A getter method for :ref:`focus_neighbour_bottom`, :ref:`focus_neighbour_left`, :ref:`focus_neighbour_right` and :ref:`focus_neighbour_top`. @@ -1404,7 +1434,7 @@ Returns the focus neighbour identified by ``margin`` constant from :ref:`Margin< .. _class_Control_method_get_focus_owner: -- :ref:`Control` **get_focus_owner** **(** **)** const +- :ref:`Control` **get_focus_owner** **(** **)** |const| Returns the control that has the keyboard focus or ``null`` if none. @@ -1412,7 +1442,7 @@ Returns the control that has the keyboard focus or ``null`` if none. .. _class_Control_method_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns a font from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1420,7 +1450,7 @@ Returns a font from assigned :ref:`Theme` with given ``name`` and a .. _class_Control_method_get_global_rect: -- :ref:`Rect2` **get_global_rect** **(** **)** const +- :ref:`Rect2` **get_global_rect** **(** **)** |const| Returns the position and size of the control relative to the top-left corner of the screen. See :ref:`rect_position` and :ref:`rect_size`. @@ -1428,7 +1458,7 @@ Returns the position and size of the control relative to the top-left corner of .. _class_Control_method_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns an icon from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1436,7 +1466,7 @@ Returns an icon from assigned :ref:`Theme` with given ``name`` and .. _class_Control_method_get_margin: -- :ref:`float` **get_margin** **(** :ref:`Margin` margin **)** const +- :ref:`float` **get_margin** **(** :ref:`Margin` margin **)** |const| Returns the anchor identified by ``margin`` constant from :ref:`Margin` enum. A getter method for :ref:`margin_bottom`, :ref:`margin_left`, :ref:`margin_right` and :ref:`margin_top`. @@ -1444,7 +1474,7 @@ Returns the anchor identified by ``margin`` constant from :ref:`Margin` **get_minimum_size** **(** **)** const +- :ref:`Vector2` **get_minimum_size** **(** **)** |const| Returns the minimum size for this control. See :ref:`rect_min_size`. @@ -1452,7 +1482,7 @@ Returns the minimum size for this control. See :ref:`rect_min_size` **get_parent_area_size** **(** **)** const +- :ref:`Vector2` **get_parent_area_size** **(** **)** |const| Returns the width/height occupied in the parent control. @@ -1460,7 +1490,7 @@ Returns the width/height occupied in the parent control. .. _class_Control_method_get_parent_control: -- :ref:`Control` **get_parent_control** **(** **)** const +- :ref:`Control` **get_parent_control** **(** **)** |const| Returns the parent control node. @@ -1468,7 +1498,7 @@ Returns the parent control node. .. _class_Control_method_get_rect: -- :ref:`Rect2` **get_rect** **(** **)** const +- :ref:`Rect2` **get_rect** **(** **)** |const| Returns the position and size of the control relative to the top-left corner of the parent Control. See :ref:`rect_position` and :ref:`rect_size`. @@ -1476,7 +1506,7 @@ Returns the position and size of the control relative to the top-left corner of .. _class_Control_method_get_rotation: -- :ref:`float` **get_rotation** **(** **)** const +- :ref:`float` **get_rotation** **(** **)** |const| Returns the rotation (in radians). @@ -1484,7 +1514,7 @@ Returns the rotation (in radians). .. _class_Control_method_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns a :ref:`StyleBox` from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1492,7 +1522,7 @@ Returns a :ref:`StyleBox` from assigned :ref:`Theme .. _class_Control_method_get_tooltip: -- :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const +- :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** |const| Returns the tooltip, which will appear when the cursor is resting over this control. See :ref:`hint_tooltip`. @@ -1521,7 +1551,7 @@ Steal the focus from another control and become the focused control (see :ref:`f .. _class_Control_method_has_color: -- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns ``true`` if :ref:`Color` with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1529,7 +1559,7 @@ Returns ``true`` if :ref:`Color` with given ``name`` and associated .. _class_Control_method_has_color_override: -- :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_color_override** **(** :ref:`String` name **)** |const| Returns ``true`` if :ref:`Color` with given ``name`` has a valid override in this ``Control`` node. @@ -1537,7 +1567,7 @@ Returns ``true`` if :ref:`Color` with given ``name`` has a valid ov .. _class_Control_method_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns ``true`` if constant with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1545,7 +1575,7 @@ Returns ``true`` if constant with given ``name`` and associated with ``Control`` .. _class_Control_method_has_constant_override: -- :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** |const| Returns ``true`` if constant with given ``name`` has a valid override in this ``Control`` node. @@ -1553,7 +1583,7 @@ Returns ``true`` if constant with given ``name`` has a valid override in this `` .. _class_Control_method_has_focus: -- :ref:`bool` **has_focus** **(** **)** const +- :ref:`bool` **has_focus** **(** **)** |const| Returns ``true`` if this is the current focused control. See :ref:`focus_mode`. @@ -1561,7 +1591,7 @@ Returns ``true`` if this is the current focused control. See :ref:`focus_mode` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns ``true`` if font with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1569,7 +1599,7 @@ Returns ``true`` if font with given ``name`` and associated with ``Control`` of .. _class_Control_method_has_font_override: -- :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_font_override** **(** :ref:`String` name **)** |const| Returns ``true`` if font with given ``name`` has a valid override in this ``Control`` node. @@ -1577,7 +1607,7 @@ Returns ``true`` if font with given ``name`` has a valid override in this ``Cont .. _class_Control_method_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns ``true`` if icon with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1585,7 +1615,7 @@ Returns ``true`` if icon with given ``name`` and associated with ``Control`` of .. _class_Control_method_has_icon_override: -- :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** |const| Returns ``true`` if icon with given ``name`` has a valid override in this ``Control`` node. @@ -1593,7 +1623,7 @@ Returns ``true`` if icon with given ``name`` has a valid override in this ``Cont .. _class_Control_method_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual +- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** |virtual| Virtual method to be implemented by the user. Returns whether the given ``point`` is inside this control. @@ -1605,7 +1635,7 @@ If not overridden, default behavior is checking if the point is within control's .. _class_Control_method_has_shader_override: -- :ref:`bool` **has_shader_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_shader_override** **(** :ref:`String` name **)** |const| Returns ``true`` if :ref:`Shader` with given ``name`` has a valid override in this ``Control`` node. @@ -1613,7 +1643,7 @@ Returns ``true`` if :ref:`Shader` with given ``name`` has a valid .. _class_Control_method_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** |const| Returns ``true`` if :ref:`StyleBox` with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1621,7 +1651,7 @@ Returns ``true`` if :ref:`StyleBox` with given ``name`` and asso .. _class_Control_method_has_stylebox_override: -- :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** |const| Returns ``true`` if :ref:`StyleBox` with given ``name`` has a valid override in this ``Control`` node. @@ -1832,3 +1862,6 @@ If ``exclusive`` is ``true``, other controls will not receive input and clicking Moves the mouse cursor to ``to_position``, relative to :ref:`rect_position` of this ``Control``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 5301093a0..6be949045 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -42,3 +42,6 @@ Property Descriptions The list of 3D points forming the convex polygon shape. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 8cdcba319..cb3c14ddd 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -60,3 +60,6 @@ Method Descriptions Based on the set of points provided, this creates and assigns the :ref:`points` property using the convex hull algorithm. Removing all unneeded points. See :ref:`Geometry.convex_hull_2d` for details. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index 5a59ab007..ff79ab71c 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -159,13 +159,13 @@ Methods +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`Parameter` param **)** const | +| :ref:`float` | :ref:`get_param` **(** :ref:`Parameter` param **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`get_param_curve` **(** :ref:`Parameter` param **)** const | +| :ref:`Curve` | :ref:`get_param_curve` **(** :ref:`Parameter` param **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`Parameter` param **)** const | +| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`Parameter` param **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_particle_flag` **(** :ref:`Flags` flag **)** const | +| :ref:`bool` | :ref:`get_particle_flag` **(** :ref:`Flags` flag **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`restart` **(** **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1311,7 +1311,7 @@ Sets this node's properties to match a given :ref:`Particles` n .. _class_CPUParticles_method_get_param: -- :ref:`float` **get_param** **(** :ref:`Parameter` param **)** const +- :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Returns the base value of the parameter specified by :ref:`Parameter`. @@ -1319,7 +1319,7 @@ Returns the base value of the parameter specified by :ref:`Parameter` **get_param_curve** **(** :ref:`Parameter` param **)** const +- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| Returns the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1327,7 +1327,7 @@ Returns the :ref:`Curve` of the parameter specified by :ref:`Parame .. _class_CPUParticles_method_get_param_randomness: -- :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** const +- :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Returns the randomness factor of the parameter specified by :ref:`Parameter`. @@ -1335,7 +1335,7 @@ Returns the randomness factor of the parameter specified by :ref:`Parameter` **get_particle_flag** **(** :ref:`Flags` flag **)** const +- :ref:`bool` **get_particle_flag** **(** :ref:`Flags` flag **)** |const| Returns the enabled state of the given flag (see :ref:`Flags` for options). @@ -1379,3 +1379,6 @@ Sets the randomness factor of the parameter specified by :ref:`Parameter` for options). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index b1aa4958d..9fe372458 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -160,13 +160,13 @@ Methods +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`Parameter` param **)** const | +| :ref:`float` | :ref:`get_param` **(** :ref:`Parameter` param **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`get_param_curve` **(** :ref:`Parameter` param **)** const | +| :ref:`Curve` | :ref:`get_param_curve` **(** :ref:`Parameter` param **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`Parameter` param **)** const | +| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`Parameter` param **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_particle_flag` **(** :ref:`Flags` flag **)** const | +| :ref:`bool` | :ref:`get_particle_flag` **(** :ref:`Flags` flag **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`restart` **(** **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1274,7 +1274,7 @@ Sets this node's properties to match a given :ref:`Particles2D` **get_param** **(** :ref:`Parameter` param **)** const +- :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Returns the base value of the parameter specified by :ref:`Parameter`. @@ -1282,7 +1282,7 @@ Returns the base value of the parameter specified by :ref:`Parameter` **get_param_curve** **(** :ref:`Parameter` param **)** const +- :ref:`Curve` **get_param_curve** **(** :ref:`Parameter` param **)** |const| Returns the :ref:`Curve` of the parameter specified by :ref:`Parameter`. @@ -1290,7 +1290,7 @@ Returns the :ref:`Curve` of the parameter specified by :ref:`Parame .. _class_CPUParticles2D_method_get_param_randomness: -- :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** const +- :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Returns the randomness factor of the parameter specified by :ref:`Parameter`. @@ -1298,7 +1298,7 @@ Returns the randomness factor of the parameter specified by :ref:`Parameter` **get_particle_flag** **(** :ref:`Flags` flag **)** const +- :ref:`bool` **get_particle_flag** **(** :ref:`Flags` flag **)** |const| Returns the enabled state of the given flag (see :ref:`Flags` for options). @@ -1342,3 +1342,6 @@ Sets the randomness factor of the parameter specified by :ref:`Parameter` for options). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_crypto.rst b/classes/class_crypto.rst index 8d7053e8b..cad706e65 100644 --- a/classes/class_crypto.rst +++ b/classes/class_crypto.rst @@ -85,3 +85,6 @@ A small example to generate an RSA key and a X509 self-signed certificate. # Generate self-signed certificate using the given key. var cert = crypto.generate_self_signed_certificate(key, "CN=example.com,O=A Game Company,C=IT") +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_cryptokey.rst b/classes/class_cryptokey.rst index a45ca8801..ba97ac08f 100644 --- a/classes/class_cryptokey.rst +++ b/classes/class_cryptokey.rst @@ -48,3 +48,6 @@ Loads a key from ``path`` ("\*.key" file). Saves a key to the given ``path`` (should be a "\*.key" file). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index ffb14c596..8db6a98d0 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -94,3 +94,6 @@ The material used to render the box. Width of the box measured from the center of the box. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csgcombiner.rst b/classes/class_csgcombiner.rst index 740d8691d..fddb7e01a 100644 --- a/classes/class_csgcombiner.rst +++ b/classes/class_csgcombiner.rst @@ -18,3 +18,6 @@ Description For complex arrangements of shapes, it is sometimes needed to add structure to your CSG nodes. The CSGCombiner node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way, it is possible to do operations on one set of shapes that are children of one CSGCombiner node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner node, and then do an operation that takes the two end results as its input to create the final shape. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index 974aa7207..071dba09d 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -130,3 +130,6 @@ The number of sides of the cylinder, the higher this number the more detail ther If ``true`` the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If ``false`` the cylinder will have a flat shaded look. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index 0828a8b27..4f72ce108 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -56,3 +56,6 @@ The :ref:`Material` used in drawing the CSG shape. The :ref:`Mesh` resource to use as a CSG shape. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index c8ed54440..4ae3eaa2f 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -277,3 +277,6 @@ Degrees to rotate our extrusion for each slice when :ref:`mode` is :ref:`MODE_SPIN`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index 6c66f495a..32fff6b33 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -44,3 +44,6 @@ Property Descriptions Invert the faces of the mesh. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index 75019fb66..5116ca1c0 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -41,13 +41,13 @@ Methods ------- +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_meshes` **(** **)** const | +| :ref:`Array` | :ref:`get_meshes` **(** **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_root_shape` **(** **)** const | +| :ref:`bool` | :ref:`is_root_shape` **(** **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -108,7 +108,7 @@ The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. -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. +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. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -124,7 +124,7 @@ A contact is detected if object A is in any of the layers that object B scans, o | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The physics layers this CSG shape scans for collisions. +The physics layers this CSG shape scans for collisions. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -179,7 +179,7 @@ Method Descriptions .. _class_CSGShape_method_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the collision mask. @@ -187,7 +187,7 @@ Returns an individual bit on the collision mask. .. _class_CSGShape_method_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the collision mask. @@ -195,7 +195,7 @@ Returns an individual bit on the collision mask. .. _class_CSGShape_method_get_meshes: -- :ref:`Array` **get_meshes** **(** **)** const +- :ref:`Array` **get_meshes** **(** **)** |const| Returns an :ref:`Array` with two elements, the first is the :ref:`Transform` of this node and the second is the root :ref:`Mesh` of this node. Only works when this node is the root shape. @@ -203,7 +203,7 @@ Returns an :ref:`Array` with two elements, the first is the :ref:`T .. _class_CSGShape_method_is_root_shape: -- :ref:`bool` **is_root_shape** **(** **)** const +- :ref:`bool` **is_root_shape** **(** **)** |const| Returns ``true`` if this is a root shape and is thus the object that is rendered. @@ -223,3 +223,6 @@ Sets individual bits on the layer mask. Use this if you only need to change one Sets individual bits on the collision mask. Use this if you only need to change one layer's value. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index a4c482394..5f7c000cd 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -112,3 +112,6 @@ Number of horizontal slices for the sphere. If ``true`` the normals of the sphere are set to give a smooth effect making the sphere seem rounded. If ``false`` the sphere will have a flat shaded look. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index 46ed153ac..6a9ce56fe 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -130,3 +130,6 @@ The number of slices the torus is constructed of. If ``true`` the normals of the torus are set to give a smooth effect making the torus seem rounded. If ``false`` the torus will have a flat shaded look. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index d64b6574c..8ad8aca14 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -28,16 +28,19 @@ Tutorials Methods ------- -+-----------------------------+------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** ... **)** vararg | -+-----------------------------+------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** ... **)** |vararg| | ++-----------------------------+--------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_CSharpScript_method_new: -- :ref:`Object` **new** **(** ... **)** vararg +- :ref:`Object` **new** **(** ... **)** |vararg| Returns a new instance of the script. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 61c7a7935..bb14f3cbc 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -33,11 +33,11 @@ Methods ------- +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | +| :ref:`int` | :ref:`get_height` **(** **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_side` **(** :ref:`Side` side **)** const | +| :ref:`Image` | :ref:`get_side` **(** :ref:`Side` side **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | +| :ref:`int` | :ref:`get_width` **(** **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_side` **(** :ref:`Side` side, :ref:`Image` image **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ @@ -167,7 +167,7 @@ Method Descriptions .. _class_CubeMap_method_get_height: -- :ref:`int` **get_height** **(** **)** const +- :ref:`int` **get_height** **(** **)** |const| Returns the ``CubeMap``'s height. @@ -175,7 +175,7 @@ Returns the ``CubeMap``'s height. .. _class_CubeMap_method_get_side: -- :ref:`Image` **get_side** **(** :ref:`Side` side **)** const +- :ref:`Image` **get_side** **(** :ref:`Side` side **)** |const| Returns an :ref:`Image` for a side of the ``CubeMap`` using one of the :ref:`Side` constants. @@ -183,7 +183,7 @@ Returns an :ref:`Image` for a side of the ``CubeMap`` using one of .. _class_CubeMap_method_get_width: -- :ref:`int` **get_width** **(** **)** const +- :ref:`int` **get_width** **(** **)** |const| Returns the ``CubeMap``'s width. @@ -195,3 +195,6 @@ Returns the ``CubeMap``'s width. Sets an :ref:`Image` for a side of the ``CubeMap`` using one of the :ref:`Side` constants. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index 1c17e6131..bcfea0e69 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -98,3 +98,6 @@ Number of extra edge loops inserted along the Y axis. Number of extra edge loops inserted along the X axis. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 2637061b2..c5d59c1f7 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -41,19 +41,19 @@ Methods +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | +| :ref:`int` | :ref:`get_point_count` **(** **)** |const| | +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TangentMode` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | +| :ref:`TangentMode` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** |const| | +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | +| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** |const| | +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` index **)** const | +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` index **)** |const| | +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TangentMode` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | +| :ref:`TangentMode` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** |const| | +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | +| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** |const| | +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | +| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** |const| | +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | +--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -186,7 +186,7 @@ Removes all points from the curve. .. _class_Curve_method_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** |const| Returns the number of points describing the curve. @@ -194,7 +194,7 @@ Returns the number of points describing the curve. .. _class_Curve_method_get_point_left_mode: -- :ref:`TangentMode` **get_point_left_mode** **(** :ref:`int` index **)** const +- :ref:`TangentMode` **get_point_left_mode** **(** :ref:`int` index **)** |const| Returns the left :ref:`TangentMode` for the point at ``index``. @@ -202,7 +202,7 @@ Returns the left :ref:`TangentMode` for the point at ``i .. _class_Curve_method_get_point_left_tangent: -- :ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** const +- :ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** |const| Returns the left tangent angle (in degrees) for the point at ``index``. @@ -210,7 +210,7 @@ Returns the left tangent angle (in degrees) for the point at ``index``. .. _class_Curve_method_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** |const| Returns the curve coordinates for the point at ``index``. @@ -218,7 +218,7 @@ Returns the curve coordinates for the point at ``index``. .. _class_Curve_method_get_point_right_mode: -- :ref:`TangentMode` **get_point_right_mode** **(** :ref:`int` index **)** const +- :ref:`TangentMode` **get_point_right_mode** **(** :ref:`int` index **)** |const| Returns the right :ref:`TangentMode` for the point at ``index``. @@ -226,7 +226,7 @@ Returns the right :ref:`TangentMode` for the point at `` .. _class_Curve_method_get_point_right_tangent: -- :ref:`float` **get_point_right_tangent** **(** :ref:`int` index **)** const +- :ref:`float` **get_point_right_tangent** **(** :ref:`int` index **)** |const| Returns the right tangent angle (in degrees) for the point at ``index``. @@ -234,7 +234,7 @@ Returns the right tangent angle (in degrees) for the point at ``index``. .. _class_Curve_method_interpolate: -- :ref:`float` **interpolate** **(** :ref:`float` offset **)** const +- :ref:`float` **interpolate** **(** :ref:`float` offset **)** |const| Returns the Y value for the point that would exist at the X position ``offset`` along the curve. @@ -302,3 +302,6 @@ Sets the right tangent angle for the point at ``index`` to ``tangent``. Assigns the vertical position ``y`` to the point at ``index``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index efbe49930..65bd4ac0d 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -35,27 +35,27 @@ Methods +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | +| :ref:`float` | :ref:`get_baked_length` **(** **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | +| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector2` to_point **)** const | +| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector2` to_point **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** const | +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | +| :ref:`int` | :ref:`get_point_count` **(** **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | +| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | +| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | +| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` idx **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -65,7 +65,7 @@ Methods +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector2` position **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | +| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions @@ -108,7 +108,7 @@ Removes all points from the curve. .. _class_Curve2D_method_get_baked_length: -- :ref:`float` **get_baked_length** **(** **)** const +- :ref:`float` **get_baked_length** **(** **)** |const| Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. @@ -116,7 +116,7 @@ Returns the total length of the curve, based on the cached points. Given enough .. _class_Curve2D_method_get_baked_points: -- :ref:`PoolVector2Array` **get_baked_points** **(** **)** const +- :ref:`PoolVector2Array` **get_baked_points** **(** **)** |const| Returns the cache of points as a :ref:`PoolVector2Array`. @@ -124,7 +124,7 @@ Returns the cache of points as a :ref:`PoolVector2Array` .. _class_Curve2D_method_get_closest_offset: -- :ref:`float` **get_closest_offset** **(** :ref:`Vector2` to_point **)** const +- :ref:`float` **get_closest_offset** **(** :ref:`Vector2` to_point **)** |const| Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`interpolate_baked`. @@ -134,7 +134,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : .. _class_Curve2D_method_get_closest_point: -- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** const +- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** |const| Returns the closest point (in curve's local space) to ``to_point``. @@ -144,7 +144,7 @@ Returns the closest point (in curve's local space) to ``to_point``. .. _class_Curve2D_method_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** |const| Returns the number of points describing the curve. @@ -152,7 +152,7 @@ Returns the number of points describing the curve. .. _class_Curve2D_method_get_point_in: -- :ref:`Vector2` **get_point_in** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_in** **(** :ref:`int` idx **)** |const| Returns the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. @@ -160,7 +160,7 @@ Returns the position of the control point leading to the vertex ``idx``. If the .. _class_Curve2D_method_get_point_out: -- :ref:`Vector2` **get_point_out** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_out** **(** :ref:`int` idx **)** |const| Returns the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. @@ -168,7 +168,7 @@ Returns the position of the control point leading out of the vertex ``idx``. If .. _class_Curve2D_method_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` idx **)** |const| Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0)``. @@ -176,7 +176,7 @@ Returns the position of the vertex ``idx``. If the index is out of bounds, the f .. _class_Curve2D_method_interpolate: -- :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const +- :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** |const| Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, where ``t`` controls if the point is the first vertex (``t = 0.0``), the last vertex (``t = 1.0``), or in between. Values of ``t`` outside the range (``0.0 >= t <=1``) give strange, but predictable results. @@ -186,7 +186,7 @@ If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t .. _class_Curve2D_method_interpolate_baked: -- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const +- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** |const| Returns a point within the curve at position ``offset``, where ``offset`` is measured as a pixel distance along the curve. @@ -198,7 +198,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. _class_Curve2D_method_interpolatef: -- :ref:`Vector2` **interpolatef** **(** :ref:`float` fofs **)** const +- :ref:`Vector2` **interpolatef** **(** :ref:`float` fofs **)** |const| Returns the position at the vertex ``fofs``. It calls :ref:`interpolate` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. @@ -238,7 +238,7 @@ Sets the position for the vertex ``idx``. If the index is out of bounds, the fun .. _class_Curve2D_method_tessellate: -- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** |const| Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. @@ -248,3 +248,6 @@ This approximation makes straight segments between each point, then subdivides t ``tolerance_degrees`` controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 27db98d1d..32fbf61ae 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -37,35 +37,35 @@ Methods +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | +| :ref:`float` | :ref:`get_baked_length` **(** **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | +| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | +| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_up_vectors` **(** **)** const | +| :ref:`PoolVector3Array` | :ref:`get_baked_up_vectors` **(** **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector3` to_point **)** const | +| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector3` to_point **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** const | +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | +| :ref:`int` | :ref:`get_point_count` **(** **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | +| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | +| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | +| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked_up_vector` **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const | +| :ref:`Vector3` | :ref:`interpolate_baked_up_vector` **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | +| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` idx **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,7 +77,7 @@ Methods +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | +| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions @@ -136,7 +136,7 @@ Removes all points from the curve. .. _class_Curve3D_method_get_baked_length: -- :ref:`float` **get_baked_length** **(** **)** const +- :ref:`float` **get_baked_length** **(** **)** |const| Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. @@ -144,7 +144,7 @@ Returns the total length of the curve, based on the cached points. Given enough .. _class_Curve3D_method_get_baked_points: -- :ref:`PoolVector3Array` **get_baked_points** **(** **)** const +- :ref:`PoolVector3Array` **get_baked_points** **(** **)** |const| Returns the cache of points as a :ref:`PoolVector3Array`. @@ -152,7 +152,7 @@ Returns the cache of points as a :ref:`PoolVector3Array` .. _class_Curve3D_method_get_baked_tilts: -- :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const +- :ref:`PoolRealArray` **get_baked_tilts** **(** **)** |const| Returns the cache of tilts as a :ref:`PoolRealArray`. @@ -160,7 +160,7 @@ Returns the cache of tilts as a :ref:`PoolRealArray`. .. _class_Curve3D_method_get_baked_up_vectors: -- :ref:`PoolVector3Array` **get_baked_up_vectors** **(** **)** const +- :ref:`PoolVector3Array` **get_baked_up_vectors** **(** **)** |const| Returns the cache of up vectors as a :ref:`PoolVector3Array`. @@ -170,7 +170,7 @@ If :ref:`up_vector_enabled` is ``false .. _class_Curve3D_method_get_closest_offset: -- :ref:`float` **get_closest_offset** **(** :ref:`Vector3` to_point **)** const +- :ref:`float` **get_closest_offset** **(** :ref:`Vector3` to_point **)** |const| Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`interpolate_baked` or :ref:`interpolate_baked_up_vector`. @@ -180,7 +180,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : .. _class_Curve3D_method_get_closest_point: -- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** const +- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** |const| Returns the closest point (in curve's local space) to ``to_point``. @@ -190,7 +190,7 @@ Returns the closest point (in curve's local space) to ``to_point``. .. _class_Curve3D_method_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** |const| Returns the number of points describing the curve. @@ -198,7 +198,7 @@ Returns the number of points describing the curve. .. _class_Curve3D_method_get_point_in: -- :ref:`Vector3` **get_point_in** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_in** **(** :ref:`int` idx **)** |const| Returns the position of the control point leading to the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. @@ -206,7 +206,7 @@ Returns the position of the control point leading to the vertex ``idx``. If the .. _class_Curve3D_method_get_point_out: -- :ref:`Vector3` **get_point_out** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_out** **(** :ref:`int` idx **)** |const| Returns the position of the control point leading out of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. @@ -214,7 +214,7 @@ Returns the position of the control point leading out of the vertex ``idx``. If .. _class_Curve3D_method_get_point_position: -- :ref:`Vector3` **get_point_position** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_position** **(** :ref:`int` idx **)** |const| Returns the position of the vertex ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``(0, 0, 0)``. @@ -222,7 +222,7 @@ Returns the position of the vertex ``idx``. If the index is out of bounds, the f .. _class_Curve3D_method_get_point_tilt: -- :ref:`float` **get_point_tilt** **(** :ref:`int` idx **)** const +- :ref:`float` **get_point_tilt** **(** :ref:`int` idx **)** |const| Returns the tilt angle in radians for the point ``idx``. If the index is out of bounds, the function sends an error to the console, and returns ``0``. @@ -230,7 +230,7 @@ Returns the tilt angle in radians for the point ``idx``. If the index is out of .. _class_Curve3D_method_interpolate: -- :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const +- :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** |const| Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, where ``t`` controls if the point is the first vertex (``t = 0.0``), the last vertex (``t = 1.0``), or in between. Values of ``t`` outside the range (``0.0 >= t <=1``) give strange, but predictable results. @@ -240,7 +240,7 @@ If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t .. _class_Curve3D_method_interpolate_baked: -- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const +- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** |const| Returns a point within the curve at position ``offset``, where ``offset`` is measured as a pixel distance along the curve. @@ -252,7 +252,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. _class_Curve3D_method_interpolate_baked_up_vector: -- :ref:`Vector3` **interpolate_baked_up_vector** **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const +- :ref:`Vector3` **interpolate_baked_up_vector** **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** |const| Returns an up vector within the curve at position ``offset``, where ``offset`` is measured as a distance in 3D units along the curve. @@ -264,7 +264,7 @@ If the curve has no up vectors, the function sends an error to the console, and .. _class_Curve3D_method_interpolatef: -- :ref:`Vector3` **interpolatef** **(** :ref:`float` fofs **)** const +- :ref:`Vector3` **interpolatef** **(** :ref:`float` fofs **)** |const| Returns the position at the vertex ``fofs``. It calls :ref:`interpolate` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. @@ -314,7 +314,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa .. _class_Curve3D_method_tessellate: -- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** |const| Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. @@ -324,3 +324,6 @@ This approximation makes straight segments between each point, then subdivides t ``tolerance_degrees`` controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index fbdcaef43..9e86d1c37 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -58,3 +58,6 @@ The ``curve`` rendered onto the texture. The width of the texture. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 3bceb7007..953f82b0c 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -114,3 +114,6 @@ Number of edge rings along the height of the cylinder. Top radius of the cylinder. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_cylindershape.rst b/classes/class_cylindershape.rst index 2521b0a03..0ab8acc78 100644 --- a/classes/class_cylindershape.rst +++ b/classes/class_cylindershape.rst @@ -60,3 +60,6 @@ The cylinder's height. The cylinder's radius. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index f562be376..1ccd132d8 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -96,3 +96,6 @@ When the bodies attached to the spring joint move they stretch or squash it. The The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 1a740d4b2..2b5eb48bc 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -240,3 +240,6 @@ Returns the size of the dictionary (in pairs). Returns the list of values in the ``Dictionary``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index c170683b2..49c402117 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -226,3 +226,6 @@ The distance from shadow split 1 to split 2. Relative to :ref:`directional_shado The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is ``SHADOW_PARALLEL_4_SPLITS``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 67a0cd760..90d257c5f 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -51,7 +51,7 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`current_is_dir` **(** **)** const | +| :ref:`bool` | :ref:`current_is_dir` **(** **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -109,7 +109,7 @@ Returns one of the :ref:`Error` code constants (``OK`` .. _class_Directory_method_current_is_dir: -- :ref:`bool` **current_is_dir** **(** **)** const +- :ref:`bool` **current_is_dir** **(** **)** |const| Returns whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). @@ -249,3 +249,6 @@ Renames (move) the ``from`` file to the ``to`` destination. Both arguments shoul Returns one of the :ref:`Error` code constants (``OK`` on success). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_dtlsserver.rst b/classes/class_dtlsserver.rst index 3a9cbb267..1bb082408 100644 --- a/classes/class_dtlsserver.rst +++ b/classes/class_dtlsserver.rst @@ -101,3 +101,6 @@ Try to initiate the DTLS handshake with the given ``udp_peer`` which must be alr **Note**: You must check that the state of the return PacketPeerUDP is :ref:`PacketPeerDTLS.STATUS_HANDSHAKING`, as it is normal that 50% of the new connections will be invalid due to cookie exchange. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index de62d9230..ccdc337d3 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -16,7 +16,7 @@ DynamicFont renders vector font files at runtime. Description ----------- -DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like :ref:`BitmapFont`. This trades the faster loading time of :ref:`BitmapFont`\ s for the ability to change font parameters like size and spacing during runtime. :ref:`DynamicFontData` is used for referencing the font file paths. DynamicFont also supports defining one or more fallbacks fonts, which will be used when displaying a character not supported by the main font. +DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like :ref:`BitmapFont`. This trades the faster loading time of :ref:`BitmapFont`\ s for the ability to change font parameters like size and spacing during runtime. :ref:`DynamicFontData` is used for referencing the font file paths. DynamicFont also supports defining one or more fallback fonts, which will be used when displaying a character not supported by the main font. DynamicFont uses the `FreeType `_ library for rasterization. @@ -27,7 +27,7 @@ DynamicFont uses the `FreeType `_ library for rasteri dynamic_font.size = 64 $"Label".set("custom_fonts/font", dynamic_font) -**Note:** DynamicFont doesn't support features such as right-to-left typesetting, ligatures, text shaping, variable fonts and optional font features yet. If you wish to "bake" an optional font feature into a TTF font file, you can use `FontForge `_ to do so. In FontForge, use **File > Generate Fonts**, click **Options**, choose the desired features then generate the font. +**Note:** DynamicFont doesn't support features such as kerning, right-to-left typesetting, ligatures, text shaping, variable fonts and optional font features yet. If you wish to "bake" an optional font feature into a TTF font file, you can use `FontForge `_ to do so. In FontForge, use **File > Generate Fonts**, click **Options**, choose the desired features then generate the font. Properties ---------- @@ -60,13 +60,13 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_fallback` **(** :ref:`DynamicFontData` data **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_available_chars` **(** **)** const | +| :ref:`String` | :ref:`get_available_chars` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`DynamicFontData` | :ref:`get_fallback` **(** :ref:`int` idx **)** const | +| :ref:`DynamicFontData` | :ref:`get_fallback` **(** :ref:`int` idx **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fallback_count` **(** **)** const | +| :ref:`int` | :ref:`get_fallback_count` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_spacing` **(** :ref:`int` type **)** const | +| :ref:`int` | :ref:`get_spacing` **(** :ref:`int` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_fallback` **(** :ref:`int` idx **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -272,7 +272,7 @@ Adds a fallback font. .. _class_DynamicFont_method_get_available_chars: -- :ref:`String` **get_available_chars** **(** **)** const +- :ref:`String` **get_available_chars** **(** **)** |const| Returns a string containing all the characters available in the main and all the fallback fonts. @@ -282,7 +282,7 @@ If a given character is included in more than one font, it appears only once in .. _class_DynamicFont_method_get_fallback: -- :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** const +- :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** |const| Returns the fallback font at index ``idx``. @@ -290,7 +290,7 @@ Returns the fallback font at index ``idx``. .. _class_DynamicFont_method_get_fallback_count: -- :ref:`int` **get_fallback_count** **(** **)** const +- :ref:`int` **get_fallback_count** **(** **)** |const| Returns the number of fallback fonts. @@ -298,7 +298,7 @@ Returns the number of fallback fonts. .. _class_DynamicFont_method_get_spacing: -- :ref:`int` **get_spacing** **(** :ref:`int` type **)** const +- :ref:`int` **get_spacing** **(** :ref:`int` type **)** |const| Returns the spacing for the given ``type`` (see :ref:`SpacingType`). @@ -326,3 +326,6 @@ Sets the fallback font at index ``idx``. Sets the spacing for ``type`` (see :ref:`SpacingType`) to ``value`` in pixels (not relative to the font size). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index 66f7f65a7..a372ad3a6 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -97,3 +97,6 @@ The path to the vector font file. The font hinting mode used by FreeType. See :ref:`Hinting` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 0995331ca..fbe5b2fb0 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -16,38 +16,40 @@ A script that is executed when exporting projects. Methods ------- -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_end` **(** **)** 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_ios_project_static_lib` **(** :ref:`String` path **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skip` **(** **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** |virtual| | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_end` **(** **)** |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_embedded_framework` **(** :ref:`String` path **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_ios_project_static_lib` **(** :ref:`String` path **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skip` **(** **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_EditorExportPlugin_method__export_begin: -- void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual +- void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** |virtual| Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. @@ -55,7 +57,7 @@ Virtual method to be overridden by the user. It is called when the export starts .. _class_EditorExportPlugin_method__export_end: -- void **_export_end** **(** **)** virtual +- void **_export_end** **(** **)** |virtual| Virtual method to be overridden by the user. Called when the export is finished. @@ -63,7 +65,7 @@ Virtual method to be overridden by the user. Called when the export is finished. .. _class_EditorExportPlugin_method__export_file: -- void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual +- void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** |virtual| ---- @@ -85,10 +87,24 @@ Virtual method to be overridden by the user. Called when the export is finished. ---- +.. _class_EditorExportPlugin_method_add_ios_embedded_framework: + +- void **add_ios_embedded_framework** **(** :ref:`String` path **)** + +Adds a dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary. + +**Note:** For static libraries (\*.a) works in same way as :ref:`add_ios_framework`. + +This method should not be used for System libraries as they are already present on the device. + +---- + .. _class_EditorExportPlugin_method_add_ios_framework: - void **add_ios_framework** **(** :ref:`String` path **)** +Adds a static library (\*.a) or dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project. + ---- .. _class_EditorExportPlugin_method_add_ios_linker_flags: @@ -119,3 +135,6 @@ Virtual method to be overridden by the user. Called when the export is finished. - void **skip** **(** **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorfeatureprofile.rst b/classes/class_editorfeatureprofile.rst index 905ce27eb..747a11b2e 100644 --- a/classes/class_editorfeatureprofile.rst +++ b/classes/class_editorfeatureprofile.rst @@ -26,13 +26,13 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_feature_name` **(** :ref:`Feature` feature **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_disabled` **(** :ref:`String` class_name **)** const | +| :ref:`bool` | :ref:`is_class_disabled` **(** :ref:`String` class_name **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_editor_disabled` **(** :ref:`String` class_name **)** const | +| :ref:`bool` | :ref:`is_class_editor_disabled` **(** :ref:`String` class_name **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_property_disabled` **(** :ref:`String` class_name, :ref:`String` property **)** const | +| :ref:`bool` | :ref:`is_class_property_disabled` **(** :ref:`String` class_name, :ref:`String` property **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_feature_disabled` **(** :ref:`Feature` feature **)** const | +| :ref:`bool` | :ref:`is_feature_disabled` **(** :ref:`Feature` feature **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_from_file` **(** :ref:`String` path **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -99,7 +99,7 @@ Returns the specified ``feature``'s human-readable name. .. _class_EditorFeatureProfile_method_is_class_disabled: -- :ref:`bool` **is_class_disabled** **(** :ref:`String` class_name **)** const +- :ref:`bool` **is_class_disabled** **(** :ref:`String` class_name **)** |const| Returns ``true`` if the class specified by ``class_name`` is disabled. When disabled, the class won't appear in the Create New Node dialog. @@ -107,7 +107,7 @@ Returns ``true`` if the class specified by ``class_name`` is disabled. When disa .. _class_EditorFeatureProfile_method_is_class_editor_disabled: -- :ref:`bool` **is_class_editor_disabled** **(** :ref:`String` class_name **)** const +- :ref:`bool` **is_class_editor_disabled** **(** :ref:`String` class_name **)** |const| Returns ``true`` if editing for the class specified by ``class_name`` is disabled. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class. @@ -115,7 +115,7 @@ Returns ``true`` if editing for the class specified by ``class_name`` is disable .. _class_EditorFeatureProfile_method_is_class_property_disabled: -- :ref:`bool` **is_class_property_disabled** **(** :ref:`String` class_name, :ref:`String` property **)** const +- :ref:`bool` **is_class_property_disabled** **(** :ref:`String` class_name, :ref:`String` property **)** |const| Returns ``true`` if ``property`` is disabled in the class specified by ``class_name``. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by ``class_name``. @@ -123,7 +123,7 @@ Returns ``true`` if ``property`` is disabled in the class specified by ``class_n .. _class_EditorFeatureProfile_method_is_feature_disabled: -- :ref:`bool` **is_feature_disabled** **(** :ref:`Feature` feature **)** const +- :ref:`bool` **is_feature_disabled** **(** :ref:`Feature` feature **)** |const| Returns ``true`` if the ``feature`` is disabled. When a feature is disabled, it will disappear from the editor entirely. @@ -175,3 +175,6 @@ If ``disable`` is ``true``, disables editing for ``property`` in the class speci If ``disable`` is ``true``, disables the editor feature specified in ``feature``. When a feature is disabled, it will disappear from the editor entirely. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index f45451370..21ce46618 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -301,3 +301,6 @@ Returns the ``VBoxContainer`` used to display the file system. Notify the ``EditorFileDialog`` that its view of the data is no longer accurate. Updates the view contents on next view update. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 081efadf9..fb540f94d 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -24,15 +24,15 @@ Methods ------- +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem` **(** **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem_path` **(** :ref:`String` path **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_scanning_progress` **(** **)** const | +| :ref:`float` | :ref:`get_scanning_progress` **(** **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scanning` **(** **)** const | +| :ref:`bool` | :ref:`is_scanning` **(** **)** |const| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scan` **(** **)** | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ @@ -81,7 +81,7 @@ Method Descriptions .. _class_EditorFileSystem_method_get_file_type: -- :ref:`String` **get_file_type** **(** :ref:`String` path **)** const +- :ref:`String` **get_file_type** **(** :ref:`String` path **)** |const| Gets the type of the file, given the full path. @@ -105,7 +105,7 @@ Returns a view into the filesystem at ``path``. .. _class_EditorFileSystem_method_get_scanning_progress: -- :ref:`float` **get_scanning_progress** **(** **)** const +- :ref:`float` **get_scanning_progress** **(** **)** |const| Returns the scan progress for 0 to 1 if the FS is being scanned. @@ -113,7 +113,7 @@ Returns the scan progress for 0 to 1 if the FS is being scanned. .. _class_EditorFileSystem_method_is_scanning: -- :ref:`bool` **is_scanning** **(** **)** const +- :ref:`bool` **is_scanning** **(** **)** |const| Returns ``true`` of the filesystem is being scanned. @@ -149,3 +149,6 @@ Update a file information. Call this if an external program (not Godot) modified Scans the script files and updates the list of custom class names. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index f4aa03dd4..d5b4287e6 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -21,42 +21,42 @@ A more generalized, low-level variation of the directory concept. Methods ------- -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_file_count` **(** **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_script_class_extends` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_script_class_name` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdir_count` **(** **)** const | -+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_file_count` **(** **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_script_class_extends` **(** :ref:`int` idx **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_script_class_name` **(** :ref:`int` idx **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdir_count` **(** **)** |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_EditorFileSystemDirectory_method_find_dir_index: -- :ref:`int` **find_dir_index** **(** :ref:`String` name **)** const +- :ref:`int` **find_dir_index** **(** :ref:`String` name **)** |const| Returns the index of the directory with name ``name`` or ``-1`` if not found. @@ -64,7 +64,7 @@ Returns the index of the directory with name ``name`` or ``-1`` if not found. .. _class_EditorFileSystemDirectory_method_find_file_index: -- :ref:`int` **find_file_index** **(** :ref:`String` name **)** const +- :ref:`int` **find_file_index** **(** :ref:`String` name **)** |const| Returns the index of the file with name ``name`` or ``-1`` if not found. @@ -72,7 +72,7 @@ Returns the index of the file with name ``name`` or ``-1`` if not found. .. _class_EditorFileSystemDirectory_method_get_file: -- :ref:`String` **get_file** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file** **(** :ref:`int` idx **)** |const| Returns the name of the file at index ``idx``. @@ -80,7 +80,7 @@ Returns the name of the file at index ``idx``. .. _class_EditorFileSystemDirectory_method_get_file_count: -- :ref:`int` **get_file_count** **(** **)** const +- :ref:`int` **get_file_count** **(** **)** |const| Returns the number of files in this directory. @@ -88,7 +88,7 @@ Returns the number of files in this directory. .. _class_EditorFileSystemDirectory_method_get_file_import_is_valid: -- :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** const +- :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** |const| Returns ``true`` if the file at index ``idx`` imported properly. @@ -96,7 +96,7 @@ Returns ``true`` if the file at index ``idx`` imported properly. .. _class_EditorFileSystemDirectory_method_get_file_path: -- :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_path** **(** :ref:`int` idx **)** |const| Returns the path to the file at index ``idx``. @@ -104,7 +104,7 @@ Returns the path to the file at index ``idx``. .. _class_EditorFileSystemDirectory_method_get_file_script_class_extends: -- :ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** |const| Returns the base class of the script class defined in the file at index ``idx``. If the file doesn't define a script class using the ``class_name`` syntax, this will return an empty string. @@ -112,7 +112,7 @@ Returns the base class of the script class defined in the file at index ``idx``. .. _class_EditorFileSystemDirectory_method_get_file_script_class_name: -- :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** |const| Returns the name of the script class defined in the file at index ``idx``. If the file doesn't define a script class using the ``class_name`` syntax, this will return an empty string. @@ -120,7 +120,7 @@ Returns the name of the script class defined in the file at index ``idx``. If th .. _class_EditorFileSystemDirectory_method_get_file_type: -- :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_type** **(** :ref:`int` idx **)** |const| Returns the file extension of the file at index ``idx``. @@ -144,7 +144,7 @@ Returns the parent directory for this directory or ``null`` if called on a direc .. _class_EditorFileSystemDirectory_method_get_path: -- :ref:`String` **get_path** **(** **)** const +- :ref:`String` **get_path** **(** **)** |const| Returns the path to this directory. @@ -160,7 +160,10 @@ Returns the subdirectory at index ``idx``. .. _class_EditorFileSystemDirectory_method_get_subdir_count: -- :ref:`int` **get_subdir_count** **(** **)** const +- :ref:`int` **get_subdir_count** **(** **)** |const| Returns the number of subdirectories in this directory. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 7ef7d8f98..2688ba86f 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -71,38 +71,38 @@ Tutorials Methods ------- -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_import_order` **(** **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_importer_name` **(** **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_preset_count` **(** **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_priority` **(** **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resource_type` **(** **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_save_extension` **(** **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_visible_name` **(** **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` platform_variants, :ref:`Array` gen_files **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_import_order` **(** **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_importer_name` **(** **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_preset_count` **(** **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_priority` **(** **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resource_type` **(** **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_save_extension` **(** **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_visible_name` **(** **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` platform_variants, :ref:`Array` gen_files **)** |virtual| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_EditorImportPlugin_method_get_import_options: -- :ref:`Array` **get_import_options** **(** :ref:`int` preset **)** virtual +- :ref:`Array` **get_import_options** **(** :ref:`int` preset **)** |virtual| Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: ``name``, ``default_value``, ``property_hint`` (optional), ``hint_string`` (optional), ``usage`` (optional). @@ -110,7 +110,7 @@ Gets the options and default values for the preset at this index. Returns an Arr .. _class_EditorImportPlugin_method_get_import_order: -- :ref:`int` **get_import_order** **(** **)** virtual +- :ref:`int` **get_import_order** **(** **)** |virtual| Gets the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. @@ -118,7 +118,7 @@ Gets the order of this importer to be run when importing resources. Higher value .. _class_EditorImportPlugin_method_get_importer_name: -- :ref:`String` **get_importer_name** **(** **)** virtual +- :ref:`String` **get_importer_name** **(** **)** |virtual| Gets the unique name of the importer. @@ -126,7 +126,7 @@ Gets the unique name of the importer. .. _class_EditorImportPlugin_method_get_option_visibility: -- :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual +- :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** |virtual| This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example: @@ -145,7 +145,7 @@ Return ``true`` to make all options always visible. .. _class_EditorImportPlugin_method_get_preset_count: -- :ref:`int` **get_preset_count** **(** **)** virtual +- :ref:`int` **get_preset_count** **(** **)** |virtual| Gets the number of initial presets defined by the plugin. Use :ref:`get_import_options` to get the default options for the preset and :ref:`get_preset_name` to get the name of the preset. @@ -153,7 +153,7 @@ Gets the number of initial presets defined by the plugin. Use :ref:`get_import_o .. _class_EditorImportPlugin_method_get_preset_name: -- :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual +- :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** |virtual| Gets the name of the options preset at this index. @@ -161,7 +161,7 @@ Gets the name of the options preset at this index. .. _class_EditorImportPlugin_method_get_priority: -- :ref:`float` **get_priority** **(** **)** virtual +- :ref:`float` **get_priority** **(** **)** |virtual| Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is ``1.0``. @@ -169,7 +169,7 @@ Gets the priority of this plugin for the recognized extension. Higher priority p .. _class_EditorImportPlugin_method_get_recognized_extensions: -- :ref:`Array` **get_recognized_extensions** **(** **)** virtual +- :ref:`Array` **get_recognized_extensions** **(** **)** |virtual| Gets the list of file extensions to associate with this loader (case-insensitive). e.g. ``["obj"]``. @@ -177,7 +177,7 @@ Gets the list of file extensions to associate with this loader (case-insensitive .. _class_EditorImportPlugin_method_get_resource_type: -- :ref:`String` **get_resource_type** **(** **)** virtual +- :ref:`String` **get_resource_type** **(** **)** |virtual| Gets the Godot resource type associated with this loader. e.g. ``"Mesh"`` or ``"Animation"``. @@ -185,7 +185,7 @@ Gets the Godot resource type associated with this loader. e.g. ``"Mesh"`` or ``" .. _class_EditorImportPlugin_method_get_save_extension: -- :ref:`String` **get_save_extension** **(** **)** virtual +- :ref:`String` **get_save_extension** **(** **)** |virtual| Gets the extension used to save this resource in the ``.import`` directory. @@ -193,7 +193,7 @@ Gets the extension used to save this resource in the ``.import`` directory. .. _class_EditorImportPlugin_method_get_visible_name: -- :ref:`String` **get_visible_name** **(** **)** virtual +- :ref:`String` **get_visible_name** **(** **)** |virtual| Gets the name to display in the import window. @@ -201,9 +201,12 @@ Gets the name to display in the import window. .. _class_EditorImportPlugin_method_import: -- :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` platform_variants, :ref:`Array` gen_files **)** virtual +- :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` platform_variants, :ref:`Array` gen_files **)** |virtual| Imports ``source_file`` into ``save_path`` with the import ``options`` specified. The ``platform_variants`` and ``gen_files`` arrays will be modified by this function. This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 5d130b570..6880dc6e4 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -104,3 +104,6 @@ Refreshes the inspector. **Note:** To save on CPU resources, calling this method will do nothing if the time specified in ``docks/property_editor/auto_refresh_interval`` editor setting hasn't passed yet since this method was last called. (By default, this interval is set to 0.3 seconds.) +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index c9d8ed2e8..9ac1570ee 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -33,23 +33,23 @@ On each of these calls, the "add" functions can be called. Methods ------- -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_control` **(** :ref:`Control` control **)** | -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_editor` **(** :ref:`String` property, :ref:`Control` editor **)** | -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_editor_for_multiple_properties` **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** | -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_handle` **(** :ref:`Object` object **)** virtual | -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_begin` **(** :ref:`Object` object **)** virtual | -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_category` **(** :ref:`Object` object, :ref:`String` category **)** virtual | -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_end` **(** **)** virtual | -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`parse_property` **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual | -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_control` **(** :ref:`Control` control **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_editor` **(** :ref:`String` property, :ref:`Control` editor **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_editor_for_multiple_properties` **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_handle` **(** :ref:`Object` object **)** |virtual| | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_begin` **(** :ref:`Object` object **)** |virtual| | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_category` **(** :ref:`Object` object, :ref:`String` category **)** |virtual| | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_end` **(** **)** |virtual| | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`parse_property` **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** |virtual| | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -80,7 +80,7 @@ Adds an editor that allows modifying multiple properties, this must inherit :ref .. _class_EditorInspectorPlugin_method_can_handle: -- :ref:`bool` **can_handle** **(** :ref:`Object` object **)** virtual +- :ref:`bool` **can_handle** **(** :ref:`Object` object **)** |virtual| Returns ``true`` if this object can be handled by this plugin. @@ -88,7 +88,7 @@ Returns ``true`` if this object can be handled by this plugin. .. _class_EditorInspectorPlugin_method_parse_begin: -- void **parse_begin** **(** :ref:`Object` object **)** virtual +- void **parse_begin** **(** :ref:`Object` object **)** |virtual| Called to allow adding controls at the beginning of the list. @@ -96,7 +96,7 @@ Called to allow adding controls at the beginning of the list. .. _class_EditorInspectorPlugin_method_parse_category: -- void **parse_category** **(** :ref:`Object` object, :ref:`String` category **)** virtual +- void **parse_category** **(** :ref:`Object` object, :ref:`String` category **)** |virtual| Called to allow adding controls at the beginning of the category. @@ -104,7 +104,7 @@ Called to allow adding controls at the beginning of the category. .. _class_EditorInspectorPlugin_method_parse_end: -- void **parse_end** **(** **)** virtual +- void **parse_end** **(** **)** |virtual| Called to allow adding controls at the end of the list. @@ -112,7 +112,10 @@ Called to allow adding controls at the end of the list. .. _class_EditorInspectorPlugin_method_parse_property: -- :ref:`bool` **parse_property** **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual +- :ref:`bool` **parse_property** **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** |virtual| Called to allow adding property specific editors to the inspector. Usually these inherit :ref:`EditorProperty`. Returning ``true`` removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 41bb19320..d4336994f 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -35,7 +35,7 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_base_control` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_path` **(** **)** const | +| :ref:`String` | :ref:`get_current_path` **(** **)** |const| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,11 +45,11 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`FileSystemDock` | :ref:`get_file_system_dock` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorInspector` | :ref:`get_inspector` **(** **)** const | +| :ref:`EditorInspector` | :ref:`get_inspector` **(** **)** |const| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | +| :ref:`Array` | :ref:`get_open_scenes` **(** **)** |const| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_playing_scene` **(** **)** const | +| :ref:`String` | :ref:`get_playing_scene` **(** **)** |const| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,15 +57,15 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selected_path` **(** **)** const | +| :ref:`String` | :ref:`get_selected_path` **(** **)** |const| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="" **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing_scene` **(** **)** const | +| :ref:`bool` | :ref:`is_playing_scene` **(** **)** |const| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_plugin_enabled` **(** :ref:`String` plugin **)** const | +| :ref:`bool` | :ref:`is_plugin_enabled` **(** :ref:`String` plugin **)** |const| | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` meshes, :ref:`int` preview_size **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -128,7 +128,7 @@ Returns the main container of Godot editor's window. For example, you can use it .. _class_EditorInterface_method_get_current_path: -- :ref:`String` **get_current_path** **(** **)** const +- :ref:`String` **get_current_path** **(** **)** |const| Returns the current path being viewed in the :ref:`FileSystemDock`. @@ -170,7 +170,7 @@ Returns the editor's :ref:`FileSystemDock` instance. .. _class_EditorInterface_method_get_inspector: -- :ref:`EditorInspector` **get_inspector** **(** **)** const +- :ref:`EditorInspector` **get_inspector** **(** **)** |const| Returns the editor's :ref:`EditorInspector` instance. @@ -178,7 +178,7 @@ Returns the editor's :ref:`EditorInspector` instance. .. _class_EditorInterface_method_get_open_scenes: -- :ref:`Array` **get_open_scenes** **(** **)** const +- :ref:`Array` **get_open_scenes** **(** **)** |const| Returns an :ref:`Array` with the file paths of the currently opened scenes. @@ -186,7 +186,7 @@ Returns an :ref:`Array` with the file paths of the currently opened .. _class_EditorInterface_method_get_playing_scene: -- :ref:`String` **get_playing_scene** **(** **)** const +- :ref:`String` **get_playing_scene** **(** **)** |const| Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string. @@ -218,7 +218,7 @@ Returns the editor's :ref:`ScriptEditor` instance. .. _class_EditorInterface_method_get_selected_path: -- :ref:`String` **get_selected_path** **(** **)** const +- :ref:`String` **get_selected_path** **(** **)** |const| Returns the path of the directory currently selected in the :ref:`FileSystemDock`. If a file is selected, its base directory will be returned using :ref:`String.get_base_dir` instead. @@ -242,7 +242,7 @@ Shows the given property on the given ``object`` in the editor's Inspector dock. .. _class_EditorInterface_method_is_playing_scene: -- :ref:`bool` **is_playing_scene** **(** **)** const +- :ref:`bool` **is_playing_scene** **(** **)** |const| Returns ``true`` if a scene is currently being played, ``false`` otherwise. Paused scenes are considered as being played. @@ -250,7 +250,7 @@ Returns ``true`` if a scene is currently being played, ``false`` otherwise. Paus .. _class_EditorInterface_method_is_plugin_enabled: -- :ref:`bool` **is_plugin_enabled** **(** :ref:`String` plugin **)** const +- :ref:`bool` **is_plugin_enabled** **(** :ref:`String` plugin **)** |const| Returns ``true`` if the specified ``plugin`` is enabled. The plugin name is the same as its directory name. @@ -350,3 +350,6 @@ Sets the enabled status of a plugin. The plugin name is the same as its director Stops the scene that is currently playing. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editornavigationmeshgenerator.rst b/classes/class_editornavigationmeshgenerator.rst index de28b01ce..3879802d8 100644 --- a/classes/class_editornavigationmeshgenerator.rst +++ b/classes/class_editornavigationmeshgenerator.rst @@ -35,3 +35,6 @@ Method Descriptions - void **clear** **(** :ref:`NavigationMesh` nav_mesh **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 9090c731c..862b3cc23 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -51,53 +51,53 @@ Methods +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_changes` **(** **)** virtual | +| void | :ref:`apply_changes` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`build` **(** **)** virtual | +| :ref:`bool` | :ref:`build` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** virtual | +| void | :ref:`clear` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disable_plugin` **(** **)** virtual | +| void | :ref:`disable_plugin` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | +| void | :ref:`edit` **(** :ref:`Object` object **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`enable_plugin` **(** **)** virtual | +| void | :ref:`enable_plugin` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`forward_canvas_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | +| void | :ref:`forward_canvas_draw_over_viewport` **(** :ref:`Control` overlay **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`forward_canvas_force_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | +| void | :ref:`forward_canvas_force_draw_over_viewport` **(** :ref:`Control` overlay **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`InputEvent` event **)** virtual | +| :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`InputEvent` event **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | +| :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | +| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_plugin_icon` **(** **)** virtual | +| :ref:`Texture` | :ref:`get_plugin_icon` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | +| :ref:`String` | :ref:`get_plugin_name` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ScriptCreateDialog` | :ref:`get_script_create_dialog` **(** **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | +| :ref:`Dictionary` | :ref:`get_state` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | +| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | +| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_main_screen` **(** **)** virtual | +| :ref:`bool` | :ref:`has_main_screen` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hide_bottom_panel` **(** **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_bottom_panel_item_visible` **(** :ref:`Control` item **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | +| void | :ref:`make_visible` **(** :ref:`bool` visible **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_save_layout` **(** **)** const | +| void | :ref:`queue_save_layout` **(** **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_autoload_singleton` **(** :ref:`String` name **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -121,17 +121,17 @@ Methods +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_tool_menu_item` **(** :ref:`String` name **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_external_data` **(** **)** virtual | +| void | :ref:`save_external_data` **(** **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_force_draw_over_forwarding_enabled` **(** **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_input_event_forwarding_always_enabled` **(** **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | +| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | +| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** |virtual| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`update_overlays` **(** **)** const | +| :ref:`int` | :ref:`update_overlays` **(** **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -367,7 +367,7 @@ Adds a custom submenu under **Project > Tools >** ``name``. ``submenu`` should b .. _class_EditorPlugin_method_apply_changes: -- void **apply_changes** **(** **)** virtual +- void **apply_changes** **(** **)** |virtual| This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. @@ -377,13 +377,13 @@ This is used, for example, in shader editors to let the plugin know that it must .. _class_EditorPlugin_method_build: -- :ref:`bool` **build** **(** **)** virtual +- :ref:`bool` **build** **(** **)** |virtual| ---- .. _class_EditorPlugin_method_clear: -- void **clear** **(** **)** virtual +- void **clear** **(** **)** |virtual| Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. @@ -391,7 +391,7 @@ Clear all the state and reset the object being edited to zero. This ensures your .. _class_EditorPlugin_method_disable_plugin: -- void **disable_plugin** **(** **)** virtual +- void **disable_plugin** **(** **)** |virtual| Called by the engine when the user disables the ``EditorPlugin`` in the Plugin tab of the project settings window. @@ -399,7 +399,7 @@ Called by the engine when the user disables the ``EditorPlugin`` in the Plugin t .. _class_EditorPlugin_method_edit: -- void **edit** **(** :ref:`Object` object **)** virtual +- void **edit** **(** :ref:`Object` object **)** |virtual| This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. @@ -407,7 +407,7 @@ This function is used for plugins that edit specific object types (nodes or reso .. _class_EditorPlugin_method_enable_plugin: -- void **enable_plugin** **(** **)** virtual +- void **enable_plugin** **(** **)** |virtual| Called by the engine when the user enables the ``EditorPlugin`` in the Plugin tab of the project settings window. @@ -415,19 +415,19 @@ Called by the engine when the user enables the ``EditorPlugin`` in the Plugin ta .. _class_EditorPlugin_method_forward_canvas_draw_over_viewport: -- void **forward_canvas_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual +- void **forward_canvas_draw_over_viewport** **(** :ref:`Control` overlay **)** |virtual| ---- .. _class_EditorPlugin_method_forward_canvas_force_draw_over_viewport: -- void **forward_canvas_force_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual +- void **forward_canvas_force_draw_over_viewport** **(** :ref:`Control` overlay **)** |virtual| ---- .. _class_EditorPlugin_method_forward_canvas_gui_input: -- :ref:`bool` **forward_canvas_gui_input** **(** :ref:`InputEvent` event **)** virtual +- :ref:`bool` **forward_canvas_gui_input** **(** :ref:`InputEvent` event **)** |virtual| Called when there is a root node in the current edited scene, :ref:`handles` is implemented and an :ref:`InputEvent` happens in the 2D viewport. Intercepts the :ref:`InputEvent`, if ``return true`` ``EditorPlugin`` consumes the ``event``, otherwise forwards ``event`` to other Editor classes. Example: @@ -453,7 +453,7 @@ Must ``return false`` in order to forward the :ref:`InputEvent .. _class_EditorPlugin_method_forward_spatial_gui_input: -- :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual +- :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** |virtual| Called when there is a root node in the current edited scene, :ref:`handles` is implemented and an :ref:`InputEvent` happens in the 3D viewport. Intercepts the :ref:`InputEvent`, if ``return true`` ``EditorPlugin`` consumes the ``event``, otherwise forwards ``event`` to other Editor classes. Example: @@ -479,7 +479,7 @@ Must ``return false`` in order to forward the :ref:`InputEvent .. _class_EditorPlugin_method_get_breakpoints: -- :ref:`PoolStringArray` **get_breakpoints** **(** **)** virtual +- :ref:`PoolStringArray` **get_breakpoints** **(** **)** |virtual| This is for editors that edit script-based objects. You can return a list of breakpoints in the format (``script:line``), for example: ``res://path_to_script.gd:25``. @@ -495,7 +495,7 @@ Returns the :ref:`EditorInterface` object that gives you .. _class_EditorPlugin_method_get_plugin_icon: -- :ref:`Texture` **get_plugin_icon** **(** **)** virtual +- :ref:`Texture` **get_plugin_icon** **(** **)** |virtual| Override this method in your plugin to return a :ref:`Texture` in order to give it an icon. @@ -515,7 +515,7 @@ Ideally, the plugin icon should be white with a transparent background and 16x16 .. _class_EditorPlugin_method_get_plugin_name: -- :ref:`String` **get_plugin_name** **(** **)** virtual +- :ref:`String` **get_plugin_name** **(** **)** |virtual| Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor. @@ -535,7 +535,7 @@ Gets the Editor's dialogue used for making scripts. .. _class_EditorPlugin_method_get_state: -- :ref:`Dictionary` **get_state** **(** **)** virtual +- :ref:`Dictionary` **get_state** **(** **)** |virtual| Gets the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). @@ -551,7 +551,7 @@ Gets the undo/redo object. Most actions in the editor can be undoable, so use th .. _class_EditorPlugin_method_get_window_layout: -- void **get_window_layout** **(** :ref:`ConfigFile` layout **)** virtual +- void **get_window_layout** **(** :ref:`ConfigFile` layout **)** |virtual| Gets the GUI layout of the plugin. This is used to save the project's editor layout when :ref:`queue_save_layout` is called or the editor layout was changed(For example changing the position of a dock). @@ -559,7 +559,7 @@ Gets the GUI layout of the plugin. This is used to save the project's editor lay .. _class_EditorPlugin_method_handles: -- :ref:`bool` **handles** **(** :ref:`Object` object **)** virtual +- :ref:`bool` **handles** **(** :ref:`Object` object **)** |virtual| Implement this function if your plugin edits a specific type of object (Resource or Node). If you return ``true``, then you will get the functions :ref:`edit` and :ref:`make_visible` called when the editor requests them. If you have declared the methods :ref:`forward_canvas_gui_input` and :ref:`forward_spatial_gui_input` these will be called too. @@ -567,7 +567,7 @@ Implement this function if your plugin edits a specific type of object (Resource .. _class_EditorPlugin_method_has_main_screen: -- :ref:`bool` **has_main_screen** **(** **)** virtual +- :ref:`bool` **has_main_screen** **(** **)** |virtual| Returns ``true`` if this is a main screen editor plugin (it goes in the workspace selector together with **2D**, **3D**, **Script** and **AssetLib**). @@ -587,7 +587,7 @@ Returns ``true`` if this is a main screen editor plugin (it goes in the workspac .. _class_EditorPlugin_method_make_visible: -- void **make_visible** **(** :ref:`bool` visible **)** virtual +- void **make_visible** **(** :ref:`bool` visible **)** |virtual| This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. @@ -597,7 +597,7 @@ Remember that you have to manage the visibility of all your editor controls manu .. _class_EditorPlugin_method_queue_save_layout: -- void **queue_save_layout** **(** **)** const +- void **queue_save_layout** **(** **)** |const| Queue save the project's editor layout. @@ -683,7 +683,7 @@ Removes a menu ``name`` from **Project > Tools**. .. _class_EditorPlugin_method_save_external_data: -- void **save_external_data** **(** **)** virtual +- void **save_external_data** **(** **)** |virtual| This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. @@ -705,7 +705,7 @@ Use this method if you always want to receive inputs from 3D view screen inside .. _class_EditorPlugin_method_set_state: -- void **set_state** **(** :ref:`Dictionary` state **)** virtual +- void **set_state** **(** :ref:`Dictionary` state **)** |virtual| Restore the state saved by :ref:`get_state`. @@ -713,7 +713,7 @@ Restore the state saved by :ref:`get_state` .. _class_EditorPlugin_method_set_window_layout: -- void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual +- void **set_window_layout** **(** :ref:`ConfigFile` layout **)** |virtual| Restore the plugin GUI layout saved by :ref:`get_window_layout`. @@ -721,7 +721,10 @@ Restore the plugin GUI layout saved by :ref:`get_window_layout` **update_overlays** **(** **)** const +- :ref:`int` **update_overlays** **(** **)** |const| Updates the overlays of the editor (2D/3D) viewport. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index bfe3942a1..8b9f99c4c 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -47,11 +47,11 @@ Methods +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_edited_property` **(** **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip_text` **(** **)** const | +| :ref:`String` | :ref:`get_tooltip_text` **(** **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bottom_editor` **(** :ref:`Control` editor **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_property` **(** **)** virtual | +| void | :ref:`update_property` **(** **)** |virtual| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -253,7 +253,7 @@ Gets the edited property. If your editor is for a single property (added via :re .. _class_EditorProperty_method_get_tooltip_text: -- :ref:`String` **get_tooltip_text** **(** **)** const +- :ref:`String` **get_tooltip_text** **(** **)** |const| Override if you want to allow a custom tooltip over your property. @@ -269,7 +269,10 @@ Adds controls with this function if you want them on the bottom (below the label .. _class_EditorProperty_method_update_property: -- void **update_property** **(** **)** virtual +- void **update_property** **(** **)** |virtual| When this virtual function is called, you must update your editor. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index 0a7016cba..65b4af859 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -16,22 +16,25 @@ EditorResourceConversionPlugin Methods ------- -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`_convert` **(** :ref:`Resource` resource **)** virtual | -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_converts_to` **(** **)** virtual | -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`_convert` **(** :ref:`Resource` resource **)** |virtual| | ++---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_converts_to` **(** **)** |virtual| | ++---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_EditorResourceConversionPlugin_method__convert: -- :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual +- :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** |virtual| ---- .. _class_EditorResourceConversionPlugin_method__converts_to: -- :ref:`String` **_converts_to** **(** **)** virtual +- :ref:`String` **_converts_to** **(** **)** |virtual| +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index c321536f4..88b86a493 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -85,3 +85,6 @@ Queue a resource file for preview (using a path). Once the preview is ready, you Removes a custom preview generator. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 61de3a0b2..b90fbcc9c 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -21,24 +21,24 @@ Custom code to generate previews. Please check ``file_dialog/thumbnail_size`` in Methods ------- -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_generate_small_preview` **(** **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path, :ref:`Vector2` size **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`generate_small_preview_automatically` **(** **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_generate_small_preview` **(** **)** |virtual| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from, :ref:`Vector2` size **)** |virtual| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path, :ref:`Vector2` size **)** |virtual| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`generate_small_preview_automatically` **(** **)** |virtual| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** |virtual| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_EditorResourcePreviewGenerator_method_can_generate_small_preview: -- :ref:`bool` **can_generate_small_preview** **(** **)** virtual +- :ref:`bool` **can_generate_small_preview** **(** **)** |virtual| If this function returns ``true``, the generator will call :ref:`generate` or :ref:`generate_from_path` for small previews as well. @@ -48,7 +48,7 @@ By default, it returns ``false``. .. _class_EditorResourcePreviewGenerator_method_generate: -- :ref:`Texture` **generate** **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual +- :ref:`Texture` **generate** **(** :ref:`Resource` from, :ref:`Vector2` size **)** |virtual| Generate a preview from a given resource with the specified size. This must always be implemented. @@ -60,7 +60,7 @@ Care must be taken because this function is always called from a thread (not the .. _class_EditorResourcePreviewGenerator_method_generate_from_path: -- :ref:`Texture` **generate_from_path** **(** :ref:`String` path, :ref:`Vector2` size **)** virtual +- :ref:`Texture` **generate_from_path** **(** :ref:`String` path, :ref:`Vector2` size **)** |virtual| Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call :ref:`generate`. @@ -72,7 +72,7 @@ Care must be taken because this function is always called from a thread (not the .. _class_EditorResourcePreviewGenerator_method_generate_small_preview_automatically: -- :ref:`bool` **generate_small_preview_automatically** **(** **)** virtual +- :ref:`bool` **generate_small_preview_automatically** **(** **)** |virtual| If this function returns ``true``, the generator will automatically generate the small previews from the normal preview texture generated by the methods :ref:`generate` or :ref:`generate_from_path`. @@ -82,7 +82,10 @@ By default, it returns ``false``. .. _class_EditorResourcePreviewGenerator_method_handles: -- :ref:`bool` **handles** **(** :ref:`String` type **)** virtual +- :ref:`bool` **handles** **(** :ref:`String` type **)** |virtual| Returns ``true`` if your generator supports the resource of type ``type``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneimporter.rst index e18cbacbb..b8879073a 100644 --- a/classes/class_editorsceneimporter.rst +++ b/classes/class_editorsceneimporter.rst @@ -19,13 +19,13 @@ Methods ------- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_extensions` **(** **)** virtual | +| :ref:`Array` | :ref:`_get_extensions` **(** **)** |virtual| | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_import_flags` **(** **)** virtual | +| :ref:`int` | :ref:`_get_import_flags` **(** **)** |virtual| | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`_import_animation` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual | +| :ref:`Animation` | :ref:`_import_animation` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`_import_scene` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual | +| :ref:`Node` | :ref:`_import_scene` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Animation` | :ref:`import_animation_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -80,25 +80,25 @@ Method Descriptions .. _class_EditorSceneImporter_method__get_extensions: -- :ref:`Array` **_get_extensions** **(** **)** virtual +- :ref:`Array` **_get_extensions** **(** **)** |virtual| ---- .. _class_EditorSceneImporter_method__get_import_flags: -- :ref:`int` **_get_import_flags** **(** **)** virtual +- :ref:`int` **_get_import_flags** **(** **)** |virtual| ---- .. _class_EditorSceneImporter_method__import_animation: -- :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual +- :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| ---- .. _class_EditorSceneImporter_method__import_scene: -- :ref:`Node` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual +- :ref:`Node` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** |virtual| ---- @@ -112,3 +112,6 @@ Method Descriptions - :ref:`Node` **import_scene_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorsceneimporterassimp.rst b/classes/class_editorsceneimporterassimp.rst index 71b10669b..3f90cf9b2 100644 --- a/classes/class_editorsceneimporterassimp.rst +++ b/classes/class_editorsceneimporterassimp.rst @@ -41,3 +41,6 @@ If exporting a FBX scene from Autodesk Maya, use these FBX export settings: - Up Axis: Y - Binary format in FBX 2017 +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index c8b485cba..9091c7209 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -47,20 +47,20 @@ Tutorials Methods ------- -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_source_file` **(** **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_source_folder` **(** **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`post_import` **(** :ref:`Object` scene **)** virtual | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_source_file` **(** **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_source_folder` **(** **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`post_import` **(** :ref:`Object` scene **)** |virtual| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_EditorScenePostImport_method_get_source_file: -- :ref:`String` **get_source_file** **(** **)** const +- :ref:`String` **get_source_file** **(** **)** |const| Returns the source file path which got imported (e.g. ``res://scene.dae``). @@ -68,7 +68,7 @@ Returns the source file path which got imported (e.g. ``res://scene.dae``). .. _class_EditorScenePostImport_method_get_source_folder: -- :ref:`String` **get_source_folder** **(** **)** const +- :ref:`String` **get_source_folder** **(** **)** |const| Returns the resource folder the imported scene file is located in. @@ -76,7 +76,10 @@ Returns the resource folder the imported scene file is located in. .. _class_EditorScenePostImport_method_post_import: -- :ref:`Object` **post_import** **(** :ref:`Object` scene **)** virtual +- :ref:`Object` **post_import** **(** :ref:`Object` scene **)** |virtual| Called after the scene was imported. This method must return the modified version of the scene. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 85d058734..926df3024 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -36,7 +36,7 @@ Methods ------- +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`_run` **(** **)** virtual | +| void | :ref:`_run` **(** **)** |virtual| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ | void | :ref:`add_root_node` **(** :ref:`Node` node **)** | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ @@ -50,7 +50,7 @@ Method Descriptions .. _class_EditorScript_method__run: -- void **_run** **(** **)** virtual +- void **_run** **(** **)** |virtual| This method is executed by the Editor when **File > Run** is used. @@ -80,3 +80,6 @@ Returns the :ref:`EditorInterface` singleton instance. Returns the Editor's currently active scene. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 83e5bbfc2..9d5dd9e30 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -85,3 +85,6 @@ Gets the list of selected nodes, optimized for transform operations (i.e. moving Removes a node from the selection. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 595f13373..b9dd7942f 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -37,39 +37,39 @@ Accessing the settings can be done using the following methods, such as: Methods ------- -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`String` property **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_favorites` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** 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_dir` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_favorites` **(** :ref:`PoolStringArray` dirs **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_recent_dirs` **(** :ref:`PoolStringArray` dirs **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`String` property **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_favorites` **(** **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** |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_dir` **(** **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** |const| | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_favorites` **(** :ref:`PoolStringArray` dirs **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_recent_dirs` **(** :ref:`PoolStringArray` dirs **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -129,7 +129,7 @@ Erases the setting whose name is specified by ``property``. .. _class_EditorSettings_method_get_favorites: -- :ref:`PoolStringArray` **get_favorites** **(** **)** const +- :ref:`PoolStringArray` **get_favorites** **(** **)** |const| Returns the list of favorite files and directories for this project. @@ -137,7 +137,7 @@ Returns the list of favorite files and directories for this project. .. _class_EditorSettings_method_get_project_metadata: -- :ref:`Variant` **get_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const +- :ref:`Variant` **get_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** |const| Returns project-specific metadata for the ``section`` and ``key`` specified. If the metadata doesn't exist, ``default`` will be returned instead. See also :ref:`set_project_metadata`. @@ -145,7 +145,7 @@ Returns project-specific metadata for the ``section`` and ``key`` specified. If .. _class_EditorSettings_method_get_project_settings_dir: -- :ref:`String` **get_project_settings_dir** **(** **)** const +- :ref:`String` **get_project_settings_dir** **(** **)** |const| Returns the project-specific settings path. Projects all have a unique subdirectory inside the settings path where project-specific settings are saved. @@ -153,7 +153,7 @@ Returns the project-specific settings path. Projects all have a unique subdirect .. _class_EditorSettings_method_get_recent_dirs: -- :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const +- :ref:`PoolStringArray` **get_recent_dirs** **(** **)** |const| Returns the list of recently visited folders in the file dialog for this project. @@ -161,7 +161,7 @@ Returns the list of recently visited folders in the file dialog for this project .. _class_EditorSettings_method_get_setting: -- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** |const| Returns the value of the setting specified by ``name``. This is equivalent to using :ref:`Object.get` on the EditorSettings instance. @@ -169,7 +169,7 @@ Returns the value of the setting specified by ``name``. This is equivalent to us .. _class_EditorSettings_method_get_settings_dir: -- :ref:`String` **get_settings_dir** **(** **)** const +- :ref:`String` **get_settings_dir** **(** **)** |const| Gets the global settings path for the engine. Inside this path, you can find some standard paths such as: @@ -181,7 +181,7 @@ Gets the global settings path for the engine. Inside this path, you can find som .. _class_EditorSettings_method_has_setting: -- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const +- :ref:`bool` **has_setting** **(** :ref:`String` name **)** |const| Returns ``true`` if the setting specified by ``name`` exists, ``false`` otherwise. @@ -241,3 +241,6 @@ Sets the list of recently visited folders in the file dialog for this project. Sets the ``value`` of the setting specified by ``name``. This is equivalent to using :ref:`Object.set` on the EditorSettings instance. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index 6b9040af3..20ddc29cf 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -36,21 +36,21 @@ Methods +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | +| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** |virtual| | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | +| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** |virtual| | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | +| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** |virtual| | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSpatialGizmoPlugin` | :ref:`get_plugin` **(** **)** const | +| :ref:`EditorSpatialGizmoPlugin` | :ref:`get_plugin` **(** **)** |const| | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Spatial` | :ref:`get_spatial_node` **(** **)** const | +| :ref:`Spatial` | :ref:`get_spatial_node` **(** **)** |const| | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_handle_highlighted` **(** :ref:`int` index **)** virtual | +| :ref:`bool` | :ref:`is_handle_highlighted` **(** :ref:`int` index **)** |virtual| | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redraw` **(** **)** virtual | +| void | :ref:`redraw` **(** **)** |virtual| | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | +| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** |virtual| | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | +-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -120,7 +120,7 @@ Removes everything in the gizmo including meshes, collisions and handles. .. _class_EditorSpatialGizmo_method_commit_handle: -- void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual +- void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** |virtual| Commit a handle being edited (handles must have been previously added by :ref:`add_handles`). @@ -130,7 +130,7 @@ If the ``cancel`` parameter is ``true``, an option to restore the edited value t .. _class_EditorSpatialGizmo_method_get_handle_name: -- :ref:`String` **get_handle_name** **(** :ref:`int` index **)** virtual +- :ref:`String` **get_handle_name** **(** :ref:`int` index **)** |virtual| Gets the name of an edited handle (handles must have been previously added by :ref:`add_handles`). @@ -140,7 +140,7 @@ Handles can be named for reference to the user when editing. .. _class_EditorSpatialGizmo_method_get_handle_value: -- :ref:`Variant` **get_handle_value** **(** :ref:`int` index **)** virtual +- :ref:`Variant` **get_handle_value** **(** :ref:`int` index **)** |virtual| Gets actual value of a handle. This value can be anything and used for eventually undoing the motion when calling :ref:`commit_handle`. @@ -148,7 +148,7 @@ Gets actual value of a handle. This value can be anything and used for eventuall .. _class_EditorSpatialGizmo_method_get_plugin: -- :ref:`EditorSpatialGizmoPlugin` **get_plugin** **(** **)** const +- :ref:`EditorSpatialGizmoPlugin` **get_plugin** **(** **)** |const| Returns the :ref:`EditorSpatialGizmoPlugin` that owns this gizmo. It's useful to retrieve materials using :ref:`EditorSpatialGizmoPlugin.get_material`. @@ -156,7 +156,7 @@ Returns the :ref:`EditorSpatialGizmoPlugin` that .. _class_EditorSpatialGizmo_method_get_spatial_node: -- :ref:`Spatial` **get_spatial_node** **(** **)** const +- :ref:`Spatial` **get_spatial_node** **(** **)** |const| Returns the Spatial node associated with this gizmo. @@ -164,7 +164,7 @@ Returns the Spatial node associated with this gizmo. .. _class_EditorSpatialGizmo_method_is_handle_highlighted: -- :ref:`bool` **is_handle_highlighted** **(** :ref:`int` index **)** virtual +- :ref:`bool` **is_handle_highlighted** **(** :ref:`int` index **)** |virtual| Returns ``true`` if the handle at index ``index`` is highlighted by being hovered with the mouse. @@ -172,7 +172,7 @@ Returns ``true`` if the handle at index ``index`` is highlighted by being hovere .. _class_EditorSpatialGizmo_method_redraw: -- void **redraw** **(** **)** virtual +- void **redraw** **(** **)** |virtual| This function is called when the :ref:`Spatial` this gizmo refers to changes (the :ref:`Spatial.update_gizmo` is called). @@ -180,7 +180,7 @@ This function is called when the :ref:`Spatial` this gizmo refers .. _class_EditorSpatialGizmo_method_set_handle: -- void **set_handle** **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual +- void **set_handle** **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** |virtual| This function is used when the user drags a gizmo handle (previously added with :ref:`add_handles`) in screen coordinates. @@ -202,3 +202,6 @@ Sets the gizmo's hidden state. If ``true``, the gizmo will be hidden. If ``false Sets the reference :ref:`Spatial` node for the gizmo. ``node`` must inherit from :ref:`Spatial`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorspatialgizmoplugin.rst b/classes/class_editorspatialgizmoplugin.rst index 5cc9ba11b..cabf3f7c4 100644 --- a/classes/class_editorspatialgizmoplugin.rst +++ b/classes/class_editorspatialgizmoplugin.rst @@ -29,11 +29,11 @@ Methods +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_material` **(** :ref:`String` name, :ref:`SpatialMaterial` material **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_be_hidden` **(** **)** virtual | +| :ref:`bool` | :ref:`can_be_hidden` **(** **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_handle` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | +| void | :ref:`commit_handle` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSpatialGizmo` | :ref:`create_gizmo` **(** :ref:`Spatial` spatial **)** virtual | +| :ref:`EditorSpatialGizmo` | :ref:`create_gizmo` **(** :ref:`Spatial` spatial **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_handle_material` **(** :ref:`String` name, :ref:`bool` billboard=false **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -41,25 +41,25 @@ Methods +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_material` **(** :ref:`String` name, :ref:`Color` color, :ref:`bool` billboard=false, :ref:`bool` on_top=false, :ref:`bool` use_vertex_color=false **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_handle_name` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual | +| :ref:`String` | :ref:`get_handle_name` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual | +| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SpatialMaterial` | :ref:`get_material` **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** virtual | +| :ref:`String` | :ref:`get_name` **(** **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_priority` **(** **)** virtual | +| :ref:`String` | :ref:`get_priority` **(** **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_gizmo` **(** :ref:`Spatial` spatial **)** virtual | +| :ref:`bool` | :ref:`has_gizmo` **(** :ref:`Spatial` spatial **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_handle_highlighted` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual | +| :ref:`bool` | :ref:`is_handle_highlighted` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selectable_when_hidden` **(** **)** virtual | +| :ref:`bool` | :ref:`is_selectable_when_hidden` **(** **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redraw` **(** :ref:`EditorSpatialGizmo` gizmo **)** virtual | +| void | :ref:`redraw` **(** :ref:`EditorSpatialGizmo` gizmo **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | +| void | :ref:`set_handle` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions @@ -75,7 +75,7 @@ Adds a new material to the internal material list for the plugin. It can then be .. _class_EditorSpatialGizmoPlugin_method_can_be_hidden: -- :ref:`bool` **can_be_hidden** **(** **)** virtual +- :ref:`bool` **can_be_hidden** **(** **)** |virtual| Override this method to define whether the gizmo can be hidden or not. Returns ``true`` if not overridden. @@ -83,7 +83,7 @@ Override this method to define whether the gizmo can be hidden or not. Returns ` .. _class_EditorSpatialGizmoPlugin_method_commit_handle: -- void **commit_handle** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual +- void **commit_handle** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** |virtual| Override this method to commit gizmo handles. Called for this plugin's active gizmos. @@ -91,7 +91,7 @@ Override this method to commit gizmo handles. Called for this plugin's active gi .. _class_EditorSpatialGizmoPlugin_method_create_gizmo: -- :ref:`EditorSpatialGizmo` **create_gizmo** **(** :ref:`Spatial` spatial **)** virtual +- :ref:`EditorSpatialGizmo` **create_gizmo** **(** :ref:`Spatial` spatial **)** |virtual| Override this method to return a custom :ref:`EditorSpatialGizmo` for the spatial nodes of your choice, return ``null`` for the rest of nodes. See also :ref:`has_gizmo`. @@ -123,7 +123,7 @@ Creates an unshaded material with its variants (selected and/or editable) and ad .. _class_EditorSpatialGizmoPlugin_method_get_handle_name: -- :ref:`String` **get_handle_name** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual +- :ref:`String` **get_handle_name** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** |virtual| Override this method to provide gizmo's handle names. Called for this plugin's active gizmos. @@ -131,7 +131,7 @@ Override this method to provide gizmo's handle names. Called for this plugin's a .. _class_EditorSpatialGizmoPlugin_method_get_handle_value: -- :ref:`Variant` **get_handle_value** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual +- :ref:`Variant` **get_handle_value** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** |virtual| Gets actual value of a handle from gizmo. Called for this plugin's active gizmos. @@ -147,7 +147,7 @@ Gets material from the internal list of materials. If an :ref:`EditorSpatialGizm .. _class_EditorSpatialGizmoPlugin_method_get_name: -- :ref:`String` **get_name** **(** **)** virtual +- :ref:`String` **get_name** **(** **)** |virtual| Override this method to provide the name that will appear in the gizmo visibility menu. @@ -155,7 +155,7 @@ Override this method to provide the name that will appear in the gizmo visibilit .. _class_EditorSpatialGizmoPlugin_method_get_priority: -- :ref:`String` **get_priority** **(** **)** virtual +- :ref:`String` **get_priority** **(** **)** |virtual| Override this method to set the gizmo's priority. Higher values correspond to higher priority. If a gizmo with higher priority conflicts with another gizmo, only the gizmo with higher priority will be used. @@ -165,7 +165,7 @@ All built-in editor gizmos return a priority of ``-1``. If not overridden, this .. _class_EditorSpatialGizmoPlugin_method_has_gizmo: -- :ref:`bool` **has_gizmo** **(** :ref:`Spatial` spatial **)** virtual +- :ref:`bool` **has_gizmo** **(** :ref:`Spatial` spatial **)** |virtual| Override this method to define which Spatial nodes have a gizmo from this plugin. Whenever a :ref:`Spatial` node is added to a scene this method is called, if it returns ``true`` the node gets a generic :ref:`EditorSpatialGizmo` assigned and is added to this plugin's list of active gizmos. @@ -173,7 +173,7 @@ Override this method to define which Spatial nodes have a gizmo from this plugin .. _class_EditorSpatialGizmoPlugin_method_is_handle_highlighted: -- :ref:`bool` **is_handle_highlighted** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual +- :ref:`bool` **is_handle_highlighted** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** |virtual| Gets whether a handle is highlighted or not. Called for this plugin's active gizmos. @@ -181,7 +181,7 @@ Gets whether a handle is highlighted or not. Called for this plugin's active giz .. _class_EditorSpatialGizmoPlugin_method_is_selectable_when_hidden: -- :ref:`bool` **is_selectable_when_hidden** **(** **)** virtual +- :ref:`bool` **is_selectable_when_hidden** **(** **)** |virtual| Override this method to define whether Spatial with this gizmo should be selecteble even when the gizmo is hidden. @@ -189,7 +189,7 @@ Override this method to define whether Spatial with this gizmo should be selecte .. _class_EditorSpatialGizmoPlugin_method_redraw: -- void **redraw** **(** :ref:`EditorSpatialGizmo` gizmo **)** virtual +- void **redraw** **(** :ref:`EditorSpatialGizmo` gizmo **)** |virtual| Callback to redraw the provided gizmo. Called for this plugin's active gizmos. @@ -197,7 +197,10 @@ Callback to redraw the provided gizmo. Called for this plugin's active gizmos. .. _class_EditorSpatialGizmoPlugin_method_set_handle: -- void **set_handle** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual +- void **set_handle** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** |virtual| Update the value of a handle after it has been updated. Called for this plugin's active gizmos. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorspinslider.rst b/classes/class_editorspinslider.rst index 75ccfe91e..33d4d3ab6 100644 --- a/classes/class_editorspinslider.rst +++ b/classes/class_editorspinslider.rst @@ -69,3 +69,6 @@ Property Descriptions | *Getter* | is_read_only() | +-----------+----------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_editorvcsinterface.rst b/classes/class_editorvcsinterface.rst index 8d12e99b1..4b7d80870 100644 --- a/classes/class_editorvcsinterface.rst +++ b/classes/class_editorvcsinterface.rst @@ -160,3 +160,6 @@ Stages the file which should be committed when :ref:`commit` is called. Argument should contain the absolute path. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index 6f22b49db..292c5e1c7 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -44,3 +44,6 @@ Property Descriptions The :ref:`Object` identifier stored in this ``EncodedObjectAsID`` instance. The object instance can be retrieved with :ref:`@GDScript.instance_from_id`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 331077cc5..8cf6822a2 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -36,37 +36,37 @@ Properties Methods ------- -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_author_info` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_copyright_info` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_donor_info` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frames_drawn` **(** **)** | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_frames_per_second` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_idle_frames` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_license_info` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_license_text` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_physics_frames` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_physics_interpolation_fraction` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_version_info` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_physics_frame` **(** **)** const | -+-------------------------------------+---------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_author_info` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_copyright_info` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_donor_info` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frames_drawn` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_frames_per_second` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_idle_frames` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_license_info` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_license_text` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_physics_frames` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_physics_interpolation_fraction` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_version_info` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_physics_frame` **(** **)** |const| | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -154,7 +154,7 @@ Method Descriptions .. _class_Engine_method_get_author_info: -- :ref:`Dictionary` **get_author_info** **(** **)** const +- :ref:`Dictionary` **get_author_info** **(** **)** |const| Returns engine author information in a Dictionary. @@ -170,7 +170,7 @@ Returns engine author information in a Dictionary. .. _class_Engine_method_get_copyright_info: -- :ref:`Array` **get_copyright_info** **(** **)** const +- :ref:`Array` **get_copyright_info** **(** **)** |const| Returns an Array of copyright information Dictionaries. @@ -182,11 +182,11 @@ Returns an Array of copyright information Dictionaries. .. _class_Engine_method_get_donor_info: -- :ref:`Dictionary` **get_donor_info** **(** **)** const +- :ref:`Dictionary` **get_donor_info** **(** **)** |const| Returns a Dictionary of Arrays of donor names. -{``platinum_sponsors``, ``gold_sponsors``, ``mini_sponsors``, ``gold_donors``, ``silver_donors``, ``bronze_donors``} +{``platinum_sponsors``, ``gold_sponsors``, ``silver_sponsors``, ``bronze_sponsors``, ``mini_sponsors``, ``gold_donors``, ``silver_donors``, ``bronze_donors``} ---- @@ -200,7 +200,7 @@ Returns the total number of frames drawn. If the render loop is disabled with `` .. _class_Engine_method_get_frames_per_second: -- :ref:`float` **get_frames_per_second** **(** **)** const +- :ref:`float` **get_frames_per_second** **(** **)** |const| Returns the frames per second of the running game. @@ -208,7 +208,7 @@ Returns the frames per second of the running game. .. _class_Engine_method_get_idle_frames: -- :ref:`int` **get_idle_frames** **(** **)** const +- :ref:`int` **get_idle_frames** **(** **)** |const| Returns the total number of frames passed since engine initialization which is advanced on each **idle frame**, regardless of whether the render loop is enabled. See also :ref:`get_frames_drawn`. @@ -216,7 +216,7 @@ Returns the total number of frames passed since engine initialization which is a .. _class_Engine_method_get_license_info: -- :ref:`Dictionary` **get_license_info** **(** **)** const +- :ref:`Dictionary` **get_license_info** **(** **)** |const| Returns Dictionary of licenses used by Godot and included third party components. @@ -224,7 +224,7 @@ Returns Dictionary of licenses used by Godot and included third party components .. _class_Engine_method_get_license_text: -- :ref:`String` **get_license_text** **(** **)** const +- :ref:`String` **get_license_text** **(** **)** |const| Returns Godot license text. @@ -232,7 +232,7 @@ Returns Godot license text. .. _class_Engine_method_get_main_loop: -- :ref:`MainLoop` **get_main_loop** **(** **)** const +- :ref:`MainLoop` **get_main_loop** **(** **)** |const| Returns the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). @@ -240,7 +240,7 @@ Returns the main loop object (see :ref:`MainLoop` and :ref:`Scen .. _class_Engine_method_get_physics_frames: -- :ref:`int` **get_physics_frames** **(** **)** const +- :ref:`int` **get_physics_frames** **(** **)** |const| Returns the total number of frames passed since engine initialization which is advanced on each **physics frame**. @@ -248,7 +248,7 @@ Returns the total number of frames passed since engine initialization which is a .. _class_Engine_method_get_physics_interpolation_fraction: -- :ref:`float` **get_physics_interpolation_fraction** **(** **)** const +- :ref:`float` **get_physics_interpolation_fraction** **(** **)** |const| Returns the fraction through the current physics tick we are at the time of rendering the frame. This can be used to implement fixed timestep interpolation. @@ -256,7 +256,7 @@ Returns the fraction through the current physics tick we are at the time of rend .. _class_Engine_method_get_singleton: -- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const +- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** |const| Returns a global singleton with given ``name``. Often used for plugins, e.g. ``GodotPayment`` on Android. @@ -264,7 +264,7 @@ Returns a global singleton with given ``name``. Often used for plugins, e.g. ``G .. _class_Engine_method_get_version_info: -- :ref:`Dictionary` **get_version_info** **(** **)** const +- :ref:`Dictionary` **get_version_info** **(** **)** |const| Returns the current engine version information in a Dictionary. @@ -299,7 +299,7 @@ The ``hex`` value is encoded as follows, from left to right: one byte for the ma .. _class_Engine_method_has_singleton: -- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const +- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** |const| Returns ``true`` if a singleton with given ``name`` exists in global scope. @@ -307,7 +307,10 @@ Returns ``true`` if a singleton with given ``name`` exists in global scope. .. _class_Engine_method_is_in_physics_frame: -- :ref:`bool` **is_in_physics_frame** **(** **)** const +- :ref:`bool` **is_in_physics_frame** **(** **)** |const| Returns ``true`` if the game is inside the fixed process and physics phase of the game loop. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 6a32f6250..5e8bf24ce 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -212,7 +212,7 @@ Methods ------- +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_level_enabled` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_glow_level_enabled` **(** :ref:`int` idx **)** |const| | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_level` **(** :ref:`int` idx, :ref:`bool` enabled **)** | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ @@ -1706,7 +1706,7 @@ Method Descriptions .. _class_Environment_method_is_glow_level_enabled: -- :ref:`bool` **is_glow_level_enabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_glow_level_enabled** **(** :ref:`int` idx **)** |const| Returns ``true`` if the glow level ``idx`` is specified, ``false`` otherwise. @@ -1718,3 +1718,6 @@ Returns ``true`` if the glow level ``idx`` is specified, ``false`` otherwise. Enables or disables the glow level at index ``idx``. Each level relies on the previous level. This means that enabling higher glow levels will slow down the glow effect rendering, even if previous levels aren't enabled. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_expression.rst b/classes/class_expression.rst index 73dee6b93..1cd859eb5 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -44,9 +44,9 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`execute` **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_error_text` **(** **)** const | +| :ref:`String` | :ref:`get_error_text` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_execute_failed` **(** **)** const | +| :ref:`bool` | :ref:`has_execute_failed` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`parse` **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -66,7 +66,7 @@ If you defined input variables in :ref:`parse`, y .. _class_Expression_method_get_error_text: -- :ref:`String` **get_error_text** **(** **)** const +- :ref:`String` **get_error_text** **(** **)** |const| Returns the error text if :ref:`parse` has failed. @@ -74,7 +74,7 @@ Returns the error text if :ref:`parse` has failed .. _class_Expression_method_has_execute_failed: -- :ref:`bool` **has_execute_failed** **(** **)** const +- :ref:`bool` **has_execute_failed** **(** **)** |const| Returns ``true`` if :ref:`execute` has failed. @@ -88,3 +88,6 @@ Parses the expression and returns an :ref:`Error` code. You can optionally specify names of variables that may appear in the expression with ``input_names``, so that you can bind them when it gets executed. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_externaltexture.rst b/classes/class_externaltexture.rst index f6abeb909..7c9918bc0 100644 --- a/classes/class_externaltexture.rst +++ b/classes/class_externaltexture.rst @@ -62,3 +62,6 @@ Method Descriptions Returns the external texture name. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_file.rst b/classes/class_file.rst index 982ac0f03..24edd7709 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -55,53 +55,53 @@ Methods +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`eof_reached` **(** **)** const | +| :ref:`bool` | :ref:`eof_reached` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** const | +| :ref:`int` | :ref:`get_16` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** const | +| :ref:`int` | :ref:`get_32` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** const | +| :ref:`int` | :ref:`get_64` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** const | +| :ref:`int` | :ref:`get_8` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | +| :ref:`String` | :ref:`get_as_text` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | +| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | +| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** const | +| :ref:`float` | :ref:`get_double` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_error` **(** **)** const | +| :ref:`Error` | :ref:`get_error` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** const | +| :ref:`float` | :ref:`get_float` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_len` **(** **)** const | +| :ref:`int` | :ref:`get_len` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** **)** const | +| :ref:`String` | :ref:`get_line` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | +| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_pascal_string` **(** **)** | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | +| :ref:`String` | :ref:`get_path` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path_absolute` **(** **)** const | +| :ref:`String` | :ref:`get_path_absolute` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position` **(** **)** const | +| :ref:`int` | :ref:`get_position` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_real` **(** **)** const | +| :ref:`float` | :ref:`get_real` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** const | +| :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_open` **(** **)** const | +| :ref:`bool` | :ref:`is_open` **(** **)** |const| | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`open` **(** :ref:`String` path, :ref:`ModeFlags` flags **)** | +-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -157,13 +157,13 @@ Enumerations enum **ModeFlags**: -- **READ** = **1** --- Opens the file for read operations. +- **READ** = **1** --- Opens the file for read operations. The cursor is positioned at the beginning of the file. -- **WRITE** = **2** --- Opens the file for write operations. Create it if the file does not exist and truncate if it exists. +- **WRITE** = **2** --- Opens the file for write operations. The file is created if it does not exist, and truncated if it does. -- **READ_WRITE** = **3** --- Opens the file for read and write operations. Does not truncate the file. +- **READ_WRITE** = **3** --- Opens the file for read and write operations. Does not truncate the file. The cursor is positioned at the beginning of the file. -- **WRITE_READ** = **7** --- Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists. +- **WRITE_READ** = **7** --- Opens the file for read and write operations. The file is created if it does not exist, and truncated if it does. The cursor is positioned at the beginning of the file. ---- @@ -219,7 +219,7 @@ Closes the currently opened file. .. _class_File_method_eof_reached: -- :ref:`bool` **eof_reached** **(** **)** const +- :ref:`bool` **eof_reached** **(** **)** |const| Returns ``true`` if the file cursor has read past the end of the file. @@ -229,7 +229,7 @@ Returns ``true`` if the file cursor has read past the end of the file. .. _class_File_method_file_exists: -- :ref:`bool` **file_exists** **(** :ref:`String` path **)** const +- :ref:`bool` **file_exists** **(** :ref:`String` path **)** |const| Returns ``true`` if the file exists in the given path. @@ -239,7 +239,7 @@ Returns ``true`` if the file exists in the given path. .. _class_File_method_get_16: -- :ref:`int` **get_16** **(** **)** const +- :ref:`int` **get_16** **(** **)** |const| Returns the next 16 bits from the file as an integer. See :ref:`store_16` for details on what values can be stored and retrieved this way. @@ -247,7 +247,7 @@ Returns the next 16 bits from the file as an integer. See :ref:`store_16` **get_32** **(** **)** const +- :ref:`int` **get_32** **(** **)** |const| Returns the next 32 bits from the file as an integer. See :ref:`store_32` for details on what values can be stored and retrieved this way. @@ -255,7 +255,7 @@ Returns the next 32 bits from the file as an integer. See :ref:`store_32` **get_64** **(** **)** const +- :ref:`int` **get_64** **(** **)** |const| Returns the next 64 bits from the file as an integer. See :ref:`store_64` for details on what values can be stored and retrieved this way. @@ -263,7 +263,7 @@ Returns the next 64 bits from the file as an integer. See :ref:`store_64` **get_8** **(** **)** const +- :ref:`int` **get_8** **(** **)** |const| Returns the next 8 bits from the file as an integer. See :ref:`store_8` for details on what values can be stored and retrieved this way. @@ -271,7 +271,7 @@ Returns the next 8 bits from the file as an integer. See :ref:`store_8` **get_as_text** **(** **)** const +- :ref:`String` **get_as_text** **(** **)** |const| Returns the whole file as a :ref:`String`. @@ -281,7 +281,7 @@ Text is interpreted as being UTF-8 encoded. .. _class_File_method_get_buffer: -- :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const +- :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** |const| Returns next ``len`` bytes of the file as a :ref:`PoolByteArray`. @@ -289,7 +289,7 @@ Returns next ``len`` bytes of the file as a :ref:`PoolByteArray` **get_csv_line** **(** :ref:`String` delim="," **)** const +- :ref:`PoolStringArray` **get_csv_line** **(** :ref:`String` delim="," **)** |const| Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long. @@ -299,7 +299,7 @@ Text is interpreted as being UTF-8 encoded. .. _class_File_method_get_double: -- :ref:`float` **get_double** **(** **)** const +- :ref:`float` **get_double** **(** **)** |const| Returns the next 64 bits from the file as a floating-point number. @@ -307,7 +307,7 @@ Returns the next 64 bits from the file as a floating-point number. .. _class_File_method_get_error: -- :ref:`Error` **get_error** **(** **)** const +- :ref:`Error` **get_error** **(** **)** |const| Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`Error`. @@ -315,7 +315,7 @@ Returns the last error that happened when trying to perform operations. Compare .. _class_File_method_get_float: -- :ref:`float` **get_float** **(** **)** const +- :ref:`float` **get_float** **(** **)** |const| Returns the next 32 bits from the file as a floating-point number. @@ -323,7 +323,7 @@ Returns the next 32 bits from the file as a floating-point number. .. _class_File_method_get_len: -- :ref:`int` **get_len** **(** **)** const +- :ref:`int` **get_len** **(** **)** |const| Returns the size of the file in bytes. @@ -331,7 +331,7 @@ Returns the size of the file in bytes. .. _class_File_method_get_line: -- :ref:`String` **get_line** **(** **)** const +- :ref:`String` **get_line** **(** **)** |const| Returns the next line of the file as a :ref:`String`. @@ -341,7 +341,7 @@ Text is interpreted as being UTF-8 encoded. .. _class_File_method_get_md5: -- :ref:`String` **get_md5** **(** :ref:`String` path **)** const +- :ref:`String` **get_md5** **(** :ref:`String` path **)** |const| Returns an MD5 String representing the file at the given path or an empty :ref:`String` on failure. @@ -349,7 +349,7 @@ Returns an MD5 String representing the file at the given path or an empty :ref:` .. _class_File_method_get_modified_time: -- :ref:`int` **get_modified_time** **(** :ref:`String` file **)** const +- :ref:`int` **get_modified_time** **(** :ref:`String` file **)** |const| Returns the last time the ``file`` was modified in unix timestamp format or returns a :ref:`String` "ERROR IN ``file``". This unix timestamp can be converted to datetime by using :ref:`OS.get_datetime_from_unix_time`. @@ -367,7 +367,7 @@ Text is interpreted as being UTF-8 encoded. .. _class_File_method_get_path: -- :ref:`String` **get_path** **(** **)** const +- :ref:`String` **get_path** **(** **)** |const| Returns the path as a :ref:`String` for the current open file. @@ -375,7 +375,7 @@ Returns the path as a :ref:`String` for the current open file. .. _class_File_method_get_path_absolute: -- :ref:`String` **get_path_absolute** **(** **)** const +- :ref:`String` **get_path_absolute** **(** **)** |const| Returns the absolute path as a :ref:`String` for the current open file. @@ -383,7 +383,7 @@ Returns the absolute path as a :ref:`String` for the current open .. _class_File_method_get_position: -- :ref:`int` **get_position** **(** **)** const +- :ref:`int` **get_position** **(** **)** |const| Returns the file cursor's position. @@ -391,7 +391,7 @@ Returns the file cursor's position. .. _class_File_method_get_real: -- :ref:`float` **get_real** **(** **)** const +- :ref:`float` **get_real** **(** **)** |const| Returns the next bits from the file as a floating-point number. @@ -399,7 +399,7 @@ Returns the next bits from the file as a floating-point number. .. _class_File_method_get_sha256: -- :ref:`String` **get_sha256** **(** :ref:`String` path **)** const +- :ref:`String` **get_sha256** **(** :ref:`String` path **)** |const| Returns a SHA-256 :ref:`String` representing the file at the given path or an empty :ref:`String` on failure. @@ -407,7 +407,7 @@ Returns a SHA-256 :ref:`String` representing the file at the given .. _class_File_method_get_var: -- :ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** const +- :ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** |const| Returns the next :ref:`Variant` value from the file. If ``allow_objects`` is ``true``, decoding objects is allowed. @@ -417,7 +417,7 @@ Returns the next :ref:`Variant` value from the file. If ``allow_o .. _class_File_method_is_open: -- :ref:`bool` **is_open** **(** **)** const +- :ref:`bool` **is_open** **(** **)** |const| Returns ``true`` if the file is currently opened. @@ -445,6 +445,8 @@ Opens a compressed file for reading or writing. Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. +**Note:** The provided key must be 32 bytes long. + ---- .. _class_File_method_open_encrypted_with_pass: @@ -616,3 +618,6 @@ Text will be encoded as UTF-8. Stores any Variant value in the file. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 91028179c..bab8032cd 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -168,6 +168,8 @@ Property Descriptions The file system access scope. See enum ``Access`` constants. +**Warning:** Currently, in sandboxed environments such as HTML5 builds or sandboxed macOS apps, FileDialog cannot access the host file system. See `godot-proposals#1123 `_. + ---- .. _class_FileDialog_property_current_dir: @@ -329,3 +331,6 @@ Returns the vertical box container of the dialog, custom controls can be added t Invalidate and update the current dialog content list. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_filesystemdock.rst b/classes/class_filesystemdock.rst index 6645394e3..f84de1d2e 100644 --- a/classes/class_filesystemdock.rst +++ b/classes/class_filesystemdock.rst @@ -16,15 +16,15 @@ FileSystemDock Methods ------- -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`Variant` | :ref:`get_drag_data_fw` **(** :ref:`Vector2` arg0, :ref:`Control` arg1 **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navigate_to_path` **(** :ref:`String` arg0 **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`Variant` | :ref:`get_drag_data_fw` **(** :ref:`Vector2` arg0, :ref:`Control` arg1 **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navigate_to_path` **(** :ref:`String` arg0 **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -74,7 +74,7 @@ Method Descriptions .. _class_FileSystemDock_method_can_drop_data_fw: -- :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` arg0, :ref:`Variant` arg1, :ref:`Control` arg2 **)** const +- :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` arg0, :ref:`Variant` arg1, :ref:`Control` arg2 **)** |const| ---- @@ -94,3 +94,6 @@ Method Descriptions - void **navigate_to_path** **(** :ref:`String` arg0 **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_float.rst b/classes/class_float.rst index 6015bf47b..f6a633b5f 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -48,3 +48,6 @@ Cast an :ref:`int` value to a floating-point value, ``float(1)`` will Cast a :ref:`String` value to a floating-point value. This method accepts float value strings like ``"1.23"`` and exponential notation strings for its parameter so calling ``float("1e3")`` will return 1000.0 and calling ``float("1e-3")`` will return 0.001. Calling this method with an invalid float string will return 0. This method stops parsing at the first invalid character and will return the parsed result so far, so calling ``float("1a3")`` will return 1 while calling ``float("1e3a2")`` will return 1000.0. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_font.rst b/classes/class_font.rst index f68ae53b1..730a983ce 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -20,39 +20,43 @@ Description Font contains a Unicode-compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. +**Note:** If a DynamicFont doesn't contain a character used in a string, the character in question will be replaced with codepoint ``0xfffd`` if it's available in the DynamicFont. If this replacement character isn't available in the DynamicFont, the character will be hidden without displaying any replacement character in the string. + +**Note:** If a BitmapFont doesn't contain a character used in a string, the character in question will be hidden without displaying any replacement character in the string. + Methods ------- -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1, :ref:`Color` outline_modulate=Color( 1, 1, 1, 1 ) **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` outline=false **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ascent` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_descent` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_wordwrap_string_size` **(** :ref:`String` string, :ref:`float` width **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_outline` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_changes` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1, :ref:`Color` outline_modulate=Color( 1, 1, 1, 1 ) **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` outline=false **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ascent` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_descent` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_wordwrap_string_size` **(** :ref:`String` string, :ref:`float` width **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_outline` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_changes` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_Font_method_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1, :ref:`Color` outline_modulate=Color( 1, 1, 1, 1 ) **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1, :ref:`Color` outline_modulate=Color( 1, 1, 1, 1 ) **)** |const| Draw ``string`` into a canvas item using the font at a given position, with ``modulate`` color, and optionally clipping the width. ``position`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. @@ -62,7 +66,7 @@ See also :ref:`CanvasItem.draw_string`. .. _class_Font_method_draw_char: -- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` outline=false **)** const +- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` outline=false **)** |const| Draw character ``char`` into a canvas item using the font at a given position, with ``modulate`` color, and optionally kerning if ``next`` is passed. clipping the width. ``position`` specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. @@ -70,7 +74,7 @@ Draw character ``char`` into a canvas item using the font at a given position, w .. _class_Font_method_get_ascent: -- :ref:`float` **get_ascent** **(** **)** const +- :ref:`float` **get_ascent** **(** **)** |const| Returns the font ascent (number of pixels above the baseline). @@ -78,7 +82,7 @@ Returns the font ascent (number of pixels above the baseline). .. _class_Font_method_get_char_size: -- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0 **)** const +- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0 **)** |const| Returns the size of a character, optionally taking kerning into account if the next character is provided. @@ -86,7 +90,7 @@ Returns the size of a character, optionally taking kerning into account if the n .. _class_Font_method_get_descent: -- :ref:`float` **get_descent** **(** **)** const +- :ref:`float` **get_descent** **(** **)** |const| Returns the font descent (number of pixels below the baseline). @@ -94,7 +98,7 @@ Returns the font descent (number of pixels below the baseline). .. _class_Font_method_get_height: -- :ref:`float` **get_height** **(** **)** const +- :ref:`float` **get_height** **(** **)** |const| Returns the total font height (ascent plus descent) in pixels. @@ -102,7 +106,7 @@ Returns the total font height (ascent plus descent) in pixels. .. _class_Font_method_get_string_size: -- :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** const +- :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** |const| Returns the size of a string, taking kerning and advance into account. @@ -110,7 +114,7 @@ Returns the size of a string, taking kerning and advance into account. .. _class_Font_method_get_wordwrap_string_size: -- :ref:`Vector2` **get_wordwrap_string_size** **(** :ref:`String` string, :ref:`float` width **)** const +- :ref:`Vector2` **get_wordwrap_string_size** **(** :ref:`String` string, :ref:`float` width **)** |const| Returns the size that the string would have with word wrapping enabled with a fixed ``width``. @@ -118,7 +122,7 @@ Returns the size that the string would have with word wrapping enabled with a fi .. _class_Font_method_has_outline: -- :ref:`bool` **has_outline** **(** **)** const +- :ref:`bool` **has_outline** **(** **)** |const| Returns ``true`` if the font has an outline. @@ -126,7 +130,7 @@ Returns ``true`` if the font has an outline. .. _class_Font_method_is_distance_field_hint: -- :ref:`bool` **is_distance_field_hint** **(** **)** const +- :ref:`bool` **is_distance_field_hint** **(** **)** |const| ---- @@ -136,3 +140,6 @@ Returns ``true`` if the font has an outline. After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index 1d6ce48cc..70d3601b4 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -24,11 +24,11 @@ Methods ------- +-------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_func` **(** ... **)** vararg | +| :ref:`Variant` | :ref:`call_func` **(** ... **)** |vararg| | +-------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`call_funcv` **(** :ref:`Array` arg_array **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | +| :ref:`bool` | :ref:`is_valid` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------+ | void | :ref:`set_function` **(** :ref:`String` name **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------+ @@ -40,7 +40,7 @@ Method Descriptions .. _class_FuncRef_method_call_func: -- :ref:`Variant` **call_func** **(** ... **)** vararg +- :ref:`Variant` **call_func** **(** ... **)** |vararg| Calls the referenced function previously set by :ref:`set_function` or :ref:`@GDScript.funcref`. @@ -56,7 +56,7 @@ Calls the referenced function previously set by :ref:`set_function` **is_valid** **(** **)** const +- :ref:`bool` **is_valid** **(** **)** |const| Returns whether the object still exists and has the function assigned. @@ -76,3 +76,6 @@ The name of the referenced function to call on the object, without parentheses o The object containing the referenced function. This object must be of a type actually inheriting from :ref:`Object`, not a built-in type such as :ref:`int`, :ref:`Vector2` or :ref:`Dictionary`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 70daac3d1..eb2db3659 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -63,3 +63,6 @@ Method Descriptions - :ref:`bool` **terminate** **(** **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index a17000e75..083d961fa 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -43,11 +43,11 @@ Properties Methods ------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_current_dependencies` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_library_path` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_current_dependencies` **(** **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_library_path` **(** **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -141,7 +141,7 @@ Method Descriptions .. _class_GDNativeLibrary_method_get_current_dependencies: -- :ref:`PoolStringArray` **get_current_dependencies** **(** **)** const +- :ref:`PoolStringArray` **get_current_dependencies** **(** **)** |const| Returns paths to all dependency libraries for the current platform and architecture. @@ -149,7 +149,10 @@ Returns paths to all dependency libraries for the current platform and architect .. _class_GDNativeLibrary_method_get_current_library_path: -- :ref:`String` **get_current_library_path** **(** **)** const +- :ref:`String` **get_current_library_path** **(** **)** |const| Returns the path to the dynamic library file for the current platform and architecture. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 5be67f800..1c5e94b15 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -28,18 +28,18 @@ Tutorials Methods ------- -+-------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** const | -+-------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`new` **(** ... **)** vararg | -+-------------------------------------------+-----------------------------------------------------------------------------------+ ++-------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** |const| | ++-------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** ... **)** |vararg| | ++-------------------------------------------+-------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_GDScript_method_get_as_byte_code: -- :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const +- :ref:`PoolByteArray` **get_as_byte_code** **(** **)** |const| Returns byte code for the script source code. @@ -47,7 +47,7 @@ Returns byte code for the script source code. .. _class_GDScript_method_new: -- :ref:`Variant` **new** **(** ... **)** vararg +- :ref:`Variant` **new** **(** ... **)** |vararg| Returns a new instance of the script. @@ -59,3 +59,6 @@ For example: var instance = MyClass.new() assert(instance.get_script() == MyClass) +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_gdscriptfunctionstate.rst b/classes/class_gdscriptfunctionstate.rst index 85a6409fc..1525dccce 100644 --- a/classes/class_gdscriptfunctionstate.rst +++ b/classes/class_gdscriptfunctionstate.rst @@ -21,11 +21,11 @@ Calling :ref:`@GDScript.yield` within a function w Methods ------- -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :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 ------- @@ -39,7 +39,7 @@ Method Descriptions .. _class_GDScriptFunctionState_method_is_valid: -- :ref:`bool` **is_valid** **(** :ref:`bool` extended_check=false **)** const +- :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. @@ -57,3 +57,6 @@ If handed an argument, return the argument from the :ref:`@GDScript.yield` | :ref:`get_flag_x` **(** :ref:`Flag` flag **)** const | +| :ref:`bool` | :ref:`get_flag_x` **(** :ref:`Flag` flag **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag_y` **(** :ref:`Flag` flag **)** const | +| :ref:`bool` | :ref:`get_flag_y` **(** :ref:`Flag` flag **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag_z` **(** :ref:`Flag` flag **)** const | +| :ref:`bool` | :ref:`get_flag_z` **(** :ref:`Flag` flag **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_x` **(** :ref:`Param` param **)** const | +| :ref:`float` | :ref:`get_param_x` **(** :ref:`Param` param **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_y` **(** :ref:`Param` param **)** const | +| :ref:`float` | :ref:`get_param_y` **(** :ref:`Param` param **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_z` **(** :ref:`Param` param **)** const | +| :ref:`float` | :ref:`get_param_z` **(** :ref:`Param` param **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag_x` **(** :ref:`Flag` flag, :ref:`bool` value **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1649,37 +1649,37 @@ Method Descriptions .. _class_Generic6DOFJoint_method_get_flag_x: -- :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** const +- :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| ---- .. _class_Generic6DOFJoint_method_get_flag_y: -- :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** const +- :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| ---- .. _class_Generic6DOFJoint_method_get_flag_z: -- :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** const +- :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| ---- .. _class_Generic6DOFJoint_method_get_param_x: -- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** const +- :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| ---- .. _class_Generic6DOFJoint_method_get_param_y: -- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** const +- :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| ---- .. _class_Generic6DOFJoint_method_get_param_z: -- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** const +- :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| ---- @@ -1717,3 +1717,6 @@ Method Descriptions - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index ab46e3448..a9cc6d44c 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -72,7 +72,7 @@ Methods +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`offset_polyline_2d` **(** :ref:`PoolVector2Array` polyline, :ref:`float` delta, :ref:`PolyJoinType` join_type=0, :ref:`PolyEndType` end_type=3 **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | +| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** |const| | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -394,7 +394,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. _class_Geometry_method_point_is_inside_triangle: -- :ref:`bool` **point_is_inside_triangle** **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const +- :ref:`bool` **point_is_inside_triangle** **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** |const| Returns if ``point`` is inside the triangle specified by ``a``, ``b`` and ``c``. @@ -470,3 +470,6 @@ Triangulates the area specified by discrete set of ``points`` such that no point Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PoolIntArray` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray` is returned. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index a289a9aba..740b3bf62 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -45,7 +45,7 @@ Methods ------- +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** const | +| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** |const| | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_aabb` **(** :ref:`AABB` aabb **)** | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -241,7 +241,7 @@ Method Descriptions .. _class_GeometryInstance_method_get_flag: -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** const +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| Returns the :ref:`Flags` that have been set for this object. @@ -261,3 +261,6 @@ Overrides the bounding box of this node with a custom one. To remove it, set an Sets the :ref:`Flags` specified. See :ref:`Flags` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 43c4f6209..79b0333f6 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -264,3 +264,6 @@ Bakes the effect from all :ref:`GeometryInstance`\ s mar Calls :ref:`bake` with ``create_visual_debug`` enabled. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 0948ef259..34f0f981a 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -195,3 +195,6 @@ Property Descriptions | *Getter* | get_to_cell_xform() | +-----------+-----------------------------------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index 60acd1496..a10289014 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -110,3 +110,6 @@ Returns ``true`` if the Mono runtime is shutting down, ``false`` otherwise. Returns ``true`` if the scripts domain is loaded, ``false`` otherwise. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index e19424ee1..f38f95916 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -33,11 +33,11 @@ Methods +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | +| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | +| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | +| :ref:`int` | :ref:`get_point_count` **(** **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ @@ -94,7 +94,7 @@ Adds the specified color to the end of the ramp, with the specified offset. .. _class_Gradient_method_get_color: -- :ref:`Color` **get_color** **(** :ref:`int` point **)** const +- :ref:`Color` **get_color** **(** :ref:`int` point **)** |const| Returns the color of the ramp color at index ``point``. @@ -102,7 +102,7 @@ Returns the color of the ramp color at index ``point``. .. _class_Gradient_method_get_offset: -- :ref:`float` **get_offset** **(** :ref:`int` point **)** const +- :ref:`float` **get_offset** **(** :ref:`int` point **)** |const| Returns the offset of the ramp color at index ``point``. @@ -110,7 +110,7 @@ Returns the offset of the ramp color at index ``point``. .. _class_Gradient_method_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** |const| Returns the number of colors in the ramp. @@ -146,3 +146,6 @@ Sets the color of the ramp color at index ``point``. Sets the offset for the ramp color at index ``point``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 61c6efe02..777c01f0c 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -58,3 +58,6 @@ The :ref:`Gradient` that will be used to fill the texture. The number of color samples that will be obtained from the :ref:`Gradient`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index c67a9bfa5..4475bfb28 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -55,13 +55,13 @@ Methods +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_list` **(** **)** const | +| :ref:`Array` | :ref:`get_connection_list` **(** **)** |const| | +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`HBoxContainer` | :ref:`get_zoom_hbox` **(** **)** | +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** const | +| :ref:`bool` | :ref:`is_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** |const| | +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -352,7 +352,7 @@ Removes the connection between the ``from_port`` slot of the ``from`` GraphNode .. _class_GraphEdit_method_get_connection_list: -- :ref:`Array` **get_connection_list** **(** **)** const +- :ref:`Array` **get_connection_list** **(** **)** |const| Returns an Array containing the list of connections. A connection consists in a structure of the form ``{ from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" }``. @@ -378,7 +378,7 @@ Returns ``true`` if the ``from_port`` slot of the ``from`` GraphNode is connecte .. _class_GraphEdit_method_is_valid_connection_type: -- :ref:`bool` **is_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** const +- :ref:`bool` **is_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** |const| Returns whether it's possible to connect slots of the specified types. @@ -422,3 +422,6 @@ Sets the coloration of the connection between ``from``'s ``from_port`` and ``to` Sets the specified ``node`` as the one selected. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index f0f4e186f..80e23c941 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -65,17 +65,17 @@ Methods +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | +| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | +| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -387,7 +387,7 @@ Returns the type of the output connection ``idx``. .. _class_GraphNode_method_get_slot_color_left: -- :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** |const| Returns the color set to ``idx`` left (input) slot. @@ -395,7 +395,7 @@ Returns the color set to ``idx`` left (input) slot. .. _class_GraphNode_method_get_slot_color_right: -- :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** |const| Returns the color set to ``idx`` right (output) slot. @@ -403,7 +403,7 @@ Returns the color set to ``idx`` right (output) slot. .. _class_GraphNode_method_get_slot_type_left: -- :ref:`int` **get_slot_type_left** **(** :ref:`int` idx **)** const +- :ref:`int` **get_slot_type_left** **(** :ref:`int` idx **)** |const| Returns the (integer) type of left (input) ``idx`` slot. @@ -411,7 +411,7 @@ Returns the (integer) type of left (input) ``idx`` slot. .. _class_GraphNode_method_get_slot_type_right: -- :ref:`int` **get_slot_type_right** **(** :ref:`int` idx **)** const +- :ref:`int` **get_slot_type_right** **(** :ref:`int` idx **)** |const| Returns the (integer) type of right (output) ``idx`` slot. @@ -419,7 +419,7 @@ Returns the (integer) type of right (output) ``idx`` slot. .. _class_GraphNode_method_is_slot_enabled_left: -- :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** |const| Returns ``true`` if left (input) slot ``idx`` is enabled, ``false`` otherwise. @@ -427,7 +427,7 @@ Returns ``true`` if left (input) slot ``idx`` is enabled, ``false`` otherwise. .. _class_GraphNode_method_is_slot_enabled_right: -- :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** |const| Returns ``true`` if right (output) slot ``idx`` is enabled, ``false`` otherwise. @@ -449,3 +449,6 @@ If ``enable_left``/``right``, a port will appear and the slot will be able to be **Note:** This method only sets properties of the slot. To create the slot, add a :ref:`Control`-derived child to the GraphNode. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 327ccc89e..a4ef9ad22 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -11,15 +11,17 @@ GridContainer **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -Grid container used to arrange elements in a grid like layout. +Grid container used to arrange Control-derived children in a grid like layout. Description ----------- -Grid container will arrange its children in a grid like structure, the grid columns are specified using the :ref:`columns` property 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. +GridContainer will arrange its Control-derived children in a grid like structure, the grid columns are specified using the :ref:`columns` property 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, and that empty columns will be expanded automatically. +**Note:** GridContainer only works with child nodes inheriting from Control. It won't rearrange child nodes inheriting from Node2D. + Properties ---------- @@ -53,5 +55,8 @@ Property Descriptions | *Getter* | get_columns() | +-----------+--------------------+ -The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout. +The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its Control-derived children to accommodate the new layout. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 2b194db43..4669d3e03 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -64,21 +64,21 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_bake_meshes` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | +| :ref:`int` | :ref:`get_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | +| :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_meshes` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | +| :ref:`Array` | :ref:`get_used_cells` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_baked_meshes` **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`map_to_world` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | +| :ref:`Vector3` | :ref:`map_to_world` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -90,7 +90,7 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`world_to_map` **(** :ref:`Vector3` pos **)** const | +| :ref:`Vector3` | :ref:`world_to_map` **(** :ref:`Vector3` pos **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -242,7 +242,7 @@ GridMaps act as static bodies, meaning they aren't affected by gravity or other | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The physics layers this GridMap detects collisions in. +The physics layers this GridMap detects collisions in. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -289,7 +289,7 @@ Clear all cells. .. _class_GridMap_method_get_cell_item: -- :ref:`int` **get_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const +- :ref:`int` **get_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** |const| The :ref:`MeshLibrary` item index located at the grid-based X, Y and Z coordinates. If the cell is empty, :ref:`INVALID_CELL_ITEM` will be returned. @@ -297,7 +297,7 @@ The :ref:`MeshLibrary` item index located at the grid-based X .. _class_GridMap_method_get_cell_item_orientation: -- :ref:`int` **get_cell_item_orientation** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const +- :ref:`int` **get_cell_item_orientation** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** |const| The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty. @@ -305,7 +305,7 @@ The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is retu .. _class_GridMap_method_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the :ref:`collision_layer`. @@ -313,7 +313,7 @@ Returns an individual bit on the :ref:`collision_layer` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the :ref:`collision_mask`. @@ -329,7 +329,7 @@ Returns an array of :ref:`Transform` and :ref:`Mesh .. _class_GridMap_method_get_used_cells: -- :ref:`Array` **get_used_cells** **(** **)** const +- :ref:`Array` **get_used_cells** **(** **)** |const| Returns an array of :ref:`Vector3` with the non-empty cell coordinates in the grid map. @@ -343,7 +343,7 @@ Returns an array of :ref:`Vector3` with the non-empty cell coordi .. _class_GridMap_method_map_to_world: -- :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const +- :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** |const| Returns the position of a grid cell in the GridMap's local coordinate space. @@ -391,9 +391,12 @@ Sets an individual bit on the :ref:`collision_mask` **world_to_map** **(** :ref:`Vector3` pos **)** const +- :ref:`Vector3` **world_to_map** **(** :ref:`Vector3` pos **)** |const| Returns the coordinates of the grid cell containing the given point. ``pos`` should be in the GridMap's local coordinate space. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 6cc2530f2..edce82a21 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -60,3 +60,6 @@ The body B's initial anchor position defined by the joint's origin and a local o The groove's length. The groove is from the joint's origin towards :ref:`length` along the joint's local Y axis. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_hashingcontext.rst b/classes/class_hashingcontext.rst index 355ea4bfe..69fccdb25 100644 --- a/classes/class_hashingcontext.rst +++ b/classes/class_hashingcontext.rst @@ -99,3 +99,6 @@ Starts a new hash computation of the given ``type`` (e.g. :ref:`HASH_SHA256` | separation | 4 | +-----------------------+------------+---+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_heightmapshape.rst b/classes/class_heightmapshape.rst index 4f8f47b29..be4d6ec79 100644 --- a/classes/class_heightmapshape.rst +++ b/classes/class_heightmapshape.rst @@ -78,3 +78,6 @@ Depth of the height map data. Changing this will resize the :ref:`map_data`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index e29d1b97c..557939438 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -47,9 +47,9 @@ Methods ------- +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flag` flag **)** const | +| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flag` flag **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** const | +| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag` **(** :ref:`Flag` flag, :ref:`bool` enabled **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -273,7 +273,7 @@ Method Descriptions .. _class_HingeJoint_method_get_flag: -- :ref:`bool` **get_flag** **(** :ref:`Flag` flag **)** const +- :ref:`bool` **get_flag** **(** :ref:`Flag` flag **)** |const| Returns the value of the specified flag. @@ -281,7 +281,7 @@ Returns the value of the specified flag. .. _class_HingeJoint_method_get_param: -- :ref:`float` **get_param** **(** :ref:`Param` param **)** const +- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| Returns the value of the specified parameter. @@ -301,3 +301,6 @@ If ``true``, enables the specified flag. Sets the value of the specified parameter. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index 3359a00c7..19c6e4c4d 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -41,3 +41,6 @@ Theme Properties | :ref:`StyleBox` | scroll_focus | +---------------------------------+---------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index 3fec79c5e..847d177a0 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -27,3 +27,6 @@ Theme Properties | :ref:`StyleBox` | separator | | +---------------------------------+------------+---+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index 7d157c759..0b1926e20 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -18,6 +18,8 @@ Description Horizontal slider. See :ref:`Slider`. This one goes from left (min) to right (max). +**Note:** The :ref:`Range.changed` and :ref:`Range.value_changed` signals are part of the :ref:`Range` class which this class inherits from. + Theme Properties ---------------- @@ -37,3 +39,6 @@ Theme Properties | :ref:`Texture` | tick | +---------------------------------+------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index a799a6a74..20e308b6c 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -31,3 +31,6 @@ Theme Properties | :ref:`int` | separation | 12 | +---------------------------------+------------+----+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index b32afd311..dca5dfd89 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -11,12 +11,12 @@ HTTPClient **Inherits:** :ref:`Reference` **<** :ref:`Object` -Hyper-text transfer protocol client. +Low-level hyper-text transfer protocol client. Description ----------- -Hyper-text transfer protocol client (sometimes called "User Agent"). Used to make HTTP requests to download web content, upload files and other data or to communicate with various services, among other use cases. See :ref:`HTTPRequest` for an higher-level alternative. +Hyper-text transfer protocol client (sometimes called "User Agent"). Used to make HTTP requests to download web content, upload files and other data or to communicate with various services, among other use cases. **See the :ref:`HTTPRequest` node for an higher-level alternative.** **Note:** This client only needs to connect to a host once (see :ref:`connect_to_host`) to send multiple requests. Because of this, methods that take URLs usually take just the part after the host instead of the full URL, as the client is already connected to a host. See :ref:`request` for a full example and to get started. @@ -52,19 +52,19 @@ Methods +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_response_body_length` **(** **)** const | +| :ref:`int` | :ref:`get_response_body_length` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_response_code` **(** **)** const | +| :ref:`int` | :ref:`get_response_code` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_response_headers` **(** **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** const | +| :ref:`Status` | :ref:`get_status` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_response` **(** **)** const | +| :ref:`bool` | :ref:`has_response` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | +| :ref:`bool` | :ref:`is_response_chunked` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`poll` **(** **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -494,7 +494,7 @@ If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 f .. _class_HTTPClient_method_get_response_body_length: -- :ref:`int` **get_response_body_length** **(** **)** const +- :ref:`int` **get_response_body_length** **(** **)** |const| Returns the response's body length. @@ -504,7 +504,7 @@ Returns the response's body length. .. _class_HTTPClient_method_get_response_code: -- :ref:`int` **get_response_code** **(** **)** const +- :ref:`int` **get_response_code** **(** **)** |const| Returns the response's HTTP status code. @@ -537,7 +537,7 @@ Returns all response headers as a Dictionary of structure ``{ "key": "value1; va .. _class_HTTPClient_method_get_status: -- :ref:`Status` **get_status** **(** **)** const +- :ref:`Status` **get_status** **(** **)** |const| Returns a :ref:`Status` constant. Need to call :ref:`poll` in order to get status updates. @@ -545,7 +545,7 @@ Returns a :ref:`Status` constant. Need to call :ref:`pol .. _class_HTTPClient_method_has_response: -- :ref:`bool` **has_response** **(** **)** const +- :ref:`bool` **has_response** **(** **)** |const| If ``true``, this ``HTTPClient`` has a response available. @@ -553,7 +553,7 @@ If ``true``, this ``HTTPClient`` has a response available. .. _class_HTTPClient_method_is_response_chunked: -- :ref:`bool` **is_response_chunked** **(** **)** const +- :ref:`bool` **is_response_chunked** **(** **)** |const| If ``true``, this ``HTTPClient`` has a response that is chunked. @@ -614,6 +614,8 @@ To create a POST request with query strings to push to the server, do: var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(query_string.length())] var result = http_client.request(http_client.METHOD_POST, "index.php", headers, query_string) +**Note:** The ``request_data`` parameter is ignored if ``method`` is :ref:`METHOD_GET`. This is because GET methods can't contain request data. As a workaround, you can pass request data as a query string in the URL. See :ref:`String.http_escape` for an example. + ---- .. _class_HTTPClient_method_request_raw: @@ -626,3 +628,6 @@ Headers are HTTP request headers. For available HTTP methods, see :ref:`Method` **(** **)** | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size` **(** **)** const | +| :ref:`int` | :ref:`get_body_size` **(** **)** |const| | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | +| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** |const| | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_http_client_status` **(** **)** const | +| :ref:`Status` | :ref:`get_http_client_status` **(** **)** |const| | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -301,7 +301,7 @@ Cancels the current request. .. _class_HTTPRequest_method_get_body_size: -- :ref:`int` **get_body_size** **(** **)** const +- :ref:`int` **get_body_size** **(** **)** |const| Returns the response body length. @@ -311,7 +311,7 @@ Returns the response body length. .. _class_HTTPRequest_method_get_downloaded_bytes: -- :ref:`int` **get_downloaded_bytes** **(** **)** const +- :ref:`int` **get_downloaded_bytes** **(** **)** |const| Returns the amount of bytes this HTTPRequest downloaded. @@ -319,7 +319,7 @@ Returns the amount of bytes this HTTPRequest downloaded. .. _class_HTTPRequest_method_get_http_client_status: -- :ref:`Status` **get_http_client_status** **(** **)** const +- :ref:`Status` **get_http_client_status** **(** **)** |const| Returns the current status of the underlying :ref:`HTTPClient`. See :ref:`Status`. @@ -333,3 +333,8 @@ Creates request on the underlying :ref:`HTTPClient`. If there Returns :ref:`@GlobalScope.OK` if request is successfully created. (Does not imply that the server has responded), :ref:`@GlobalScope.ERR_UNCONFIGURED` if not in the tree, :ref:`@GlobalScope.ERR_BUSY` if still processing previous request, :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if given string is not a valid URL format, or :ref:`@GlobalScope.ERR_CANT_CONNECT` if not using thread and the :ref:`HTTPClient` cannot connect to host. +**Note:** The ``request_data`` parameter is ignored if ``method`` is :ref:`HTTPClient.METHOD_GET`. This is because GET methods can't contain request data. As a workaround, you can pass request data as a query string in the URL. See :ref:`String.http_escape` for an example. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_image.rst b/classes/class_image.rst index 12517e543..ef3135cce 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -57,7 +57,7 @@ Methods +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`decompress` **(** **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AlphaMode` | :ref:`detect_alpha` **(** **)** const | +| :ref:`AlphaMode` | :ref:`detect_alpha` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`expand_x2_hq2x` **(** **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -71,33 +71,33 @@ Methods +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`generate_mipmaps` **(** :ref:`bool` renormalize=false **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | +| :ref:`Format` | :ref:`get_format` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | +| :ref:`int` | :ref:`get_height` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mipmap_offset` **(** :ref:`int` mipmap **)** const | +| :ref:`int` | :ref:`get_mipmap_offset` **(** :ref:`int` mipmap **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** const | +| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pixelv` **(** :ref:`Vector2` src **)** const | +| :ref:`Color` | :ref:`get_pixelv` **(** :ref:`Vector2` src **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | +| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_size` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | +| :ref:`int` | :ref:`get_width` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_mipmaps` **(** **)** const | +| :ref:`bool` | :ref:`has_mipmaps` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_compressed` **(** **)** const | +| :ref:`bool` | :ref:`is_compressed` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** const | +| :ref:`bool` | :ref:`is_empty` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_invisible` **(** **)** const | +| :ref:`bool` | :ref:`is_invisible` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -121,11 +121,11 @@ Methods +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`rgbe_to_srgb` **(** **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_exr` **(** :ref:`String` path, :ref:`bool` grayscale=false **)** const | +| :ref:`Error` | :ref:`save_exr` **(** :ref:`String` path, :ref:`bool` grayscale=false **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** const | +| :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`save_png_to_buffer` **(** **)** const | +| :ref:`PoolByteArray` | :ref:`save_png_to_buffer` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -546,7 +546,7 @@ Decompresses the image if it is compressed. Returns an error if decompress funct .. _class_Image_method_detect_alpha: -- :ref:`AlphaMode` **detect_alpha** **(** **)** const +- :ref:`AlphaMode` **detect_alpha** **(** **)** |const| Returns :ref:`ALPHA_BLEND` if the image has data for alpha values. Returns :ref:`ALPHA_BIT` if all the alpha values are stored in a single bit. Returns :ref:`ALPHA_NONE` if no data for alpha values is found. @@ -602,15 +602,15 @@ Generates mipmaps for the image. Mipmaps are pre-calculated and lower resolution .. _class_Image_method_get_data: -- :ref:`PoolByteArray` **get_data** **(** **)** const +- :ref:`PoolByteArray` **get_data** **(** **)** |const| -Returns the image's raw data. +Returns a copy of the image's raw data. ---- .. _class_Image_method_get_format: -- :ref:`Format` **get_format** **(** **)** const +- :ref:`Format` **get_format** **(** **)** |const| Returns the image's format. See :ref:`Format` constants. @@ -618,7 +618,7 @@ Returns the image's format. See :ref:`Format` constants. .. _class_Image_method_get_height: -- :ref:`int` **get_height** **(** **)** const +- :ref:`int` **get_height** **(** **)** |const| Returns the image's height. @@ -626,7 +626,7 @@ Returns the image's height. .. _class_Image_method_get_mipmap_offset: -- :ref:`int` **get_mipmap_offset** **(** :ref:`int` mipmap **)** const +- :ref:`int` **get_mipmap_offset** **(** :ref:`int` mipmap **)** |const| Returns the offset where the image's mipmap with index ``mipmap`` is stored in the ``data`` dictionary. @@ -634,7 +634,7 @@ Returns the offset where the image's mipmap with index ``mipmap`` is stored in t .. _class_Image_method_get_pixel: -- :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** |const| Returns the color of the pixel at ``(x, y)`` if the image is locked. If the image is unlocked, it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. This is the same as :ref:`get_pixelv`, but two integer arguments instead of a Vector2 argument. @@ -642,7 +642,7 @@ Returns the color of the pixel at ``(x, y)`` if the image is locked. If the imag .. _class_Image_method_get_pixelv: -- :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** const +- :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** |const| Returns the color of the pixel at ``src`` if the image is locked. If the image is unlocked, it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. This is the same as :ref:`get_pixel`, but with a Vector2 argument instead of two integer arguments. @@ -650,7 +650,7 @@ Returns the color of the pixel at ``src`` if the image is locked. If the image i .. _class_Image_method_get_rect: -- :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** const +- :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** |const| Returns a new image that is a copy of the image's area specified with ``rect``. @@ -658,7 +658,7 @@ Returns a new image that is a copy of the image's area specified with ``rect``. .. _class_Image_method_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** |const| Returns the image's size (width and height). @@ -666,7 +666,7 @@ Returns the image's size (width and height). .. _class_Image_method_get_used_rect: -- :ref:`Rect2` **get_used_rect** **(** **)** const +- :ref:`Rect2` **get_used_rect** **(** **)** |const| Returns a :ref:`Rect2` enclosing the visible portion of the image, considering each pixel with a non-zero alpha channel as visible. @@ -674,7 +674,7 @@ Returns a :ref:`Rect2` enclosing the visible portion of the image, .. _class_Image_method_get_width: -- :ref:`int` **get_width** **(** **)** const +- :ref:`int` **get_width** **(** **)** |const| Returns the image's width. @@ -682,7 +682,7 @@ Returns the image's width. .. _class_Image_method_has_mipmaps: -- :ref:`bool` **has_mipmaps** **(** **)** const +- :ref:`bool` **has_mipmaps** **(** **)** |const| Returns ``true`` if the image has generated mipmaps. @@ -690,7 +690,7 @@ Returns ``true`` if the image has generated mipmaps. .. _class_Image_method_is_compressed: -- :ref:`bool` **is_compressed** **(** **)** const +- :ref:`bool` **is_compressed** **(** **)** |const| Returns ``true`` if the image is compressed. @@ -698,7 +698,7 @@ Returns ``true`` if the image is compressed. .. _class_Image_method_is_empty: -- :ref:`bool` **is_empty** **(** **)** const +- :ref:`bool` **is_empty** **(** **)** |const| Returns ``true`` if the image has no data. @@ -706,7 +706,7 @@ Returns ``true`` if the image has no data. .. _class_Image_method_is_invisible: -- :ref:`bool` **is_invisible** **(** **)** const +- :ref:`bool` **is_invisible** **(** **)** |const| Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``false`` if any pixel has an alpha value higher than 0. @@ -802,7 +802,7 @@ Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image. .. _class_Image_method_save_exr: -- :ref:`Error` **save_exr** **(** :ref:`String` path, :ref:`bool` grayscale=false **)** const +- :ref:`Error` **save_exr** **(** :ref:`String` path, :ref:`bool` grayscale=false **)** |const| Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE` if Godot was compiled without the TinyEXR module. @@ -810,7 +810,7 @@ Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the .. _class_Image_method_save_png: -- :ref:`Error` **save_png** **(** :ref:`String` path **)** const +- :ref:`Error` **save_png** **(** :ref:`String` path **)** |const| Saves the image as a PNG file to ``path``. @@ -818,7 +818,7 @@ Saves the image as a PNG file to ``path``. .. _class_Image_method_save_png_to_buffer: -- :ref:`PoolByteArray` **save_png_to_buffer** **(** **)** const +- :ref:`PoolByteArray` **save_png_to_buffer** **(** **)** |const| ---- @@ -878,3 +878,6 @@ Converts the raw data from the sRGB colorspace to a linear scale. Unlocks the data and prevents changes. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index eb4d74302..e6f127e5f 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -39,7 +39,7 @@ Methods +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | +| :ref:`Format` | :ref:`get_format` **(** **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -123,7 +123,7 @@ Create a new ``ImageTexture`` from an :ref:`Image` with ``flags`` f .. _class_ImageTexture_method_get_format: -- :ref:`Format` **get_format** **(** **)** const +- :ref:`Format` **get_format** **(** **)** |const| Returns the format of the ``ImageTexture``, one of :ref:`Format`. @@ -151,3 +151,6 @@ Sets the :ref:`Image` of this ``ImageTexture``. Resizes the ``ImageTexture`` to the specified dimensions. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index 4ade5c813..7e95002dd 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -132,3 +132,6 @@ The next vertex's UV. The next vertex's second layer UV. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_input.rst b/classes/class_input.rst index 02f8774f2..b81ba9bf9 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -33,19 +33,19 @@ Methods +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | +| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | +| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CursorShape` | :ref:`get_current_cursor_shape` **(** **)** const | +| :ref:`CursorShape` | :ref:`get_current_cursor_shape` **(** **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | +| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | +| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,7 +55,7 @@ Methods +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | +| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -63,27 +63,27 @@ Methods +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | +| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | +| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | +| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** const | +| :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | +| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | +| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | +| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** |const| | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`joy_connection_changed` **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -136,7 +136,9 @@ enum **MouseMode**: - **MOUSE_MODE_HIDDEN** = **1** --- Makes the mouse cursor hidden if it is visible. -- **MOUSE_MODE_CAPTURED** = **2** --- Captures the mouse. The mouse will be hidden and unable to leave the game window, but it will still register movement and mouse button presses. On Windows and Linux, the mouse will use raw input mode, which means the reported movement will be unaffected by the OS' mouse acceleration settings. +- **MOUSE_MODE_CAPTURED** = **2** --- Captures the mouse. The mouse will be hidden and its position locked at the center of the screen. + +**Note:** If you want to process the mouse's movement in this mode, you need to use :ref:`InputEventMouseMotion.relative`. - **MOUSE_MODE_CONFINED** = **3** --- Makes the mouse cursor visible but confines it to the game window. @@ -247,17 +249,19 @@ Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally up .. _class_Input_method_get_accelerometer: -- :ref:`Vector3` **get_accelerometer** **(** **)** const +- :ref:`Vector3` **get_accelerometer** **(** **)** |const| -If the device has an accelerometer, this will return the acceleration. Otherwise, it returns an empty :ref:`Vector3`. +Returns the acceleration of the device's accelerometer, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. Note this method returns an empty :ref:`Vector3` when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer. +**Note:** This method only works on iOS, Android, and UWP. On other platforms, it always returns :ref:`Vector3.ZERO`. + ---- .. _class_Input_method_get_action_strength: -- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const +- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** |const| Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1. @@ -273,7 +277,7 @@ Returns an :ref:`Array` containing the device IDs of all currently .. _class_Input_method_get_current_cursor_shape: -- :ref:`CursorShape` **get_current_cursor_shape** **(** **)** const +- :ref:`CursorShape` **get_current_cursor_shape** **(** **)** |const| Returns the currently assigned cursor shape (see :ref:`CursorShape`). @@ -281,23 +285,27 @@ Returns the currently assigned cursor shape (see :ref:`CursorShape` **get_gravity** **(** **)** const +- :ref:`Vector3` **get_gravity** **(** **)** |const| -If the device has an accelerometer, this will return the gravity. Otherwise, it returns an empty :ref:`Vector3`. +Returns the gravity of the device's accelerometer, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. + +**Note:** This method only works on Android and iOS. On other platforms, it always returns :ref:`Vector3.ZERO`. ---- .. _class_Input_method_get_gyroscope: -- :ref:`Vector3` **get_gyroscope** **(** **)** const +- :ref:`Vector3` **get_gyroscope** **(** **)** |const| -If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's X, Y, and Z axes. Otherwise, it returns an empty :ref:`Vector3`. +Returns the rotation rate in rad/s around a device's X, Y, and Z axes of the gyroscope, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. + +**Note:** This method only works on Android. On other platforms, it always returns :ref:`Vector3.ZERO`. ---- .. _class_Input_method_get_joy_axis: -- :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const +- :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** |const| Returns the current value of the joypad axis at given index (see :ref:`JoystickList`). @@ -337,7 +345,7 @@ Receives a gamepad button from :ref:`JoystickList` **get_joy_guid** **(** :ref:`int` device **)** const +- :ref:`String` **get_joy_guid** **(** :ref:`int` device **)** |const| Returns a SDL2-compatible device GUID on platforms that use gamepad remapping. Returns ``"Default Gamepad"`` otherwise. @@ -369,7 +377,7 @@ Returns the strength of the joypad vibration: x is the strength of the weak moto .. _class_Input_method_get_last_mouse_speed: -- :ref:`Vector2` **get_last_mouse_speed** **(** **)** const +- :ref:`Vector2` **get_last_mouse_speed** **(** **)** |const| Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion. @@ -377,15 +385,17 @@ Returns the mouse speed for the last time the cursor was moved, and this until t .. _class_Input_method_get_magnetometer: -- :ref:`Vector3` **get_magnetometer** **(** **)** const +- :ref:`Vector3` **get_magnetometer** **(** **)** |const| -If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. +Returns the the magnetic field strength in micro-Tesla for all axes of the device's magnetometer, if the device has one. Otherwise, the method returns :ref:`Vector3.ZERO`. + +**Note:** This method only works on Android and UWP. On other platforms, it always returns :ref:`Vector3.ZERO`. ---- .. _class_Input_method_get_mouse_button_mask: -- :ref:`int` **get_mouse_button_mask** **(** **)** const +- :ref:`int` **get_mouse_button_mask** **(** **)** |const| Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. @@ -393,7 +403,7 @@ Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the .. _class_Input_method_get_mouse_mode: -- :ref:`MouseMode` **get_mouse_mode** **(** **)** const +- :ref:`MouseMode` **get_mouse_mode** **(** **)** |const| Returns the mouse mode. See the constants for more information. @@ -401,7 +411,7 @@ Returns the mouse mode. See the constants for more information. .. _class_Input_method_is_action_just_pressed: -- :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** |const| Returns ``true`` when the user starts pressing the action event, meaning it's ``true`` only on the frame that the user pressed down the button. @@ -411,7 +421,7 @@ This is useful for code that needs to run only once when an action is pressed, i .. _class_Input_method_is_action_just_released: -- :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** |const| Returns ``true`` when the user stops pressing the action event, meaning it's ``true`` only on the frame that the user released the button. @@ -419,7 +429,7 @@ Returns ``true`` when the user stops pressing the action event, meaning it's ``t .. _class_Input_method_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** |const| Returns ``true`` if you are pressing the action event. Note that if an action has multiple buttons assigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. @@ -427,7 +437,7 @@ Returns ``true`` if you are pressing the action event. Note that if an action ha .. _class_Input_method_is_joy_button_pressed: -- :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const +- :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** |const| Returns ``true`` if you are pressing the joypad button (see :ref:`JoystickList`). @@ -443,7 +453,7 @@ Returns ``true`` if the system knows the specified device. This means that it se .. _class_Input_method_is_key_pressed: -- :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** const +- :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** |const| Returns ``true`` if you are pressing the key. You can pass a :ref:`KeyList` constant. @@ -451,7 +461,7 @@ Returns ``true`` if you are pressing the key. You can pass a :ref:`KeyList` **is_mouse_button_pressed** **(** :ref:`int` button **)** const +- :ref:`bool` **is_mouse_button_pressed** **(** :ref:`int` button **)** |const| Returns ``true`` if you are pressing the mouse button specified with :ref:`ButtonList`. @@ -572,3 +582,6 @@ Vibrate Android and iOS devices. Sets the mouse position to the specified vector. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 7fe812942..bbf69418f 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -37,29 +37,29 @@ Properties Methods ------- -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`accumulate` **(** :ref:`InputEvent` with_event **)** | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`as_text` **(** **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action, :ref:`bool` allow_echo=false **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_type` **(** **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`accumulate` **(** :ref:`InputEvent` with_event **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`as_text` **(** **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action, :ref:`bool` allow_echo=false **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_type` **(** **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_echo` **(** **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** |const| | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -95,7 +95,7 @@ The given input event's position, global position and speed will be copied. The .. _class_InputEvent_method_as_text: -- :ref:`String` **as_text** **(** **)** const +- :ref:`String` **as_text** **(** **)** |const| Returns a :ref:`String` representation of the event. @@ -103,7 +103,7 @@ Returns a :ref:`String` representation of the event. .. _class_InputEvent_method_get_action_strength: -- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const +- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** |const| Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type :ref:`InputEventJoypadMotion`. @@ -111,7 +111,7 @@ Returns a value between 0.0 and 1.0 depending on the given actions' state. Usefu .. _class_InputEvent_method_is_action: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action** **(** :ref:`String` action **)** |const| Returns ``true`` if this input event matches a pre-defined action of any type. @@ -119,7 +119,7 @@ Returns ``true`` if this input event matches a pre-defined action of any type. .. _class_InputEvent_method_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action, :ref:`bool` allow_echo=false **)** const +- :ref:`bool` **is_action_pressed** **(** :ref:`String` action, :ref:`bool` allow_echo=false **)** |const| Returns ``true`` if the given action is being pressed (and is not an echo event for :ref:`InputEventKey` events, unless ``allow_echo`` is ``true``). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -127,7 +127,7 @@ Returns ``true`` if the given action is being pressed (and is not an echo event .. _class_InputEvent_method_is_action_released: -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** |const| Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -135,7 +135,7 @@ Returns ``true`` if the given action is released (i.e. not pressed). Not relevan .. _class_InputEvent_method_is_action_type: -- :ref:`bool` **is_action_type** **(** **)** const +- :ref:`bool` **is_action_type** **(** **)** |const| Returns ``true`` if this input event's type is one that can be assigned to an input action. @@ -143,7 +143,7 @@ Returns ``true`` if this input event's type is one that can be assigned to an in .. _class_InputEvent_method_is_echo: -- :ref:`bool` **is_echo** **(** **)** const +- :ref:`bool` **is_echo** **(** **)** |const| Returns ``true`` if this input event is an echo event (only for events of type :ref:`InputEventKey`). @@ -151,7 +151,7 @@ Returns ``true`` if this input event is an echo event (only for events of type : .. _class_InputEvent_method_is_pressed: -- :ref:`bool` **is_pressed** **(** **)** const +- :ref:`bool` **is_pressed** **(** **)** |const| Returns ``true`` if this input event is pressed. Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -159,7 +159,7 @@ Returns ``true`` if this input event is pressed. Not relevant for events of type .. _class_InputEvent_method_shortcut_match: -- :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const +- :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** |const| Returns ``true`` if the given input event is checking for the same key (:ref:`InputEventKey`), button (:ref:`InputEventJoypadButton`) or action (:ref:`InputEventAction`). @@ -167,7 +167,10 @@ Returns ``true`` if the given input event is checking for the same key (:ref:`In .. _class_InputEvent_method_xformed_by: -- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const +- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** |const| Returns a copy of the given input event which has been offset by ``local_ofs`` and transformed by ``xform``. Relevant for events of type :ref:`InputEventMouseButton`, :ref:`InputEventMouseMotion`, :ref:`InputEventScreenTouch`, :ref:`InputEventScreenDrag`, :ref:`InputEventMagnifyGesture` and :ref:`InputEventPanGesture`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index c7cff69b3..466f46fc9 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -83,3 +83,6 @@ If ``true``, the action's state is pressed. If ``false``, the action's state is The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is ``false``. The event strength allows faking analog joypad motion events, by precising how strongly is the joypad axis bent or pressed. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index c54267cf5..6068914d8 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -39,3 +39,6 @@ Property Descriptions The local gesture position relative to the :ref:`Viewport`. If used in :ref:`Control._gui_input`, the position is relative to the current :ref:`Control` that received this gesture. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index b7ce88f79..11fea0940 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -83,3 +83,6 @@ If ``true``, the button's state is pressed. If ``false``, the button's state is Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 372f8869b..f00d2ccca 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -65,3 +65,6 @@ Axis identifier. Use one of the :ref:`JoystickList` | :ref:`get_scancode_with_modifiers` **(** **)** const | -+-----------------------+--------------------------------------------------------------------------------------------------------------+ ++-----------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_scancode_with_modifiers` **(** **)** |const| | ++-----------------------+----------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -115,9 +115,12 @@ Method Descriptions .. _class_InputEventKey_method_get_scancode_with_modifiers: -- :ref:`int` **get_scancode_with_modifiers** **(** **)** const +- :ref:`int` **get_scancode_with_modifiers** **(** **)** |const| Returns the scancode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers`. To get a human-readable representation of the ``InputEventKey`` with modifiers, use ``OS.get_scancode_string(event.get_scancode_with_modifiers())`` where ``event`` is the ``InputEventKey``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index 66649ae05..f34305e38 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -35,3 +35,6 @@ Property Descriptions | *Getter* | get_factor() | +-----------+-------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventmidi.rst b/classes/class_inputeventmidi.rst index 2fead0e9d..53169bab1 100644 --- a/classes/class_inputeventmidi.rst +++ b/classes/class_inputeventmidi.rst @@ -147,3 +147,6 @@ Property Descriptions | *Getter* | get_velocity() | +-----------+---------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index be5e6be21..548c74129 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -85,3 +85,6 @@ The global mouse position relative to the current :ref:`Viewport The local mouse position relative to the :ref:`Viewport`. If used in :ref:`Control._gui_input`, the position is relative to the current :ref:`Control` which is under the mouse. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index a2035d22c..db561d829 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -101,3 +101,6 @@ The amount (or delta) of the event. When used for high-precision scroll events, If ``true``, the mouse button's state is pressed. If ``false``, the mouse button's state is released. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index f2bc14390..1d4372acd 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -105,3 +105,6 @@ The mouse speed in pixels per second. Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from ``-1.0`` to ``1.0`` for both axes. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 837407420..bb5a247a4 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -35,3 +35,6 @@ Property Descriptions | *Getter* | get_delta() | +-----------+---------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 4dd3afd44..499aa7cf2 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -101,3 +101,6 @@ The drag position relative to its start position. The drag speed. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 278054fd3..65e471287 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -85,3 +85,6 @@ The touch position. If ``true``, the touch's state is pressed. If ``false``, the touch's state is released. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 2d63b955f..6eba57981 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -121,3 +121,6 @@ State of the ``Meta`` modifier. State of the ``Shift`` modifier. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 5ff0b8429..f82d5315a 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -26,31 +26,31 @@ Tutorials Methods ------- -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_erase_events` **(** :ref:`String` action **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_set_deadzone` **(** :ref:`String` action, :ref:`float` deadzone **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_action` **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_action` **(** :ref:`String` action **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`String` action **)** const | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_actions` **(** **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`load_from_globals` **(** **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_erase_events` **(** :ref:`String` action **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_set_deadzone` **(** :ref:`String` action, :ref:`float` deadzone **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_action` **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_action` **(** :ref:`String` action **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`String` action **)** |const| | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_actions` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** |const| | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`load_from_globals` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -115,7 +115,7 @@ Removes an action from the ``InputMap``. .. _class_InputMap_method_event_is_action: -- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`String` action **)** const +- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`String` action **)** |const| Returns ``true`` if the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent` is not pressed (for proper release detection). See :ref:`action_has_event` if you don't want this behavior. @@ -139,7 +139,7 @@ Returns an array of all actions in the ``InputMap``. .. _class_InputMap_method_has_action: -- :ref:`bool` **has_action** **(** :ref:`String` action **)** const +- :ref:`bool` **has_action** **(** :ref:`String` action **)** |const| Returns ``true`` if the ``InputMap`` has a registered action with the given name. @@ -151,3 +151,6 @@ Returns ``true`` if the ``InputMap`` has a registered action with the given name Clears all :ref:`InputEventAction` in the ``InputMap`` and load it anew from :ref:`ProjectSettings`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 0f9d452dd..80a67c3c6 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -26,7 +26,7 @@ Methods +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`create_instance` **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_instance_path` **(** **)** const | +| :ref:`String` | :ref:`get_instance_path` **(** **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -44,7 +44,7 @@ Method Descriptions .. _class_InstancePlaceholder_method_get_instance_path: -- :ref:`String` **get_instance_path** **(** **)** const +- :ref:`String` **get_instance_path** **(** **)** |const| Gets the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`replace_by_instance`. @@ -62,3 +62,6 @@ Gets the path to the :ref:`PackedScene` resource file that is Replaces this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_int.rst b/classes/class_int.rst index 2d2c975c9..6ece4a666 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -65,3 +65,6 @@ Cast a float value to an integer value, this method simply removes the number fr Cast a :ref:`String` value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like ``'1.7'``. This method will ignore all non-number characters, so calling ``int('1e3')`` will return 13. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index ab1cefd38..f982dbc72 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -96,3 +96,6 @@ Method Descriptions Sets the node to move toward and orient with. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_ip.rst b/classes/class_ip.rst index d08ca71a2..45eb17a89 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -26,13 +26,13 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | +| :ref:`Array` | :ref:`get_local_addresses` **(** **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_interfaces` **(** **)** const | +| :ref:`Array` | :ref:`get_local_interfaces` **(** **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | +| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResolverStatus` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | +| :ref:`ResolverStatus` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -116,7 +116,7 @@ Removes a given item ``id`` from the queue. This should be used to free a queue .. _class_IP_method_get_local_addresses: -- :ref:`Array` **get_local_addresses** **(** **)** const +- :ref:`Array` **get_local_addresses** **(** **)** |const| Returns all of the user's current IPv4 and IPv6 addresses as an array. @@ -124,7 +124,7 @@ Returns all of the user's current IPv4 and IPv6 addresses as an array. .. _class_IP_method_get_local_interfaces: -- :ref:`Array` **get_local_interfaces** **(** **)** const +- :ref:`Array` **get_local_interfaces** **(** **)** |const| Returns all network adapters as an array. @@ -143,7 +143,7 @@ Each adapter is a dictionary of the form: .. _class_IP_method_get_resolve_item_address: -- :ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** const +- :ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** |const| Returns a queued hostname's IP address, given its queue ``id``. Returns an empty string on error or if resolution hasn't happened yet (see :ref:`get_resolve_item_status`). @@ -151,7 +151,7 @@ Returns a queued hostname's IP address, given its queue ``id``. Returns an empty .. _class_IP_method_get_resolve_item_status: -- :ref:`ResolverStatus` **get_resolve_item_status** **(** :ref:`int` id **)** const +- :ref:`ResolverStatus` **get_resolve_item_status** **(** :ref:`int` id **)** |const| Returns a queued hostname's status as a :ref:`ResolverStatus` constant, given its queue ``id``. @@ -171,3 +171,6 @@ Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type met Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the :ref:`Type` constant given as ``ip_type``. Returns the queue ID if successful, or :ref:`RESOLVER_INVALID_ID` on error. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index d51eba244..f0997e5db 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -65,25 +65,25 @@ Methods +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_current_is_visible` **(** **)** | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const | +| :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | +| :ref:`int` | :ref:`get_item_count` **(** **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_custom_fg_color` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_item_custom_fg_color` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | +| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,15 +91,15 @@ Methods +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_anything_selected` **(** **)** | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_icon_transposed` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_item_icon_transposed` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_selectable` **(** :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_item_tooltip_enabled` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** |const| | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_item` **(** :ref:`int` from_idx, :ref:`int` to_idx **)** | +-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -485,7 +485,7 @@ Ensure current selection is visible, adjusting the scroll position as necessary. .. _class_ItemList_method_get_item_at_position: -- :ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const +- :ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** |const| Returns the item index at the given ``position``. @@ -495,7 +495,7 @@ When there is no item at that point, -1 will be returned if ``exact`` is ``true` .. _class_ItemList_method_get_item_count: -- :ref:`int` **get_item_count** **(** **)** const +- :ref:`int` **get_item_count** **(** **)** |const| Returns the number of items currently in the list. @@ -503,7 +503,7 @@ Returns the number of items currently in the list. .. _class_ItemList_method_get_item_custom_bg_color: -- :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** |const| Returns the custom background color of the item specified by ``idx`` index. @@ -511,7 +511,7 @@ Returns the custom background color of the item specified by ``idx`` index. .. _class_ItemList_method_get_item_custom_fg_color: -- :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** |const| Returns the custom foreground color of the item specified by ``idx`` index. @@ -519,7 +519,7 @@ Returns the custom foreground color of the item specified by ``idx`` index. .. _class_ItemList_method_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** |const| Returns the icon associated with the specified index. @@ -527,7 +527,7 @@ Returns the icon associated with the specified index. .. _class_ItemList_method_get_item_icon_modulate: -- :ref:`Color` **get_item_icon_modulate** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_item_icon_modulate** **(** :ref:`int` idx **)** |const| Returns a :ref:`Color` modulating item's icon at the specified index. @@ -535,7 +535,7 @@ Returns a :ref:`Color` modulating item's icon at the specified inde .. _class_ItemList_method_get_item_icon_region: -- :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** const +- :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** |const| Returns the region of item's icon used. The whole icon will be used if the region has no area. @@ -543,7 +543,7 @@ Returns the region of item's icon used. The whole icon will be used if the regio .. _class_ItemList_method_get_item_metadata: -- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** |const| Returns the metadata value of the specified index. @@ -551,7 +551,7 @@ Returns the metadata value of the specified index. .. _class_ItemList_method_get_item_text: -- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** |const| Returns the text associated with the specified index. @@ -559,7 +559,7 @@ Returns the text associated with the specified index. .. _class_ItemList_method_get_item_tooltip: -- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** |const| Returns the tooltip hint associated with the specified index. @@ -591,7 +591,7 @@ Returns ``true`` if one or more items are selected. .. _class_ItemList_method_is_item_disabled: -- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item at the specified index is disabled. @@ -599,7 +599,7 @@ Returns ``true`` if the item at the specified index is disabled. .. _class_ItemList_method_is_item_icon_transposed: -- :ref:`bool` **is_item_icon_transposed** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_icon_transposed** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item icon will be drawn transposed, i.e. the X and Y axes are swapped. @@ -607,7 +607,7 @@ Returns ``true`` if the item icon will be drawn transposed, i.e. the X and Y axe .. _class_ItemList_method_is_item_selectable: -- :ref:`bool` **is_item_selectable** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_selectable** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item at the specified index is selectable. @@ -615,7 +615,7 @@ Returns ``true`` if the item at the specified index is selectable. .. _class_ItemList_method_is_item_tooltip_enabled: -- :ref:`bool` **is_item_tooltip_enabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_tooltip_enabled** **(** :ref:`int` idx **)** |const| Returns ``true`` if the tooltip is enabled for specified item index. @@ -623,7 +623,7 @@ Returns ``true`` if the tooltip is enabled for specified item index. .. _class_ItemList_method_is_selected: -- :ref:`bool` **is_selected** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_selected** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item at the specified index is currently selected. @@ -785,3 +785,6 @@ Ensures the item associated with the specified index is not selected. Ensures there are no items selected. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_javaclass.rst b/classes/class_javaclass.rst index 8cad86783..a3687328f 100644 --- a/classes/class_javaclass.rst +++ b/classes/class_javaclass.rst @@ -13,3 +13,6 @@ JavaClass +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_javaclasswrapper.rst b/classes/class_javaclasswrapper.rst index 0817c2871..418ad2a1e 100644 --- a/classes/class_javaclasswrapper.rst +++ b/classes/class_javaclasswrapper.rst @@ -27,3 +27,6 @@ Method Descriptions - :ref:`JavaClass` **wrap** **(** :ref:`String` name **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst index bc09ff41f..1cdb1998f 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascript.rst @@ -41,3 +41,6 @@ Execute the string ``code`` as JavaScript code within the browser window. This i 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. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_jnisingleton.rst b/classes/class_jnisingleton.rst index 482cfa142..54f2de9a1 100644 --- a/classes/class_jnisingleton.rst +++ b/classes/class_jnisingleton.rst @@ -13,3 +13,6 @@ JNISingleton +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 91b886e98..9f5a0cedf 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -98,3 +98,6 @@ The node attached to the second side (B) of the joint. The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 813971c0a..416d2d9c3 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -98,3 +98,6 @@ The first body attached to the joint. Must derive from :ref:`PhysicsBody2D`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_json.rst b/classes/class_json.rst index 4ead4cd84..152ca2626 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -34,7 +34,7 @@ Method Descriptions - :ref:`JSONParseResult` **parse** **(** :ref:`String` json **)** -Parses a JSON encoded string and returns a :ref:`JSONParseResult` containing the result. +Parses a JSON-encoded string and returns a :ref:`JSONParseResult` containing the result. ---- @@ -44,3 +44,33 @@ Parses a JSON encoded string and returns a :ref:`JSONParseResult` var to JSON text and returns the result. Useful for serializing data to store or send over the network. +**Note:** The JSON specification does not define integer or float types, but only a *number* type. Therefore, converting a Variant to JSON text will convert all numerical values to :ref:`float` types. + +Use ``indent`` parameter to pretty print the output. + +**Example output:** + +:: + + ## JSON.print(my_dictionary) + {"name":"my_dictionary","version":"1.0.0","entities":[{"name":"entity_0","value":"value_0"},{"name":"entity_1","value":"value_1"}]} + + ## JSON.print(my_dictionary, "\t") + { + "name": "my_dictionary", + "version": "1.0.0", + "entities": [ + { + "name": "entity_0", + "value": "value_0" + }, + { + "name": "entity_1", + "value": "value_1" + } + ] + } + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index 0e82566f9..ff1315273 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -60,7 +60,7 @@ The error type if the JSON source was not successfully parsed. See the :ref:`Err | *Getter* | get_error_line() | +-----------+-----------------------+ -The line number where the error occurred if JSON source was not successfully parsed. +The line number where the error occurred if the JSON source was not successfully parsed. ---- @@ -76,7 +76,7 @@ The line number where the error occurred if JSON source was not successfully par | *Getter* | get_error_string() | +-----------+-------------------------+ -The error message if JSON source was not successfully parsed. See the :ref:`Error` constants. +The error message if the JSON source was not successfully parsed. See the :ref:`Error` constants. ---- @@ -90,9 +90,9 @@ The error message if JSON source was not successfully parsed. See the :ref:`Erro | *Getter* | get_result() | +----------+-------------------+ -A :ref:`Variant` containing the parsed JSON. Use :ref:`@GDScript.typeof` or the ``is`` keyword to check if it is what you expect. For example, if the JSON source starts with curly braces (``{}``), a :ref:`Dictionary` will be returned. If the JSON source starts with braces (``[]``), an :ref:`Array` will be returned. +A :ref:`Variant` containing the parsed JSON. Use :ref:`@GDScript.typeof` or the ``is`` keyword to check if it is what you expect. For example, if the JSON source starts with curly braces (``{}``), a :ref:`Dictionary` will be returned. If the JSON source starts with brackets (``[]``), an :ref:`Array` will be returned. -**Note:** The JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types. +**Note:** The JSON specification does not define integer or float types, but only a *number* type. Therefore, parsing a JSON text will convert all numerical values to :ref:`float` types. **Note:** JSON objects do not preserve key order like Godot dictionaries, thus, you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements: @@ -102,5 +102,8 @@ A :ref:`Variant` containing the parsed JSON. Use :ref:`@GDScript. if typeof(p.result) == TYPE_ARRAY: print(p.result[0]) # Prints "hello" else: - print("unexpected results") + push_error("Unexpected results.") +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index e01edbdb1..f33a0a3c1 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -16,21 +16,21 @@ JSONRPC Methods ------- -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_notification` **(** :ref:`String` method, :ref:`Variant` params **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_request` **(** :ref:`String` method, :ref:`Variant` params, :ref:`Variant` id **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_response` **(** :ref:`Variant` result, :ref:`Variant` id **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_response_error` **(** :ref:`int` code, :ref:`String` message, :ref:`Variant` id=null **)** const | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`process_action` **(** :ref:`Variant` action, :ref:`bool` recurse=false **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`process_string` **(** :ref:`String` action **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scope` **(** :ref:`String` scope, :ref:`Object` target **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_notification` **(** :ref:`String` method, :ref:`Variant` params **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_request` **(** :ref:`String` method, :ref:`Variant` params, :ref:`Variant` id **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_response` **(** :ref:`Variant` result, :ref:`Variant` id **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_response_error` **(** :ref:`int` code, :ref:`String` message, :ref:`Variant` id=null **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`process_action` **(** :ref:`Variant` action, :ref:`bool` recurse=false **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`process_string` **(** :ref:`String` action **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scope` **(** :ref:`String` scope, :ref:`Object` target **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -82,7 +82,7 @@ Method Descriptions .. _class_JSONRPC_method_make_response_error: -- :ref:`Dictionary` **make_response_error** **(** :ref:`int` code, :ref:`String` message, :ref:`Variant` id=null **)** const +- :ref:`Dictionary` **make_response_error** **(** :ref:`int` code, :ref:`String` message, :ref:`Variant` id=null **)** |const| ---- @@ -102,3 +102,6 @@ Method Descriptions - void **set_scope** **(** :ref:`String` scope, :ref:`Object` target **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 20c7b973b..162c98622 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -44,21 +44,21 @@ Methods ------- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_axis_lock` **(** :ref:`BodyAxis` axis **)** const | +| :ref:`bool` | :ref:`get_axis_lock` **(** :ref:`BodyAxis` axis **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_floor_normal` **(** **)** const | +| :ref:`Vector3` | :ref:`get_floor_normal` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | +| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`KinematicCollision` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slide_count` **(** **)** const | +| :ref:`int` | :ref:`get_slide_count` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | +| :ref:`bool` | :ref:`is_on_floor` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | +| :ref:`bool` | :ref:`is_on_wall` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`KinematicCollision` | :ref:`move_and_collide` **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -141,7 +141,7 @@ Method Descriptions .. _class_KinematicBody_method_get_axis_lock: -- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** const +- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** |const| Returns ``true`` if the specified ``axis`` is locked. See also :ref:`move_lock_x`, :ref:`move_lock_y` and :ref:`move_lock_z`. @@ -149,7 +149,7 @@ Returns ``true`` if the specified ``axis`` is locked. See also :ref:`move_lock_x .. _class_KinematicBody_method_get_floor_normal: -- :ref:`Vector3` **get_floor_normal** **(** **)** const +- :ref:`Vector3` **get_floor_normal** **(** **)** |const| Returns the surface normal of the floor at the last collision point. Only valid after calling :ref:`move_and_slide` or :ref:`move_and_slide_with_snap` and when :ref:`is_on_floor` returns ``true``. @@ -157,7 +157,7 @@ Returns the surface normal of the floor at the last collision point. Only valid .. _class_KinematicBody_method_get_floor_velocity: -- :ref:`Vector3` **get_floor_velocity** **(** **)** const +- :ref:`Vector3` **get_floor_velocity** **(** **)** |const| Returns the linear velocity of the floor at the last collision point. Only valid after calling :ref:`move_and_slide` or :ref:`move_and_slide_with_snap` and when :ref:`is_on_floor` returns ``true``. @@ -173,7 +173,7 @@ Returns a :ref:`KinematicCollision`, which contains in .. _class_KinematicBody_method_get_slide_count: -- :ref:`int` **get_slide_count** **(** **)** const +- :ref:`int` **get_slide_count** **(** **)** |const| Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. @@ -181,7 +181,7 @@ Returns the number of times the body collided and changed direction during the l .. _class_KinematicBody_method_is_on_ceiling: -- :ref:`bool` **is_on_ceiling** **(** **)** const +- :ref:`bool` **is_on_ceiling** **(** **)** |const| Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. @@ -189,7 +189,7 @@ Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:` .. _class_KinematicBody_method_is_on_floor: -- :ref:`bool` **is_on_floor** **(** **)** const +- :ref:`bool` **is_on_floor** **(** **)** |const| Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. @@ -197,7 +197,7 @@ Returns ``true`` if the body is on the floor. Only updates when calling :ref:`mo .. _class_KinematicBody_method_is_on_wall: -- :ref:`bool` **is_on_wall** **(** **)** const +- :ref:`bool` **is_on_wall** **(** **)** |const| Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. @@ -261,3 +261,6 @@ Locks or unlocks the specified ``axis`` depending on the value of ``lock``. See Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index d37597467..501fad3c5 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -42,19 +42,19 @@ Methods ------- +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_floor_normal` **(** **)** const | +| :ref:`Vector2` | :ref:`get_floor_normal` **(** **)** |const| | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | +| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** |const| | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slide_count` **(** **)** const | +| :ref:`int` | :ref:`get_slide_count` **(** **)** |const| | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** |const| | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | +| :ref:`bool` | :ref:`is_on_floor` **(** **)** |const| | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | +| :ref:`bool` | :ref:`is_on_wall` **(** **)** |const| | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`KinematicCollision2D` | :ref:`move_and_collide` **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** | +---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -103,7 +103,7 @@ Method Descriptions .. _class_KinematicBody2D_method_get_floor_normal: -- :ref:`Vector2` **get_floor_normal** **(** **)** const +- :ref:`Vector2` **get_floor_normal** **(** **)** |const| Returns the surface normal of the floor at the last collision point. Only valid after calling :ref:`move_and_slide` or :ref:`move_and_slide_with_snap` and when :ref:`is_on_floor` returns ``true``. @@ -111,7 +111,7 @@ Returns the surface normal of the floor at the last collision point. Only valid .. _class_KinematicBody2D_method_get_floor_velocity: -- :ref:`Vector2` **get_floor_velocity** **(** **)** const +- :ref:`Vector2` **get_floor_velocity** **(** **)** |const| Returns the linear velocity of the floor at the last collision point. Only valid after calling :ref:`move_and_slide` or :ref:`move_and_slide_with_snap` and when :ref:`is_on_floor` returns ``true``. @@ -135,7 +135,7 @@ Returns a :ref:`KinematicCollision2D`, which contain .. _class_KinematicBody2D_method_get_slide_count: -- :ref:`int` **get_slide_count** **(** **)** const +- :ref:`int` **get_slide_count** **(** **)** |const| Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. @@ -143,7 +143,7 @@ Returns the number of times the body collided and changed direction during the l .. _class_KinematicBody2D_method_is_on_ceiling: -- :ref:`bool` **is_on_ceiling** **(** **)** const +- :ref:`bool` **is_on_ceiling** **(** **)** |const| Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. @@ -151,7 +151,7 @@ Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:` .. _class_KinematicBody2D_method_is_on_floor: -- :ref:`bool` **is_on_floor** **(** **)** const +- :ref:`bool` **is_on_floor** **(** **)** |const| Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. @@ -159,7 +159,7 @@ Returns ``true`` if the body is on the floor. Only updates when calling :ref:`mo .. _class_KinematicBody2D_method_is_on_wall: -- :ref:`bool` **is_on_wall** **(** **)** const +- :ref:`bool` **is_on_wall** **(** **)** |const| Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. @@ -215,3 +215,6 @@ As long as the ``snap`` vector is in contact with the ground, the body will rema Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform2D`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 8ad9bfe40..cdc072358 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -194,3 +194,6 @@ The moving object's remaining movement vector. The distance the moving object traveled before collision. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index b4e9d202f..0bef580ba 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -194,3 +194,6 @@ The moving object's remaining movement vector. The distance the moving object traveled before collision. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_label.rst b/classes/class_label.rst index b03009b1e..ffa27d3ea 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -52,15 +52,15 @@ Properties Methods ------- -+-----------------------+--------------------------------------------------------------------------------------------------+ -| :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_line_count` **(** **)** const | -+-----------------------+--------------------------------------------------------------------------------------------------+ ++-----------------------+----------------------------------------------------------------------------------------------------+ +| :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_line_count` **(** **)** |const| | ++-----------------------+----------------------------------------------------------------------------------------------------+ Theme Properties ---------------- @@ -296,7 +296,7 @@ Method Descriptions .. _class_Label_method_get_line_count: -- :ref:`int` **get_line_count** **(** **)** const +- :ref:`int` **get_line_count** **(** **)** |const| Returns the amount of lines of text the Label has. @@ -304,7 +304,7 @@ Returns the amount of lines of text the Label has. .. _class_Label_method_get_line_height: -- :ref:`int` **get_line_height** **(** **)** const +- :ref:`int` **get_line_height** **(** **)** |const| Returns the font size in pixels. @@ -312,7 +312,7 @@ Returns the font size in pixels. .. _class_Label_method_get_total_character_count: -- :ref:`int` **get_total_character_count** **(** **)** const +- :ref:`int` **get_total_character_count** **(** **)** |const| Returns the total number of printable characters in the text (excluding spaces and newlines). @@ -320,7 +320,10 @@ Returns the total number of printable characters in the text (excluding spaces a .. _class_Label_method_get_visible_line_count: -- :ref:`int` **get_visible_line_count** **(** **)** const +- :ref:`int` **get_visible_line_count** **(** **)** |const| Returns the number of lines shown. Useful if the ``Label``'s height cannot currently display all lines. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index 4f8cb7fc7..172a6dff5 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -35,11 +35,11 @@ Methods +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_piece_count` **(** **)** const | +| :ref:`int` | :ref:`get_piece_count` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_piece_offset` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_piece_offset` **(** :ref:`int` idx **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_piece_texture` **(** :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_piece_texture` **(** :ref:`int` idx **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_piece_offset` **(** :ref:`int` idx, :ref:`Vector2` ofs **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,7 +69,7 @@ Clears the ``LargeTexture``. .. _class_LargeTexture_method_get_piece_count: -- :ref:`int` **get_piece_count** **(** **)** const +- :ref:`int` **get_piece_count** **(** **)** |const| Returns the number of pieces currently in this ``LargeTexture``. @@ -77,7 +77,7 @@ Returns the number of pieces currently in this ``LargeTexture``. .. _class_LargeTexture_method_get_piece_offset: -- :ref:`Vector2` **get_piece_offset** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_piece_offset** **(** :ref:`int` idx **)** |const| Returns the offset of the piece with the index ``idx``. @@ -85,7 +85,7 @@ Returns the offset of the piece with the index ``idx``. .. _class_LargeTexture_method_get_piece_texture: -- :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** |const| Returns the :ref:`Texture` of the piece with the index ``idx``. @@ -113,3 +113,6 @@ Sets the :ref:`Texture` of the piece with index ``idx`` to ``text Sets the size of this ``LargeTexture``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_light.rst b/classes/class_light.rst index 303e9c523..c505753ea 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -60,7 +60,7 @@ Methods ------- +---------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** const | +| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------+ @@ -372,7 +372,7 @@ Method Descriptions .. _class_Light_method_get_param: -- :ref:`float` **get_param** **(** :ref:`Param` param **)** const +- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| Returns the value of the specified :ref:`Param` parameter. @@ -384,3 +384,6 @@ Returns the value of the specified :ref:`Param` parameter. Sets the value of the specified :ref:`Param` parameter. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index a4da9ad4c..78403a699 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -460,3 +460,6 @@ The shadow mask. Used with :ref:`LightOccluder2D` to cast The ``texture``'s scale factor. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index bc27d49bb..e002ffed9 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -63,3 +63,6 @@ The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only fro The :ref:`OccluderPolygon2D` used to compute the shadow. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 87df24f2d..61cb63d85 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -59,9 +59,9 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | +| :ref:`int` | :ref:`get_point_count` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` i **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ @@ -232,7 +232,7 @@ The style for the points between the start and the end. | *Getter* | get_points() | +-----------+--------------------------+ -The points that form the lines. The line is drawn between every point set in this array. +The points that form the lines. The line is drawn between every point set in this array. Points are interpreted as local vectors. ---- @@ -349,7 +349,7 @@ Removes all points from the line. .. _class_Line2D_method_get_point_count: -- :ref:`int` **get_point_count** **(** **)** const +- :ref:`int` **get_point_count** **(** **)** |const| Returns the Line2D's amount of points. @@ -357,7 +357,7 @@ Returns the Line2D's amount of points. .. _class_Line2D_method_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** |const| Returns point ``i``'s position. @@ -377,3 +377,6 @@ Removes the point at index ``i`` from the line. Overwrites the position in point ``i`` with the supplied ``position``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index c9d4181c3..ae94a041b 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -115,7 +115,7 @@ Methods +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`deselect` **(** **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** |const| | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`menu_option` **(** :ref:`int` option **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -577,7 +577,7 @@ Clears the current selection. .. _class_LineEdit_method_get_menu: -- :ref:`PopupMenu` **get_menu** **(** **)** const +- :ref:`PopupMenu` **get_menu** **(** **)** |const| Returns the :ref:`PopupMenu` of this ``LineEdit``. By default, this menu is displayed when right-clicking on the ``LineEdit``. @@ -612,3 +612,6 @@ Selects characters inside ``LineEdit`` between ``from`` and ``to``. By default, Selects the whole :ref:`String`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index d472735ea..4ae55ae1e 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -60,3 +60,6 @@ The line's distance from the origin. The line's normal. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 11cedf80f..57f360a9d 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -102,3 +102,6 @@ The button's text that will be displayed inside the button's area. Determines when to show the underline. See :ref:`UnderlineMode` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_listener.rst b/classes/class_listener.rst index ac3c82f9e..7c6e165e3 100644 --- a/classes/class_listener.rst +++ b/classes/class_listener.rst @@ -23,15 +23,15 @@ Once added to the scene tree and enabled using :ref:`make_current` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_listener_transform` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_current` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_listener_transform` **(** **)** |const| | ++-----------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_current` **(** **)** |const| | ++-----------------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -46,7 +46,7 @@ Disables the listener to use the current camera's listener instead. .. _class_Listener_method_get_listener_transform: -- :ref:`Transform` **get_listener_transform** **(** **)** const +- :ref:`Transform` **get_listener_transform** **(** **)** |const| Returns the listener's global orthonormalized :ref:`Transform`. @@ -54,7 +54,7 @@ Returns the listener's global orthonormalized :ref:`Transform`. .. _class_Listener_method_is_current: -- :ref:`bool` **is_current** **(** **)** const +- :ref:`bool` **is_current** **(** **)** |const| Returns ``true`` if the listener was made current using :ref:`make_current`, ``false`` otherwise. @@ -68,3 +68,6 @@ Returns ``true`` if the listener was made current using :ref:`make_current` **(** :ref:`PoolStringArray` files, :ref:`int` from_screen **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_finalize` **(** **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_global_menu_action` **(** :ref:`Variant` id, :ref:`Variant` meta **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_idle` **(** :ref:`float` delta **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_initialize` **(** **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`InputEvent` event **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_text` **(** :ref:`String` text **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_iteration` **(** :ref:`float` delta **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`finish` **(** **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`idle` **(** :ref:`float` delta **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`init` **(** **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_event` **(** :ref:`InputEvent` event **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_text` **(** :ref:`String` text **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`iteration` **(** :ref:`float` delta **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_drop_files` **(** :ref:`PoolStringArray` files, :ref:`int` from_screen **)** |virtual| | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_finalize` **(** **)** |virtual| | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_global_menu_action` **(** :ref:`Variant` id, :ref:`Variant` meta **)** |virtual| | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_idle` **(** :ref:`float` delta **)** |virtual| | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_initialize` **(** **)** |virtual| | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`InputEvent` event **)** |virtual| | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_text` **(** :ref:`String` text **)** |virtual| | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_iteration` **(** :ref:`float` delta **)** |virtual| | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`finish` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`idle` **(** :ref:`float` delta **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`init` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input_event` **(** :ref:`InputEvent` event **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input_text` **(** :ref:`String` text **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`iteration` **(** :ref:`float` delta **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -189,7 +189,7 @@ Method Descriptions .. _class_MainLoop_method__drop_files: -- void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` from_screen **)** virtual +- void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` from_screen **)** |virtual| Called when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated. @@ -197,7 +197,7 @@ Called when files are dragged from the OS file manager and dropped in the game w .. _class_MainLoop_method__finalize: -- void **_finalize** **(** **)** virtual +- void **_finalize** **(** **)** |virtual| Called before the program exits. @@ -205,7 +205,7 @@ Called before the program exits. .. _class_MainLoop_method__global_menu_action: -- void **_global_menu_action** **(** :ref:`Variant` id, :ref:`Variant` meta **)** virtual +- void **_global_menu_action** **(** :ref:`Variant` id, :ref:`Variant` meta **)** |virtual| Called when the user performs an action in the system global menu (e.g. the Mac OS menu bar). @@ -213,7 +213,7 @@ Called when the user performs an action in the system global menu (e.g. the Mac .. _class_MainLoop_method__idle: -- :ref:`bool` **_idle** **(** :ref:`float` delta **)** virtual +- :ref:`bool` **_idle** **(** :ref:`float` delta **)** |virtual| Called each idle frame with the time since the last idle frame as argument (in seconds). Equivalent to :ref:`Node._process`. @@ -223,7 +223,7 @@ If implemented, the method must return a boolean value. ``true`` ends the main l .. _class_MainLoop_method__initialize: -- void **_initialize** **(** **)** virtual +- void **_initialize** **(** **)** |virtual| Called once during initialization. @@ -231,7 +231,7 @@ Called once during initialization. .. _class_MainLoop_method__input_event: -- void **_input_event** **(** :ref:`InputEvent` event **)** virtual +- void **_input_event** **(** :ref:`InputEvent` event **)** |virtual| Called whenever an :ref:`InputEvent` is received by the main loop. @@ -239,7 +239,7 @@ Called whenever an :ref:`InputEvent` is received by the main l .. _class_MainLoop_method__input_text: -- void **_input_text** **(** :ref:`String` text **)** virtual +- void **_input_text** **(** :ref:`String` text **)** |virtual| Deprecated callback, does not do anything. Use :ref:`_input_event` to parse text input. Will be removed in Godot 4.0. @@ -247,7 +247,7 @@ Deprecated callback, does not do anything. Use :ref:`_input_event` **_iteration** **(** :ref:`float` delta **)** virtual +- :ref:`bool` **_iteration** **(** :ref:`float` delta **)** |virtual| Called each physics frame with the time since the last physics frame as argument (in seconds). Equivalent to :ref:`Node._physics_process`. @@ -301,3 +301,6 @@ Should not be called manually, override :ref:`_input_text` instead. Will be removed in Godot 4.0. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 178a8af3d..7a95b3ddb 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -41,3 +41,6 @@ Theme Properties | :ref:`int` | margin_top | 0 | +-----------------------+---------------+---+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index ad50eec8a..c190d8b10 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -86,3 +86,6 @@ Returns a Base64-encoded string of the UTF-8 string ``utf8_str``. Returns a Base64-encoded string of the :ref:`Variant` ``variant``. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_material.rst b/classes/class_material.rst index 58017c01e..a23fc7581 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -75,3 +75,6 @@ Sets the render priority for transparent objects in 3D scenes. Higher priority o **Note:** this only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index ca577fc0e..c286b4705 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -41,7 +41,7 @@ Methods ------- +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | +| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** |const| | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_disable_shortcuts` **(** :ref:`bool` disabled **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ @@ -104,7 +104,7 @@ Method Descriptions .. _class_MenuButton_method_get_popup: -- :ref:`PopupMenu` **get_popup** **(** **)** const +- :ref:`PopupMenu` **get_popup** **(** **)** |const| Returns the :ref:`PopupMenu` contained in this button. @@ -116,3 +116,6 @@ Returns the :ref:`PopupMenu` contained in this button. If ``true``, shortcuts are disabled and cannot be used to trigger the button. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index f5edc19f0..4b2b6ed93 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -31,25 +31,25 @@ Methods ------- +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | +| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | +| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | +| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`get_aabb` **(** **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** const | +| :ref:`int` | :ref:`get_surface_count` **(** **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** const | +| :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** const | +| :ref:`Array` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | +| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -265,7 +265,7 @@ Method Descriptions .. _class_Mesh_method_create_convex_shape: -- :ref:`Shape` **create_convex_shape** **(** **)** const +- :ref:`Shape` **create_convex_shape** **(** **)** |const| Calculate a :ref:`ConvexPolygonShape` from the mesh. @@ -273,7 +273,7 @@ Calculate a :ref:`ConvexPolygonShape` from the mesh. .. _class_Mesh_method_create_outline: -- :ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** const +- :ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** |const| Calculate an outline mesh at a defined offset (margin) from the original mesh. @@ -283,7 +283,7 @@ Calculate an outline mesh at a defined offset (margin) from the original mesh. .. _class_Mesh_method_create_trimesh_shape: -- :ref:`Shape` **create_trimesh_shape** **(** **)** const +- :ref:`Shape` **create_trimesh_shape** **(** **)** |const| Calculate a :ref:`ConcavePolygonShape` from the mesh. @@ -291,7 +291,7 @@ Calculate a :ref:`ConcavePolygonShape` from the mesh. .. _class_Mesh_method_generate_triangle_mesh: -- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const +- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** |const| Generate a :ref:`TriangleMesh` from the mesh. @@ -299,7 +299,7 @@ Generate a :ref:`TriangleMesh` from the mesh. .. _class_Mesh_method_get_aabb: -- :ref:`AABB` **get_aabb** **(** **)** const +- :ref:`AABB` **get_aabb** **(** **)** |const| Returns the smallest :ref:`AABB` enclosing this mesh. Not affected by ``custom_aabb``. @@ -309,7 +309,7 @@ Returns the smallest :ref:`AABB` enclosing this mesh. Not affected b .. _class_Mesh_method_get_faces: -- :ref:`PoolVector3Array` **get_faces** **(** **)** const +- :ref:`PoolVector3Array` **get_faces** **(** **)** |const| Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. @@ -317,7 +317,7 @@ Returns all the vertices that make up the faces of the mesh. Each three vertices .. _class_Mesh_method_get_surface_count: -- :ref:`int` **get_surface_count** **(** **)** const +- :ref:`int` **get_surface_count** **(** **)** |const| Returns the amount of surfaces that the ``Mesh`` holds. @@ -325,7 +325,7 @@ Returns the amount of surfaces that the ``Mesh`` holds. .. _class_Mesh_method_surface_get_arrays: -- :ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** const +- :ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** |const| Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see :ref:`ArrayMesh.add_surface_from_arrays`). @@ -333,7 +333,7 @@ Returns the arrays for the vertices, normals, uvs, etc. that make up the request .. _class_Mesh_method_surface_get_blend_shape_arrays: -- :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** const +- :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** |const| Returns the blend shape arrays for the requested surface. @@ -341,7 +341,7 @@ Returns the blend shape arrays for the requested surface. .. _class_Mesh_method_surface_get_material: -- :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const +- :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** |const| Returns a :ref:`Material` in a given surface. Surface is rendered using this material. @@ -353,3 +353,6 @@ Returns a :ref:`Material` in a given surface. Surface is rendere Sets a :ref:`Material` for a given surface. Surface will be rendered using this material. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 0cb056b7b..1a518059a 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -47,51 +47,51 @@ Methods +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edge_count` **(** **)** const | +| :ref:`int` | :ref:`get_edge_count` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | +| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | +| :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_count` **(** **)** const | +| :ref:`int` | :ref:`get_face_count` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** const | +| :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | +| :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | +| :ref:`int` | :ref:`get_format` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | +| :ref:`Material` | :ref:`get_material` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** const | +| :ref:`PoolIntArray` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_vertex_count` **(** **)** const | +| :ref:`int` | :ref:`get_vertex_count` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** const | +| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | +| :ref:`PoolIntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** const | +| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** const | +| :ref:`PoolRealArray` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -149,7 +149,7 @@ Requires :ref:`Mesh` with primitive type :ref:`Mesh.PRIMITIVE_TRIANG .. _class_MeshDataTool_method_get_edge_count: -- :ref:`int` **get_edge_count** **(** **)** const +- :ref:`int` **get_edge_count** **(** **)** |const| Returns the number of edges in this :ref:`Mesh`. @@ -157,7 +157,7 @@ Returns the number of edges in this :ref:`Mesh`. .. _class_MeshDataTool_method_get_edge_faces: -- :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** |const| Returns array of faces that touch given edge. @@ -165,7 +165,7 @@ Returns array of faces that touch given edge. .. _class_MeshDataTool_method_get_edge_meta: -- :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** |const| Returns meta information assigned to given edge. @@ -173,7 +173,7 @@ Returns meta information assigned to given edge. .. _class_MeshDataTool_method_get_edge_vertex: -- :ref:`int` **get_edge_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const +- :ref:`int` **get_edge_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** |const| Returns index of specified vertex connected to given edge. @@ -183,7 +183,7 @@ Vertex argument can only be 0 or 1 because edges are comprised of two vertices. .. _class_MeshDataTool_method_get_face_count: -- :ref:`int` **get_face_count** **(** **)** const +- :ref:`int` **get_face_count** **(** **)** |const| Returns the number of faces in this :ref:`Mesh`. @@ -191,7 +191,7 @@ Returns the number of faces in this :ref:`Mesh`. .. _class_MeshDataTool_method_get_face_edge: -- :ref:`int` **get_face_edge** **(** :ref:`int` idx, :ref:`int` edge **)** const +- :ref:`int` **get_face_edge** **(** :ref:`int` idx, :ref:`int` edge **)** |const| Returns specified edge associated with given face. @@ -201,7 +201,7 @@ Edge argument must 2 or less because a face only has three edges. .. _class_MeshDataTool_method_get_face_meta: -- :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** |const| Returns the metadata associated with the given face. @@ -209,7 +209,7 @@ Returns the metadata associated with the given face. .. _class_MeshDataTool_method_get_face_normal: -- :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** |const| Calculates and returns the face normal of the given face. @@ -217,7 +217,7 @@ Calculates and returns the face normal of the given face. .. _class_MeshDataTool_method_get_face_vertex: -- :ref:`int` **get_face_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const +- :ref:`int` **get_face_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** |const| Returns the specified vertex of the given face. @@ -227,7 +227,7 @@ Vertex argument must be 2 or less because faces contain three vertices. .. _class_MeshDataTool_method_get_format: -- :ref:`int` **get_format** **(** **)** const +- :ref:`int` **get_format** **(** **)** |const| Returns the :ref:`Mesh`'s format. Format is an integer made up of :ref:`Mesh` format flags combined together. For example, a mesh containing both vertices and normals would return a format of ``3`` because :ref:`ArrayMesh.ARRAY_FORMAT_VERTEX` is ``1`` and :ref:`ArrayMesh.ARRAY_FORMAT_NORMAL` is ``2``. @@ -237,7 +237,7 @@ See :ref:`ArrayFormat` for a list of format flags. .. _class_MeshDataTool_method_get_material: -- :ref:`Material` **get_material** **(** **)** const +- :ref:`Material` **get_material** **(** **)** |const| Returns the material assigned to the :ref:`Mesh`. @@ -245,7 +245,7 @@ Returns the material assigned to the :ref:`Mesh`. .. _class_MeshDataTool_method_get_vertex: -- :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** |const| Returns the vertex at given index. @@ -253,7 +253,7 @@ Returns the vertex at given index. .. _class_MeshDataTool_method_get_vertex_bones: -- :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** |const| Returns the bones of the given vertex. @@ -261,7 +261,7 @@ Returns the bones of the given vertex. .. _class_MeshDataTool_method_get_vertex_color: -- :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** |const| Returns the color of the given vertex. @@ -269,7 +269,7 @@ Returns the color of the given vertex. .. _class_MeshDataTool_method_get_vertex_count: -- :ref:`int` **get_vertex_count** **(** **)** const +- :ref:`int` **get_vertex_count** **(** **)** |const| Returns the total number of vertices in :ref:`Mesh`. @@ -277,7 +277,7 @@ Returns the total number of vertices in :ref:`Mesh`. .. _class_MeshDataTool_method_get_vertex_edges: -- :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** |const| Returns an array of edges that share the given vertex. @@ -285,7 +285,7 @@ Returns an array of edges that share the given vertex. .. _class_MeshDataTool_method_get_vertex_faces: -- :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** |const| Returns an array of faces that share the given vertex. @@ -293,7 +293,7 @@ Returns an array of faces that share the given vertex. .. _class_MeshDataTool_method_get_vertex_meta: -- :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** |const| Returns the metadata associated with the given vertex. @@ -301,7 +301,7 @@ Returns the metadata associated with the given vertex. .. _class_MeshDataTool_method_get_vertex_normal: -- :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** |const| Returns the normal of the given vertex. @@ -309,7 +309,7 @@ Returns the normal of the given vertex. .. _class_MeshDataTool_method_get_vertex_tangent: -- :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** const +- :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** |const| Returns the tangent of the given vertex. @@ -317,7 +317,7 @@ Returns the tangent of the given vertex. .. _class_MeshDataTool_method_get_vertex_uv: -- :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** |const| Returns the UV of the given vertex. @@ -325,7 +325,7 @@ Returns the UV of the given vertex. .. _class_MeshDataTool_method_get_vertex_uv2: -- :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** |const| Returns the UV2 of the given vertex. @@ -333,7 +333,7 @@ Returns the UV2 of the given vertex. .. _class_MeshDataTool_method_get_vertex_weights: -- :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const +- :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** |const| Returns bone weights of the given vertex. @@ -433,3 +433,6 @@ Sets the UV2 of the given vertex. Sets the bone weights of the given vertex. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 255d1eb07..9b80cc762 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -41,9 +41,9 @@ Methods +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_trimesh_collision` **(** **)** | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** const | +| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_material_count` **(** **)** const | +| :ref:`int` | :ref:`get_surface_material_count` **(** **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,7 +122,7 @@ This helper creates a :ref:`StaticBody` child node with a :ref .. _class_MeshInstance_method_get_surface_material: -- :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const +- :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** |const| Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. @@ -130,7 +130,7 @@ Returns the :ref:`Material` for a surface of the :ref:`Mesh` **get_surface_material_count** **(** **)** const +- :ref:`int` **get_surface_material_count** **(** **)** |const| Returns the number of surface materials. @@ -142,3 +142,6 @@ Returns the number of surface materials. Sets the :ref:`Material` for a surface of the :ref:`Mesh` resource. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 33deb5445..31319de45 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -88,3 +88,6 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index c40c17867..d2d7c6fea 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -26,23 +26,23 @@ Methods +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_item` **(** :ref:`int` id **)** | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** |const| | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | +| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** |const| | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | +| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** |const| | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** const | +| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** |const| | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | +| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** |const| | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_item_navmesh_transform` **(** :ref:`int` id **)** const | +| :ref:`Transform` | :ref:`get_item_navmesh_transform` **(** :ref:`int` id **)** |const| | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | +| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** |const| | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | +| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** |const| | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | +| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** |const| | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` id **)** | +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -82,7 +82,7 @@ You can get an unused ID from :ref:`get_last_unused_item_id` **find_item_by_name** **(** :ref:`String` name **)** const +- :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** |const| Returns the first item with the given name. @@ -90,7 +90,7 @@ Returns the first item with the given name. .. _class_MeshLibrary_method_get_item_list: -- :ref:`PoolIntArray` **get_item_list** **(** **)** const +- :ref:`PoolIntArray` **get_item_list** **(** **)** |const| Returns the list of item IDs in use. @@ -98,7 +98,7 @@ Returns the list of item IDs in use. .. _class_MeshLibrary_method_get_item_mesh: -- :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** const +- :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** |const| Returns the item's mesh. @@ -106,7 +106,7 @@ Returns the item's mesh. .. _class_MeshLibrary_method_get_item_name: -- :ref:`String` **get_item_name** **(** :ref:`int` id **)** const +- :ref:`String` **get_item_name** **(** :ref:`int` id **)** |const| Returns the item's name. @@ -114,7 +114,7 @@ Returns the item's name. .. _class_MeshLibrary_method_get_item_navmesh: -- :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const +- :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** |const| Returns the item's navigation mesh. @@ -122,7 +122,7 @@ Returns the item's navigation mesh. .. _class_MeshLibrary_method_get_item_navmesh_transform: -- :ref:`Transform` **get_item_navmesh_transform** **(** :ref:`int` id **)** const +- :ref:`Transform` **get_item_navmesh_transform** **(** :ref:`int` id **)** |const| Returns the transform applied to the item's navigation mesh. @@ -130,7 +130,7 @@ Returns the transform applied to the item's navigation mesh. .. _class_MeshLibrary_method_get_item_preview: -- :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const +- :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** |const| When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using :ref:`set_item_preview`. Returns an empty :ref:`Texture` if no preview was manually set in a running project. @@ -138,7 +138,7 @@ When running in the editor, returns a generated item preview (a 3D rendering in .. _class_MeshLibrary_method_get_item_shapes: -- :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const +- :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** |const| Returns an item's collision shapes. @@ -148,7 +148,7 @@ The array consists of each :ref:`Shape` followed by its :ref:`Trans .. _class_MeshLibrary_method_get_last_unused_item_id: -- :ref:`int` **get_last_unused_item_id** **(** **)** const +- :ref:`int` **get_last_unused_item_id** **(** **)** |const| Gets an unused ID for a new item. @@ -212,3 +212,6 @@ Sets an item's collision shapes. The array should consist of :ref:`Shape` objects, each followed by a :ref:`Transform` that will be applied to it. For shapes that should not have a transform, use :ref:`Transform.IDENTITY`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index 1cf2028c0..9d4da7397 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -76,3 +76,6 @@ Sets the size of the image, needed for reference. Sets the mesh used to draw. It must be a mesh using 2D vertices. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index 9495cca07..a2586cf8f 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -160,3 +160,6 @@ The k2 lens factor, see k1. The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index cd92b2f3d..484b98bc7 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -52,15 +52,15 @@ Methods ------- +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`get_aabb` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_instance_color` **(** :ref:`int` instance **)** const | +| :ref:`Color` | :ref:`get_instance_color` **(** :ref:`int` instance **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_instance_custom_data` **(** :ref:`int` instance **)** const | +| :ref:`Color` | :ref:`get_instance_custom_data` **(** :ref:`int` instance **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_instance_transform` **(** :ref:`int` instance **)** const | +| :ref:`Transform` | :ref:`get_instance_transform` **(** :ref:`int` instance **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_instance_transform_2d` **(** :ref:`int` instance **)** const | +| :ref:`Transform2D` | :ref:`get_instance_transform_2d` **(** :ref:`int` instance **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_bulk_array` **(** :ref:`PoolRealArray` array **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -224,7 +224,7 @@ Method Descriptions .. _class_MultiMesh_method_get_aabb: -- :ref:`AABB` **get_aabb** **(** **)** const +- :ref:`AABB` **get_aabb** **(** **)** |const| Returns the visibility axis-aligned bounding box. @@ -232,7 +232,7 @@ Returns the visibility axis-aligned bounding box. .. _class_MultiMesh_method_get_instance_color: -- :ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** const +- :ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** |const| Gets a specific instance's color. @@ -240,7 +240,7 @@ Gets a specific instance's color. .. _class_MultiMesh_method_get_instance_custom_data: -- :ref:`Color` **get_instance_custom_data** **(** :ref:`int` instance **)** const +- :ref:`Color` **get_instance_custom_data** **(** :ref:`int` instance **)** |const| Returns the custom data that has been set for a specific instance. @@ -248,7 +248,7 @@ Returns the custom data that has been set for a specific instance. .. _class_MultiMesh_method_get_instance_transform: -- :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const +- :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** |const| Returns the :ref:`Transform` of a specific instance. @@ -256,7 +256,7 @@ Returns the :ref:`Transform` of a specific instance. .. _class_MultiMesh_method_get_instance_transform_2d: -- :ref:`Transform2D` **get_instance_transform_2d** **(** :ref:`int` instance **)** const +- :ref:`Transform2D` **get_instance_transform_2d** **(** :ref:`int` instance **)** |const| Returns the :ref:`Transform2D` of a specific instance. @@ -306,3 +306,6 @@ Sets the :ref:`Transform` for a specific instance. Sets the :ref:`Transform2D` for a specific instance. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index b34702889..748afa66d 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -51,3 +51,6 @@ Property Descriptions The :ref:`MultiMesh` resource that will be used and shared among all instances of the ``MultiMeshInstance``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_multimeshinstance2d.rst b/classes/class_multimeshinstance2d.rst index 35275d61a..9f074565b 100644 --- a/classes/class_multimeshinstance2d.rst +++ b/classes/class_multimeshinstance2d.rst @@ -85,3 +85,6 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 462fcc1cb..0084993db 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -39,15 +39,15 @@ Methods +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | +| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | +| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | +| :ref:`bool` | :ref:`has_network_peer` **(** **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_server` **(** **)** const | +| :ref:`bool` | :ref:`is_network_server` **(** **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`poll` **(** **)** | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -210,7 +210,7 @@ Clears the current MultiplayerAPI network state (you shouldn't call this unless .. _class_MultiplayerAPI_method_get_network_connected_peers: -- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const +- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** |const| Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`network_peer`. @@ -218,7 +218,7 @@ Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`netwo .. _class_MultiplayerAPI_method_get_network_unique_id: -- :ref:`int` **get_network_unique_id** **(** **)** const +- :ref:`int` **get_network_unique_id** **(** **)** |const| Returns the unique peer ID of this MultiplayerAPI's :ref:`network_peer`. @@ -226,7 +226,7 @@ Returns the unique peer ID of this MultiplayerAPI's :ref:`network_peer` **get_rpc_sender_id** **(** **)** const +- :ref:`int` **get_rpc_sender_id** **(** **)** |const| Returns the sender's peer ID for the RPC currently being executed. @@ -236,7 +236,7 @@ Returns the sender's peer ID for the RPC currently being executed. .. _class_MultiplayerAPI_method_has_network_peer: -- :ref:`bool` **has_network_peer** **(** **)** const +- :ref:`bool` **has_network_peer** **(** **)** |const| Returns ``true`` if there is a :ref:`network_peer` set. @@ -244,7 +244,7 @@ Returns ``true`` if there is a :ref:`network_peer` **is_network_server** **(** **)** const +- :ref:`bool` **is_network_server** **(** **)** |const| Returns ``true`` if this MultiplayerAPI's :ref:`network_peer` is in server mode (listening for connections). @@ -276,3 +276,6 @@ Sets the base root node to use for RPCs. Instead of an absolute path, a relative This effectively allows to have different branches of the scene tree to be managed by different MultiplayerAPI, allowing for example to run both client and server in the same scene. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_multiplayerpeergdnative.rst b/classes/class_multiplayerpeergdnative.rst index 4a567730c..658f1a410 100644 --- a/classes/class_multiplayerpeergdnative.rst +++ b/classes/class_multiplayerpeergdnative.rst @@ -13,3 +13,6 @@ MultiplayerPeerGDNative +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 570c3bfe3..a5a691ed7 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -59,3 +59,6 @@ Tries locking this ``Mutex``, but does not block. Returns :ref:`@GlobalScope.OK< Unlocks this ``Mutex``, leaving it to other threads. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index a039d5b6a..063cb6ba1 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -29,17 +29,17 @@ Properties Methods ------- -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class_documentation` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_method_documentation` **(** :ref:`String` method **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_property_documentation` **(** :ref:`String` path **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_signal_documentation` **(** :ref:`String` signal_name **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`new` **(** ... **)** vararg | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class_documentation` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_method_documentation` **(** :ref:`String` method **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_property_documentation` **(** :ref:`String` path **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_signal_documentation` **(** :ref:`String` signal_name **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** ... **)** |vararg| | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -101,7 +101,7 @@ Method Descriptions .. _class_NativeScript_method_get_class_documentation: -- :ref:`String` **get_class_documentation** **(** **)** const +- :ref:`String` **get_class_documentation** **(** **)** |const| Returns the documentation string that was previously set with ``godot_nativescript_set_class_documentation``. @@ -109,7 +109,7 @@ Returns the documentation string that was previously set with ``godot_nativescri .. _class_NativeScript_method_get_method_documentation: -- :ref:`String` **get_method_documentation** **(** :ref:`String` method **)** const +- :ref:`String` **get_method_documentation** **(** :ref:`String` method **)** |const| Returns the documentation string that was previously set with ``godot_nativescript_set_method_documentation``. @@ -117,7 +117,7 @@ Returns the documentation string that was previously set with ``godot_nativescri .. _class_NativeScript_method_get_property_documentation: -- :ref:`String` **get_property_documentation** **(** :ref:`String` path **)** const +- :ref:`String` **get_property_documentation** **(** :ref:`String` path **)** |const| Returns the documentation string that was previously set with ``godot_nativescript_set_property_documentation``. @@ -125,7 +125,7 @@ Returns the documentation string that was previously set with ``godot_nativescri .. _class_NativeScript_method_get_signal_documentation: -- :ref:`String` **get_signal_documentation** **(** :ref:`String` signal_name **)** const +- :ref:`String` **get_signal_documentation** **(** :ref:`String` signal_name **)** |const| Returns the documentation string that was previously set with ``godot_nativescript_set_signal_documentation``. @@ -133,9 +133,12 @@ Returns the documentation string that was previously set with ``godot_nativescri .. _class_NativeScript_method_new: -- :ref:`Variant` **new** **(** ... **)** vararg +- :ref:`Variant` **new** **(** ... **)** |vararg| Constructs a new object of the base type with a script of this type already attached. *Note*: Any arguments passed to this function will be ignored and not passed to the native constructor function. This will change with in a future API extension. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index ca4013630..6e88e86e1 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -128,3 +128,6 @@ Removes the :ref:`NavigationMesh` with the given ID. Sets the transform applied to the :ref:`NavigationMesh` with the given ID. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index fb4c213b0..f3f33066a 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -84,3 +84,6 @@ Removes the :ref:`NavigationPolygon` with the given ID. Sets the transform applied to the :ref:`NavigationPolygon` with the given ID. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index d79404f92..dfdcce267 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -70,13 +70,13 @@ Methods +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | +| :ref:`int` | :ref:`get_polygon_count` **(** **)** |const| | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | +| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** |const| | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -424,7 +424,7 @@ Method Descriptions .. _class_NavigationMesh_method_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| ---- @@ -436,13 +436,13 @@ Method Descriptions .. _class_NavigationMesh_method_get_polygon_count: -- :ref:`int` **get_polygon_count** **(** **)** const +- :ref:`int` **get_polygon_count** **(** **)** |const| ---- .. _class_NavigationMesh_method_get_vertices: -- :ref:`PoolVector3Array` **get_vertices** **(** **)** const +- :ref:`PoolVector3Array` **get_vertices** **(** **)** |const| ---- @@ -456,3 +456,6 @@ Method Descriptions - void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index f889fea10..dfb67afdf 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -49,3 +49,6 @@ Property Descriptions | *Getter* | get_navigation_mesh() | +----------+----------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 4469356b7..90d380181 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -53,15 +53,15 @@ Methods +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_polygons` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | +| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_outline_count` **(** **)** const | +| :ref:`int` | :ref:`get_outline_count` **(** **)** |const| | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | +| :ref:`int` | :ref:`get_polygon_count` **(** **)** |const| | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | +| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** |const| | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_polygons_from_outlines` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -117,7 +117,7 @@ Clears the array of polygons, but it doesn't clear the array of outlines and ver .. _class_NavigationPolygon_method_get_outline: -- :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const +- :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** |const| Returns a :ref:`PoolVector2Array` containing the vertices of an outline that was created in the editor or by script. @@ -125,7 +125,7 @@ Returns a :ref:`PoolVector2Array` containing the vertice .. _class_NavigationPolygon_method_get_outline_count: -- :ref:`int` **get_outline_count** **(** **)** const +- :ref:`int` **get_outline_count** **(** **)** |const| Returns the number of outlines that were created in the editor or by script. @@ -141,7 +141,7 @@ Returns a :ref:`PoolIntArray` containing the indices of the .. _class_NavigationPolygon_method_get_polygon_count: -- :ref:`int` **get_polygon_count** **(** **)** const +- :ref:`int` **get_polygon_count** **(** **)** |const| Returns the count of all polygons. @@ -149,7 +149,7 @@ Returns the count of all polygons. .. _class_NavigationPolygon_method_get_vertices: -- :ref:`PoolVector2Array` **get_vertices** **(** **)** const +- :ref:`PoolVector2Array` **get_vertices** **(** **)** |const| Returns a :ref:`PoolVector2Array` containing all the vertices being used to create the polygons. @@ -185,3 +185,6 @@ Changes an outline created in the editor or by script. You have to call :ref:`ma Sets the vertices that can be then indexed to create polygons with the :ref:`add_polygon` method. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index 27005b7f4..b1e2588c3 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -49,3 +49,6 @@ Property Descriptions | *Getter* | get_navigation_polygon() | +----------+-------------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 0c3648bd2..5452221b8 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -60,13 +60,13 @@ Methods +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_peer` **(** :ref:`int` id, :ref:`bool` now=false **)** | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_packet_channel` **(** **)** const | +| :ref:`int` | :ref:`get_last_packet_channel` **(** **)** |const| | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_channel` **(** **)** const | +| :ref:`int` | :ref:`get_packet_channel` **(** **)** |const| | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | +| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** |const| | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | +| :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** |const| | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -254,7 +254,7 @@ Disconnect the given peer. If "now" is set to ``true``, the connection will be c .. _class_NetworkedMultiplayerENet_method_get_last_packet_channel: -- :ref:`int` **get_last_packet_channel** **(** **)** const +- :ref:`int` **get_last_packet_channel** **(** **)** |const| Returns the channel of the last packet fetched via :ref:`PacketPeer.get_packet`. @@ -262,7 +262,7 @@ Returns the channel of the last packet fetched via :ref:`PacketPeer.get_packet` **get_packet_channel** **(** **)** const +- :ref:`int` **get_packet_channel** **(** **)** |const| Returns the channel of the next packet that will be retrieved via :ref:`PacketPeer.get_packet`. @@ -270,7 +270,7 @@ Returns the channel of the next packet that will be retrieved via :ref:`PacketPe .. _class_NetworkedMultiplayerENet_method_get_peer_address: -- :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const +- :ref:`String` **get_peer_address** **(** :ref:`int` id **)** |const| Returns the IP address of the given peer. @@ -278,7 +278,7 @@ Returns the IP address of the given peer. .. _class_NetworkedMultiplayerENet_method_get_peer_port: -- :ref:`int` **get_peer_port** **(** :ref:`int` id **)** const +- :ref:`int` **get_peer_port** **(** :ref:`int` id **)** |const| Returns the remote port of the given peer. @@ -306,3 +306,6 @@ Configure the :ref:`X509Certificate` to use when :ref:`us Configure the :ref:`CryptoKey` to use when :ref:`use_dtls` is ``true``. Remember to also call :ref:`set_dtls_certificate` to setup your :ref:`X509Certificate`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 6a6858272..0aaf95716 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -38,11 +38,11 @@ Methods ------- +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`ConnectionStatus` | :ref:`get_connection_status` **(** **)** const | +| :ref:`ConnectionStatus` | :ref:`get_connection_status` **(** **)** |const| | +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_peer` **(** **)** const | +| :ref:`int` | :ref:`get_packet_peer` **(** **)** |const| | +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unique_id` **(** **)** const | +| :ref:`int` | :ref:`get_unique_id` **(** **)** |const| | +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | void | :ref:`poll` **(** **)** | +-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ @@ -176,7 +176,7 @@ Method Descriptions .. _class_NetworkedMultiplayerPeer_method_get_connection_status: -- :ref:`ConnectionStatus` **get_connection_status** **(** **)** const +- :ref:`ConnectionStatus` **get_connection_status** **(** **)** |const| Returns the current state of the connection. See :ref:`ConnectionStatus`. @@ -184,7 +184,7 @@ Returns the current state of the connection. See :ref:`ConnectionStatus` **get_packet_peer** **(** **)** const +- :ref:`int` **get_packet_peer** **(** **)** |const| Returns the ID of the ``NetworkedMultiplayerPeer`` who sent the most recent packet. @@ -192,7 +192,7 @@ Returns the ID of the ``NetworkedMultiplayerPeer`` who sent the most recent pack .. _class_NetworkedMultiplayerPeer_method_get_unique_id: -- :ref:`int` **get_unique_id** **(** **)** const +- :ref:`int` **get_unique_id** **(** **)** |const| Returns the ID of this ``NetworkedMultiplayerPeer``. @@ -214,3 +214,6 @@ Sets the peer to which packets will be sent. The ``id`` can be one of: :ref:`TARGET_PEER_BROADCAST` to send to all connected peers, :ref:`TARGET_PEER_SERVER` to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is :ref:`TARGET_PEER_BROADCAST`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 71e1fbdc9..65ec096c9 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -47,7 +47,7 @@ Methods ------- +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_patch_margin` **(** :ref:`Margin` margin **)** const | +| :ref:`int` | :ref:`get_patch_margin` **(** :ref:`Margin` margin **)** |const| | +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_patch_margin` **(** :ref:`Margin` margin, :ref:`int` value **)** | +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -228,7 +228,7 @@ Method Descriptions .. _class_NinePatchRect_method_get_patch_margin: -- :ref:`int` **get_patch_margin** **(** :ref:`Margin` margin **)** const +- :ref:`int` **get_patch_margin** **(** :ref:`Margin` margin **)** |const| Returns the size of the margin identified by the given :ref:`Margin` constant. @@ -240,3 +240,6 @@ Returns the size of the margin identified by the given :ref:`Margin` constant to ``value`` in pixels. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_node.rst b/classes/class_node.rst index 6109b3070..3c43498eb 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -68,23 +68,23 @@ Methods ------- +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_enter_tree` **(** **)** virtual | +| void | :ref:`_enter_tree` **(** **)** |virtual| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_exit_tree` **(** **)** virtual | +| void | :ref:`_exit_tree` **(** **)** |virtual| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_configuration_warning` **(** **)** virtual | +| :ref:`String` | :ref:`_get_configuration_warning` **(** **)** |virtual| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | +| void | :ref:`_input` **(** :ref:`InputEvent` event **)** |virtual| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_physics_process` **(** :ref:`float` delta **)** virtual | +| void | :ref:`_physics_process` **(** :ref:`float` delta **)** |virtual| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | +| void | :ref:`_process` **(** :ref:`float` delta **)** |virtual| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_ready` **(** **)** virtual | +| void | :ref:`_ready` **(** **)** |virtual| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | +| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** |virtual| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** |virtual| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -92,79 +92,79 @@ Methods +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_process` **(** **)** const | +| :ref:`bool` | :ref:`can_process` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | +| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | +| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_parent` **(** :ref:`String` mask **)** const | +| :ref:`Node` | :ref:`find_parent` **(** :ref:`String` mask **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | +| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_child_count` **(** **)** const | +| :ref:`int` | :ref:`get_child_count` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_children` **(** **)** const | +| :ref:`Array` | :ref:`get_children` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** const | +| :ref:`Array` | :ref:`get_groups` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | +| :ref:`int` | :ref:`get_index` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_master` **(** **)** const | +| :ref:`int` | :ref:`get_network_master` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | +| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node_or_null` **(** :ref:`NodePath` path **)** const | +| :ref:`Node` | :ref:`get_node_or_null` **(** :ref:`NodePath` path **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_parent` **(** **)** const | +| :ref:`Node` | :ref:`get_parent` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path` **(** **)** const | +| :ref:`NodePath` | :ref:`get_path` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | +| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** const | +| :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | +| :ref:`int` | :ref:`get_position_in_parent` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | +| :ref:`float` | :ref:`get_process_delta_time` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | +| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | +| :ref:`SceneTree` | :ref:`get_tree` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | +| :ref:`Viewport` | :ref:`get_viewport` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | +| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | +| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | +| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | +| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | +| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | +| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | +| :ref:`bool` | :ref:`is_inside_tree` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_master` **(** **)** const | +| :ref:`bool` | :ref:`is_network_master` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_physics_processing` **(** **)** const | +| :ref:`bool` | :ref:`is_physics_processing` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** const | +| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing` **(** **)** const | +| :ref:`bool` | :ref:`is_processing` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | +| :ref:`bool` | :ref:`is_processing_input` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | +| :ref:`bool` | :ref:`is_processing_internal` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | +| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | +| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** |const| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -192,15 +192,15 @@ Methods +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`request_ready` **(** **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method, ... **)** vararg | +| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method, ... **)** |vararg| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`RPCMode` mode **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg | +| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method, ... **)** |vararg| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method, ... **)** vararg | +| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method, ... **)** |vararg| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg | +| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method, ... **)** |vararg| | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -354,6 +354,8 @@ Constants .. _class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS: +.. _class_Node_constant_NOTIFICATION_POST_ENTER_TREE: + .. _class_Node_constant_NOTIFICATION_WM_MOUSE_ENTER: .. _class_Node_constant_NOTIFICATION_WM_MOUSE_EXIT: @@ -416,6 +418,8 @@ Constants - **NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = **26** --- Notification received every frame when the internal physics process flag is set (see :ref:`set_physics_process_internal`). +- **NOTIFICATION_POST_ENTER_TREE** = **27** --- Notification received when the node is ready, just before :ref:`NOTIFICATION_READY` is received. Unlike the latter, it's sent every time the node enters tree, instead of only once. + - **NOTIFICATION_WM_MOUSE_ENTER** = **1002** --- Notification received from the OS when the mouse enters the game window. Implemented on desktop and web platforms. @@ -576,7 +580,7 @@ Method Descriptions .. _class_Node_method__enter_tree: -- void **_enter_tree** **(** **)** virtual +- void **_enter_tree** **(** **)** |virtual| Called when the node enters the :ref:`SceneTree` (e.g. upon instancing, scene changing, or after calling :ref:`add_child` in a script). If the node has children, its :ref:`_enter_tree` callback will be called first, and then that of the children. @@ -586,7 +590,7 @@ Corresponds to the :ref:`NOTIFICATION_ENTER_TREE` (e.g. upon freeing, scene changing, or after calling :ref:`remove_child` in a script). If the node has children, its :ref:`_exit_tree` callback will be called last, after all its children have left the tree. @@ -596,7 +600,7 @@ Corresponds to the :ref:`NOTIFICATION_EXIT_TREE` **_get_configuration_warning** **(** **)** virtual +- :ref:`String` **_get_configuration_warning** **(** **)** |virtual| The string returned from this method is displayed as a warning in the Scene Dock if the script that overrides it is a ``tool`` script. @@ -608,7 +612,7 @@ Call :ref:`update_configuration_warning` event **)** virtual +- void **_input** **(** :ref:`InputEvent` event **)** |virtual| Called when there is an input event. The input event propagates up through the node tree until a node consumes it. @@ -624,7 +628,7 @@ For gameplay input, :ref:`_unhandled_input` .. _class_Node_method__physics_process: -- void **_physics_process** **(** :ref:`float` delta **)** virtual +- void **_physics_process** **(** :ref:`float` delta **)** |virtual| Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the ``delta`` variable should be constant. @@ -638,7 +642,7 @@ Corresponds to the :ref:`NOTIFICATION_PHYSICS_PROCESS` delta **)** virtual +- void **_process** **(** :ref:`float` delta **)** |virtual| Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the ``delta`` time since the previous frame is not constant. @@ -652,7 +656,7 @@ Corresponds to the :ref:`NOTIFICATION_PROCESS` callbacks get triggered first, and the parent node will receive the ready notification afterwards. @@ -666,7 +670,7 @@ Usually used for initialization. For even earlier initialization, :ref:`Object._ .. _class_Node_method__unhandled_input: -- void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual +- void **_unhandled_input** **(** :ref:`InputEvent` event **)** |virtual| Called when an :ref:`InputEvent` hasn't been consumed by :ref:`_input` or any GUI. The input event propagates up through the node tree until a node consumes it. @@ -682,7 +686,7 @@ For gameplay input, this and :ref:`_unhandled_key_input` event **)** virtual +- void **_unhandled_key_input** **(** :ref:`InputEventKey` event **)** |virtual| Called when an :ref:`InputEventKey` hasn't been consumed by :ref:`_input` or any GUI. The input event propagates up through the node tree until a node consumes it. @@ -738,7 +742,7 @@ The ``persistent`` option is used when packing node to :ref:`PackedScene` **can_process** **(** **)** const +- :ref:`bool` **can_process** **(** **)** |const| Returns ``true`` if the node can process while the scene tree is paused (see :ref:`pause_mode`). Always returns ``true`` if the scene tree is not paused, and ``false`` if the node is not in the tree. @@ -746,7 +750,7 @@ Returns ``true`` if the node can process while the scene tree is paused (see :re .. _class_Node_method_duplicate: -- :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const +- :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** |const| Duplicates the node, returning a new node. @@ -758,7 +762,7 @@ You can fine-tune the behavior using the ``flags`` (see :ref:`DuplicateFlags` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const +- :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** |const| Finds a descendant of this node whose name matches ``mask`` as in :ref:`String.match` (i.e. case-sensitive, but ``"*"`` matches zero or more characters and ``"?"`` matches any single character except ``"."``). @@ -766,21 +770,25 @@ Finds a descendant of this node whose name matches ``mask`` as in :ref:`String.m If ``owned`` is ``true``, this method only finds nodes whose owner is this node. This is especially important for scenes instantiated through a script, because those scenes don't have an owner. +**Note:** As this method walks through all the descendants of the node, it is the slowest way to get a reference to another node. Whenever possible, consider using :ref:`get_node` instead. To avoid using :ref:`find_node` too often, consider caching the node reference into a variable. + ---- .. _class_Node_method_find_parent: -- :ref:`Node` **find_parent** **(** :ref:`String` mask **)** const +- :ref:`Node` **find_parent** **(** :ref:`String` mask **)** |const| Finds the first parent of the current node whose name matches ``mask`` as in :ref:`String.match` (i.e. case-sensitive, but ``"*"`` matches zero or more characters and ``"?"`` matches any single character except ``"."``). **Note:** It does not match against the full path, just against individual node names. +**Note:** As this method walks upwards in the scene tree, it can be slow in large, deeply nested scene trees. Whenever possible, consider using :ref:`get_node` instead. To avoid using :ref:`find_parent` too often, consider caching the node reference into a variable. + ---- .. _class_Node_method_get_child: -- :ref:`Node` **get_child** **(** :ref:`int` idx **)** const +- :ref:`Node` **get_child** **(** :ref:`int` idx **)** |const| Returns a child node by its index (see :ref:`get_child_count`). This method is often used for iterating all children of a node. @@ -790,7 +798,7 @@ To access a child node via its name, use :ref:`get_node` **get_child_count** **(** **)** const +- :ref:`int` **get_child_count** **(** **)** |const| Returns the number of child nodes. @@ -798,7 +806,7 @@ Returns the number of child nodes. .. _class_Node_method_get_children: -- :ref:`Array` **get_children** **(** **)** const +- :ref:`Array` **get_children** **(** **)** |const| Returns an array of references to node's children. @@ -806,7 +814,7 @@ Returns an array of references to node's children. .. _class_Node_method_get_groups: -- :ref:`Array` **get_groups** **(** **)** const +- :ref:`Array` **get_groups** **(** **)** |const| Returns an array listing the groups that the node is a member of. @@ -814,7 +822,7 @@ Returns an array listing the groups that the node is a member of. .. _class_Node_method_get_index: -- :ref:`int` **get_index** **(** **)** const +- :ref:`int` **get_index** **(** **)** |const| Returns the node's index, i.e. its position among the siblings of its parent. @@ -822,7 +830,7 @@ Returns the node's index, i.e. its position among the siblings of its parent. .. _class_Node_method_get_network_master: -- :ref:`int` **get_network_master** **(** **)** const +- :ref:`int` **get_network_master** **(** **)** |const| Returns the peer ID of the network master for this node. See :ref:`set_network_master`. @@ -830,7 +838,7 @@ Returns the peer ID of the network master for this node. See :ref:`set_network_m .. _class_Node_method_get_node: -- :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const +- :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** |const| Fetches a node. The :ref:`NodePath` can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a ``null instance`` is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call on a null instance." error. @@ -880,7 +888,7 @@ For example, assuming that ``Area2D/CollisionShape2D`` is a valid node and that .. _class_Node_method_get_node_or_null: -- :ref:`Node` **get_node_or_null** **(** :ref:`NodePath` path **)** const +- :ref:`Node` **get_node_or_null** **(** :ref:`NodePath` path **)** |const| Similar to :ref:`get_node`, but does not log an error if ``path`` does not point to a valid ``Node``. @@ -888,7 +896,7 @@ Similar to :ref:`get_node`, but does not log an erro .. _class_Node_method_get_parent: -- :ref:`Node` **get_parent** **(** **)** const +- :ref:`Node` **get_parent** **(** **)** |const| Returns the parent node of the current node, or a ``null instance`` if the node lacks a parent. @@ -896,7 +904,7 @@ Returns the parent node of the current node, or a ``null instance`` if the node .. _class_Node_method_get_path: -- :ref:`NodePath` **get_path** **(** **)** const +- :ref:`NodePath` **get_path** **(** **)** |const| Returns the absolute path of the current node. This only works if the current node is inside the scene tree (see :ref:`is_inside_tree`). @@ -904,7 +912,7 @@ Returns the absolute path of the current node. This only works if the current no .. _class_Node_method_get_path_to: -- :ref:`NodePath` **get_path_to** **(** :ref:`Node` node **)** const +- :ref:`NodePath` **get_path_to** **(** :ref:`Node` node **)** |const| Returns the relative :ref:`NodePath` from this node to the specified ``node``. Both nodes must be in the same scene or the function will fail. @@ -912,7 +920,7 @@ Returns the relative :ref:`NodePath` from this node to the speci .. _class_Node_method_get_physics_process_delta_time: -- :ref:`float` **get_physics_process_delta_time** **(** **)** const +- :ref:`float` **get_physics_process_delta_time** **(** **)** |const| Returns the time elapsed since the last physics-bound frame (see :ref:`_physics_process`). This is always a constant value in physics processing unless the frames per second is changed via :ref:`Engine.iterations_per_second`. @@ -920,7 +928,7 @@ Returns the time elapsed since the last physics-bound frame (see :ref:`_physics_ .. _class_Node_method_get_position_in_parent: -- :ref:`int` **get_position_in_parent** **(** **)** const +- :ref:`int` **get_position_in_parent** **(** **)** |const| Returns the node's order in the scene tree branch. For example, if called on the first child node the position is ``0``. @@ -928,7 +936,7 @@ Returns the node's order in the scene tree branch. For example, if called on the .. _class_Node_method_get_process_delta_time: -- :ref:`float` **get_process_delta_time** **(** **)** const +- :ref:`float` **get_process_delta_time** **(** **)** |const| Returns the time elapsed (in seconds) since the last process callback. This value may vary from frame to frame. @@ -936,7 +944,7 @@ Returns the time elapsed (in seconds) since the last process callback. This valu .. _class_Node_method_get_scene_instance_load_placeholder: -- :ref:`bool` **get_scene_instance_load_placeholder** **(** **)** const +- :ref:`bool` **get_scene_instance_load_placeholder** **(** **)** |const| Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlaceholder`. @@ -944,7 +952,7 @@ Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlac .. _class_Node_method_get_tree: -- :ref:`SceneTree` **get_tree** **(** **)** const +- :ref:`SceneTree` **get_tree** **(** **)** |const| Returns the :ref:`SceneTree` that contains this node. @@ -952,7 +960,7 @@ Returns the :ref:`SceneTree` that contains this node. .. _class_Node_method_get_viewport: -- :ref:`Viewport` **get_viewport** **(** **)** const +- :ref:`Viewport` **get_viewport** **(** **)** |const| Returns the node's :ref:`Viewport`. @@ -960,7 +968,7 @@ Returns the node's :ref:`Viewport`. .. _class_Node_method_has_node: -- :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** const +- :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** |const| Returns ``true`` if the node that the :ref:`NodePath` points to exists. @@ -968,7 +976,7 @@ Returns ``true`` if the node that the :ref:`NodePath` points to .. _class_Node_method_has_node_and_resource: -- :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const +- :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** |const| Returns ``true`` if the :ref:`NodePath` points to a valid node and its subname points to a valid resource, e.g. ``Area2D/CollisionShape2D:shape``. Properties with a non-:ref:`Resource` type (e.g. nodes or primitive math types) are not considered resources. @@ -976,7 +984,7 @@ Returns ``true`` if the :ref:`NodePath` points to a valid node a .. _class_Node_method_is_a_parent_of: -- :ref:`bool` **is_a_parent_of** **(** :ref:`Node` node **)** const +- :ref:`bool` **is_a_parent_of** **(** :ref:`Node` node **)** |const| Returns ``true`` if the given node is a direct or indirect child of the current node. @@ -984,7 +992,7 @@ Returns ``true`` if the given node is a direct or indirect child of the current .. _class_Node_method_is_displayed_folded: -- :ref:`bool` **is_displayed_folded** **(** **)** const +- :ref:`bool` **is_displayed_folded** **(** **)** |const| Returns ``true`` if the node is folded (collapsed) in the Scene dock. @@ -992,7 +1000,7 @@ Returns ``true`` if the node is folded (collapsed) in the Scene dock. .. _class_Node_method_is_greater_than: -- :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** const +- :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** |const| Returns ``true`` if the given node occurs later in the scene hierarchy than the current node. @@ -1000,7 +1008,7 @@ Returns ``true`` if the given node occurs later in the scene hierarchy than the .. _class_Node_method_is_in_group: -- :ref:`bool` **is_in_group** **(** :ref:`String` group **)** const +- :ref:`bool` **is_in_group** **(** :ref:`String` group **)** |const| Returns ``true`` if this node is in the specified group. See notes in the description, and the group methods in :ref:`SceneTree`. @@ -1008,7 +1016,7 @@ Returns ``true`` if this node is in the specified group. See notes in the descri .. _class_Node_method_is_inside_tree: -- :ref:`bool` **is_inside_tree** **(** **)** const +- :ref:`bool` **is_inside_tree** **(** **)** |const| Returns ``true`` if this node is currently inside a :ref:`SceneTree`. @@ -1016,7 +1024,7 @@ Returns ``true`` if this node is currently inside a :ref:`SceneTree` **is_network_master** **(** **)** const +- :ref:`bool` **is_network_master** **(** **)** |const| Returns ``true`` if the local system is the master of this node. @@ -1024,7 +1032,7 @@ Returns ``true`` if the local system is the master of this node. .. _class_Node_method_is_physics_processing: -- :ref:`bool` **is_physics_processing** **(** **)** const +- :ref:`bool` **is_physics_processing** **(** **)** |const| Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process`). @@ -1032,7 +1040,7 @@ Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process .. _class_Node_method_is_physics_processing_internal: -- :ref:`bool` **is_physics_processing_internal** **(** **)** const +- :ref:`bool` **is_physics_processing_internal** **(** **)** |const| Returns ``true`` if internal physics processing is enabled (see :ref:`set_physics_process_internal`). @@ -1040,7 +1048,7 @@ Returns ``true`` if internal physics processing is enabled (see :ref:`set_physic .. _class_Node_method_is_processing: -- :ref:`bool` **is_processing** **(** **)** const +- :ref:`bool` **is_processing** **(** **)** |const| Returns ``true`` if processing is enabled (see :ref:`set_process`). @@ -1048,7 +1056,7 @@ Returns ``true`` if processing is enabled (see :ref:`set_process` **is_processing_input** **(** **)** const +- :ref:`bool` **is_processing_input** **(** **)** |const| Returns ``true`` if the node is processing input (see :ref:`set_process_input`). @@ -1056,7 +1064,7 @@ Returns ``true`` if the node is processing input (see :ref:`set_process_input` **is_processing_internal** **(** **)** const +- :ref:`bool` **is_processing_internal** **(** **)** |const| Returns ``true`` if internal processing is enabled (see :ref:`set_process_internal`). @@ -1064,7 +1072,7 @@ Returns ``true`` if internal processing is enabled (see :ref:`set_process_intern .. _class_Node_method_is_processing_unhandled_input: -- :ref:`bool` **is_processing_unhandled_input** **(** **)** const +- :ref:`bool` **is_processing_unhandled_input** **(** **)** |const| Returns ``true`` if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). @@ -1072,7 +1080,7 @@ Returns ``true`` if the node is processing unhandled input (see :ref:`set_proces .. _class_Node_method_is_processing_unhandled_key_input: -- :ref:`bool` **is_processing_unhandled_key_input** **(** **)** const +- :ref:`bool` **is_processing_unhandled_key_input** **(** **)** |const| Returns ``true`` if the node is processing unhandled key input (see :ref:`set_process_unhandled_key_input`). @@ -1127,7 +1135,7 @@ Similar to :ref:`print_tree`, this prints the tree ┠╴Menu ┃ ┠╴Label ┃ ┖╴Camera2D - ┖-SplashScreen + ┖╴SplashScreen ┖╴Camera2D ---- @@ -1206,7 +1214,7 @@ Requests that ``_ready`` be called again. Note that the method won't be called i .. _class_Node_method_rpc: -- :ref:`Variant` **rpc** **(** :ref:`String` method, ... **)** vararg +- :ref:`Variant` **rpc** **(** :ref:`String` method, ... **)** |vararg| Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath`, including the exact same node name. Behaviour depends on the RPC configuration for the given method, see :ref:`rpc_config`. Methods are not exposed to RPCs by default. See also :ref:`rset` and :ref:`rset_config` for properties. Returns an empty :ref:`Variant`. @@ -1224,7 +1232,7 @@ Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`R .. _class_Node_method_rpc_id: -- :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg +- :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method, ... **)** |vararg| Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. @@ -1232,7 +1240,7 @@ Sends a :ref:`rpc` to a specific peer identified by ``pee .. _class_Node_method_rpc_unreliable: -- :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method, ... **)** vararg +- :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method, ... **)** |vararg| Sends a :ref:`rpc` using an unreliable protocol. Returns an empty :ref:`Variant`. @@ -1240,7 +1248,7 @@ Sends a :ref:`rpc` using an unreliable protocol. Returns .. _class_Node_method_rpc_unreliable_id: -- :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg +- :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method, ... **)** |vararg| Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. @@ -1374,3 +1382,6 @@ Updates the warning displayed for this node in the Scene Dock. Use :ref:`_get_configuration_warning` to setup the warning message to display. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 779853b20..47e2434a2 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -57,29 +57,29 @@ Properties Methods ------- -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_scale` **(** :ref:`Vector2` ratio **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate` **(** :ref:`float` radians **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_scale` **(** :ref:`Vector2` ratio **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** |const| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** |const| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate` **(** :ref:`float` radians **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** |const| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** |const| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -275,7 +275,7 @@ Multiplies the current scale by the ``ratio`` vector. .. _class_Node2D_method_get_angle_to: -- :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const +- :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** |const| Returns the angle between the node and the ``point`` in radians. @@ -283,7 +283,7 @@ Returns the angle between the node and the ``point`` in radians. .. _class_Node2D_method_get_relative_transform_to_parent: -- :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const +- :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** |const| Returns the :ref:`Transform2D` relative to this node's parent. @@ -331,7 +331,7 @@ Applies a rotation to the node, in radians, starting from its current rotation. .. _class_Node2D_method_to_global: -- :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const +- :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** |const| Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the ``Node2D`` it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node's own position will give an incorrect result, as it will incorporate the node's own transformation into its global position. @@ -339,7 +339,7 @@ Transforms the provided local position into a position in global coordinate spac .. _class_Node2D_method_to_local: -- :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** const +- :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** |const| Transforms the provided global position into a position in local coordinate space. The output will be local relative to the ``Node2D`` it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent. @@ -351,3 +351,6 @@ Transforms the provided global position into a position in local coordinate spac Translates the node by the given ``offset`` in local coordinates. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 6c882b9a8..28270be33 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -180,3 +180,6 @@ Returns ``true`` if the node path is absolute (as opposed to relative), which me Returns ``true`` if the node path is empty. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index e6e836c30..16ef669b0 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -142,3 +142,6 @@ Whether the texture can be tiled without visible seams or not. Seamless textures Width of the generated texture. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_object.rst b/classes/class_object.rst index bc2fa5f1e..50dbfa2db 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -49,75 +49,75 @@ Methods ------- +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_get` **(** :ref:`String` property **)** virtual | +| :ref:`Variant` | :ref:`_get` **(** :ref:`String` property **)** |virtual| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | +| :ref:`Array` | :ref:`_get_property_list` **(** **)** |virtual| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_init` **(** **)** virtual | +| void | :ref:`_init` **(** **)** |virtual| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | +| void | :ref:`_notification` **(** :ref:`int` what **)** |virtual| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | +| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** |virtual| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_to_string` **(** **)** virtual | +| :ref:`String` | :ref:`_to_string` **(** **)** |virtual| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** :ref:`String` method, ... **)** vararg | +| :ref:`Variant` | :ref:`call` **(** :ref:`String` method, ... **)** |vararg| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_deferred` **(** :ref:`String` method, ... **)** vararg | +| void | :ref:`call_deferred` **(** :ref:`String` method, ... **)** |vararg| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | +| :ref:`bool` | :ref:`can_translate_messages` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`emit_signal` **(** :ref:`String` signal, ... **)** vararg | +| void | :ref:`emit_signal` **(** :ref:`String` signal, ... **)** |vararg| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`free` **(** **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | +| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class` **(** **)** const | +| :ref:`String` | :ref:`get_class` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | +| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property **)** const | +| :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_id` **(** **)** const | +| :ref:`int` | :ref:`get_instance_id` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | +| :ref:`Array` | :ref:`get_method_list` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | +| :ref:`Array` | :ref:`get_property_list` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Reference` | :ref:`get_script` **(** **)** const | +| :ref:`Reference` | :ref:`get_script` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | +| :ref:`Array` | :ref:`get_signal_list` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | +| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_signal` **(** :ref:`String` signal **)** const | +| :ref:`bool` | :ref:`has_signal` **(** :ref:`String` signal **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | +| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class` **(** :ref:`String` class **)** const | +| :ref:`bool` | :ref:`is_class` **(** :ref:`String` class **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | +| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | +| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -141,7 +141,7 @@ Methods +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_string` **(** **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | +| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** |const| | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -192,7 +192,7 @@ Method Descriptions .. _class_Object_method__get: -- :ref:`Variant` **_get** **(** :ref:`String` property **)** virtual +- :ref:`Variant` **_get** **(** :ref:`String` property **)** |virtual| Virtual method which can be overridden to customize the return value of :ref:`get`. @@ -202,7 +202,7 @@ Returns the given property. Returns ``null`` if the ``property`` does not exist. .. _class_Object_method__get_property_list: -- :ref:`Array` **_get_property_list** **(** **)** virtual +- :ref:`Array` **_get_property_list** **(** **)** |virtual| Virtual method which can be overridden to customize the return value of :ref:`get_property_list`. @@ -214,7 +214,7 @@ Each property's :ref:`Dictionary` must contain at least ``name .. _class_Object_method__init: -- void **_init** **(** **)** virtual +- void **_init** **(** **)** |virtual| Called when the object is initialized. @@ -222,7 +222,7 @@ Called when the object is initialized. .. _class_Object_method__notification: -- void **_notification** **(** :ref:`int` what **)** virtual +- void **_notification** **(** :ref:`int` what **)** |virtual| Called whenever the object receives a notification, which is identified in ``what`` by a constant. The base ``Object`` has two constants :ref:`NOTIFICATION_POSTINITIALIZE` and :ref:`NOTIFICATION_PREDELETE`, but subclasses such as :ref:`Node` define a lot more notifications which are also received by this method. @@ -230,7 +230,7 @@ Called whenever the object receives a notification, which is identified in ``wha .. _class_Object_method__set: -- :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual +- :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** |virtual| Virtual method which can be overridden to customize the return value of :ref:`set`. @@ -240,7 +240,7 @@ Sets a property. Returns ``true`` if the ``property`` exists. .. _class_Object_method__to_string: -- :ref:`String` **_to_string** **(** **)** virtual +- :ref:`String` **_to_string** **(** **)** |virtual| Virtual method which can be overridden to customize the return value of :ref:`to_string`, and thus the object's representation where it is converted to a string, e.g. with ``print(obj)``. @@ -258,7 +258,7 @@ Adds a user-defined ``signal``. Arguments are optional, but can be added as an : .. _class_Object_method_call: -- :ref:`Variant` **call** **(** :ref:`String` method, ... **)** vararg +- :ref:`Variant` **call** **(** :ref:`String` method, ... **)** |vararg| Calls the ``method`` on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: @@ -272,7 +272,7 @@ Calls the ``method`` on the object and returns the result. This method supports .. _class_Object_method_call_deferred: -- void **call_deferred** **(** :ref:`String` method, ... **)** vararg +- void **call_deferred** **(** :ref:`String` method, ... **)** |vararg| Calls the ``method`` on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: @@ -298,7 +298,7 @@ Calls the ``method`` on the object and returns the result. Contrarily to :ref:`c .. _class_Object_method_can_translate_messages: -- :ref:`bool` **can_translate_messages** **(** **)** const +- :ref:`bool` **can_translate_messages** **(** **)** |const| Returns ``true`` if the object can translate strings. See :ref:`set_message_translation` and :ref:`tr`. @@ -345,7 +345,7 @@ If you try to disconnect a connection that does not exist, the method will throw .. _class_Object_method_emit_signal: -- void **emit_signal** **(** :ref:`String` signal, ... **)** vararg +- void **emit_signal** **(** :ref:`String` signal, ... **)** |vararg| Emits the given ``signal``. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: @@ -366,7 +366,7 @@ Deletes the object from memory. Any pre-existing reference to the freed object w .. _class_Object_method_get: -- :ref:`Variant` **get** **(** :ref:`String` property **)** const +- :ref:`Variant` **get** **(** :ref:`String` property **)** |const| Returns the :ref:`Variant` value of the given ``property``. If the ``property`` doesn't exist, this will return ``null``. @@ -376,7 +376,7 @@ Returns the :ref:`Variant` value of the given ``property``. If th .. _class_Object_method_get_class: -- :ref:`String` **get_class** **(** **)** const +- :ref:`String` **get_class** **(** **)** |const| Returns the object's class as a :ref:`String`. @@ -384,7 +384,7 @@ Returns the object's class as a :ref:`String`. .. _class_Object_method_get_incoming_connections: -- :ref:`Array` **get_incoming_connections** **(** **)** const +- :ref:`Array` **get_incoming_connections** **(** **)** |const| Returns an :ref:`Array` of dictionaries with information about signals that are connected to the object. @@ -400,7 +400,7 @@ Each :ref:`Dictionary` contains three String entries: .. _class_Object_method_get_indexed: -- :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** const +- :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** |const| Gets the object's property indexed by the given :ref:`NodePath`. The node path should be relative to the current object and can use the colon character (``:``) to access nested properties. Examples: ``"position:x"`` or ``"material:next_pass:blend_mode"``. @@ -408,7 +408,7 @@ Gets the object's property indexed by the given :ref:`NodePath`. .. _class_Object_method_get_instance_id: -- :ref:`int` **get_instance_id** **(** **)** const +- :ref:`int` **get_instance_id** **(** **)** |const| Returns the object's unique instance ID. @@ -418,7 +418,7 @@ This ID can be saved in :ref:`EncodedObjectAsID`, and c .. _class_Object_method_get_meta: -- :ref:`Variant` **get_meta** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_meta** **(** :ref:`String` name **)** |const| Returns the object's metadata entry for the given ``name``. @@ -426,7 +426,7 @@ Returns the object's metadata entry for the given ``name``. .. _class_Object_method_get_meta_list: -- :ref:`PoolStringArray` **get_meta_list** **(** **)** const +- :ref:`PoolStringArray` **get_meta_list** **(** **)** |const| Returns the object's metadata as a :ref:`PoolStringArray`. @@ -434,7 +434,7 @@ Returns the object's metadata as a :ref:`PoolStringArray` .. _class_Object_method_get_method_list: -- :ref:`Array` **get_method_list** **(** **)** const +- :ref:`Array` **get_method_list** **(** **)** |const| Returns the object's methods and their signatures as an :ref:`Array`. @@ -442,7 +442,7 @@ Returns the object's methods and their signatures as an :ref:`Array .. _class_Object_method_get_property_list: -- :ref:`Array` **get_property_list** **(** **)** const +- :ref:`Array` **get_property_list** **(** **)** |const| Returns the object's property list as an :ref:`Array` of dictionaries. @@ -452,7 +452,7 @@ Each property's :ref:`Dictionary` contain at least ``name: Str .. _class_Object_method_get_script: -- :ref:`Reference` **get_script** **(** **)** const +- :ref:`Reference` **get_script** **(** **)** |const| Returns the object's :ref:`Script` instance, or ``null`` if none is assigned. @@ -460,7 +460,7 @@ Returns the object's :ref:`Script` instance, or ``null`` if none i .. _class_Object_method_get_signal_connection_list: -- :ref:`Array` **get_signal_connection_list** **(** :ref:`String` signal **)** const +- :ref:`Array` **get_signal_connection_list** **(** :ref:`String` signal **)** |const| Returns an :ref:`Array` of connections for the given ``signal``. @@ -468,7 +468,7 @@ Returns an :ref:`Array` of connections for the given ``signal``. .. _class_Object_method_get_signal_list: -- :ref:`Array` **get_signal_list** **(** **)** const +- :ref:`Array` **get_signal_list** **(** **)** |const| Returns the list of signals as an :ref:`Array` of dictionaries. @@ -476,7 +476,7 @@ Returns the list of signals as an :ref:`Array` of dictionaries. .. _class_Object_method_has_meta: -- :ref:`bool` **has_meta** **(** :ref:`String` name **)** const +- :ref:`bool` **has_meta** **(** :ref:`String` name **)** |const| Returns ``true`` if a metadata entry is found with the given ``name``. @@ -484,7 +484,7 @@ Returns ``true`` if a metadata entry is found with the given ``name``. .. _class_Object_method_has_method: -- :ref:`bool` **has_method** **(** :ref:`String` method **)** const +- :ref:`bool` **has_method** **(** :ref:`String` method **)** |const| Returns ``true`` if the object contains the given ``method``. @@ -492,7 +492,7 @@ Returns ``true`` if the object contains the given ``method``. .. _class_Object_method_has_signal: -- :ref:`bool` **has_signal** **(** :ref:`String` signal **)** const +- :ref:`bool` **has_signal** **(** :ref:`String` signal **)** |const| Returns ``true`` if the given ``signal`` exists. @@ -500,7 +500,7 @@ Returns ``true`` if the given ``signal`` exists. .. _class_Object_method_has_user_signal: -- :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** const +- :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** |const| Returns ``true`` if the given user-defined ``signal`` exists. Only signals added using :ref:`add_user_signal` are taken into account. @@ -508,7 +508,7 @@ Returns ``true`` if the given user-defined ``signal`` exists. Only signals added .. _class_Object_method_is_blocking_signals: -- :ref:`bool` **is_blocking_signals** **(** **)** const +- :ref:`bool` **is_blocking_signals** **(** **)** |const| Returns ``true`` if signal emission blocking is enabled. @@ -516,7 +516,7 @@ Returns ``true`` if signal emission blocking is enabled. .. _class_Object_method_is_class: -- :ref:`bool` **is_class** **(** :ref:`String` class **)** const +- :ref:`bool` **is_class** **(** :ref:`String` class **)** |const| Returns ``true`` if the object inherits from the given ``class``. @@ -524,7 +524,7 @@ Returns ``true`` if the object inherits from the given ``class``. .. _class_Object_method_is_connected: -- :ref:`bool` **is_connected** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const +- :ref:`bool` **is_connected** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** |const| Returns ``true`` if a connection exists for a given ``signal``, ``target``, and ``method``. @@ -532,7 +532,7 @@ Returns ``true`` if a connection exists for a given ``signal``, ``target``, and .. _class_Object_method_is_queued_for_deletion: -- :ref:`bool` **is_queued_for_deletion** **(** **)** const +- :ref:`bool` **is_queued_for_deletion** **(** **)** |const| Returns ``true`` if the :ref:`Node.queue_free` method was called for the object. @@ -560,7 +560,7 @@ Notify the editor that the property list has changed, so that editor plugins can - void **remove_meta** **(** :ref:`String` name **)** -Removes a given entry from the object's metadata. +Removes a given entry from the object's metadata. See also :ref:`set_meta`. ---- @@ -618,7 +618,9 @@ Defines whether the object can translate strings (with calls to :ref:`tr` name, :ref:`Variant` value **)** -Adds or changes a given entry in the object's metadata. Metadata are serialized, and can take any :ref:`Variant` value. +Adds, changes or removes a given entry in the object's metadata. Metadata are serialized and can take any :ref:`Variant` value. + +To remove a given entry from the object's metadata, use :ref:`remove_meta`. Metadata is also removed if its value is set to ``null``. This means you can also use ``set_meta("name", null)`` to remove metadata for ``"name"``. ---- @@ -644,9 +646,12 @@ Override the method :ref:`_to_string` to customi .. _class_Object_method_tr: -- :ref:`String` **tr** **(** :ref:`String` message **)** const +- :ref:`String` **tr** **(** :ref:`String` message **)** |const| Translates a message using translation catalogs configured in the Project Settings. Only works if message translation is enabled (which it is by default), otherwise it returns the ``message`` unchanged. See :ref:`set_message_translation`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index fcae3a5d8..70799e19e 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -99,3 +99,6 @@ A :ref:`Vector2` array with the index for polygon's vertices posi **Note:** The returned value is a copy of the underlying array, rather than a reference. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index dfecab69c..7e98981a5 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -130,3 +130,6 @@ See :ref:`ShadowDetail`. See :ref:`ShadowMode`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_opensimplexnoise.rst b/classes/class_opensimplexnoise.rst index 9d61b4078..a972caa90 100644 --- a/classes/class_opensimplexnoise.rst +++ b/classes/class_opensimplexnoise.rst @@ -220,3 +220,6 @@ Returns the 4D noise value ``[-1,1]`` at the given position. Generate a tileable noise image, based on the current noise parameters. Generated seamless images are always square (``size`` × ``size``). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 0c3da5242..803280549 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -43,25 +43,25 @@ Methods +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | +| :ref:`int` | :ref:`get_item_count` **(** **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | +| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | +| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | +| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected_id` **(** **)** const | +| :ref:`int` | :ref:`get_selected_id` **(** **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | +| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -116,7 +116,7 @@ Signals - **item_focused** **(** :ref:`int` index **)** -Emitted the when user navigates to an item using the ``ui_up`` or ``ui_down`` actions. The index of the item selected is passed as argument. +Emitted when the user navigates to an item using the ``ui_up`` or ``ui_down`` actions. The index of the item selected is passed as argument. ---- @@ -178,7 +178,7 @@ Clears all the items in the ``OptionButton``. .. _class_OptionButton_method_get_item_count: -- :ref:`int` **get_item_count** **(** **)** const +- :ref:`int` **get_item_count** **(** **)** |const| Returns the amount of items in the OptionButton, including separators. @@ -186,7 +186,7 @@ Returns the amount of items in the OptionButton, including separators. .. _class_OptionButton_method_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** |const| Returns the icon of the item at index ``idx``. @@ -194,7 +194,7 @@ Returns the icon of the item at index ``idx``. .. _class_OptionButton_method_get_item_id: -- :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const +- :ref:`int` **get_item_id** **(** :ref:`int` idx **)** |const| Returns the ID of the item at index ``idx``. @@ -202,7 +202,7 @@ Returns the ID of the item at index ``idx``. .. _class_OptionButton_method_get_item_index: -- :ref:`int` **get_item_index** **(** :ref:`int` id **)** const +- :ref:`int` **get_item_index** **(** :ref:`int` id **)** |const| Returns the index of the item with the given ``id``. @@ -210,7 +210,7 @@ Returns the index of the item with the given ``id``. .. _class_OptionButton_method_get_item_metadata: -- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** |const| Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID. @@ -218,7 +218,7 @@ Retrieves the metadata of an item. Metadata may be any type and can be used to s .. _class_OptionButton_method_get_item_text: -- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** |const| Returns the text of the item at index ``idx``. @@ -226,7 +226,7 @@ Returns the text of the item at index ``idx``. .. _class_OptionButton_method_get_popup: -- :ref:`PopupMenu` **get_popup** **(** **)** const +- :ref:`PopupMenu` **get_popup** **(** **)** |const| Returns the :ref:`PopupMenu` contained in this button. @@ -234,7 +234,7 @@ Returns the :ref:`PopupMenu` contained in this button. .. _class_OptionButton_method_get_selected_id: -- :ref:`int` **get_selected_id** **(** **)** const +- :ref:`int` **get_selected_id** **(** **)** |const| Returns the ID of the selected item, or ``0`` if no item is selected. @@ -242,7 +242,7 @@ Returns the ID of the selected item, or ``0`` if no item is selected. .. _class_OptionButton_method_get_selected_metadata: -- :ref:`Variant` **get_selected_metadata** **(** **)** const +- :ref:`Variant` **get_selected_metadata** **(** **)** |const| Gets the metadata of the selected item. Metadata for items can be set using :ref:`set_item_metadata`. @@ -250,7 +250,7 @@ Gets the metadata of the selected item. Metadata for items can be set using :ref .. _class_OptionButton_method_is_item_disabled: -- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item at index ``idx`` is disabled. @@ -312,3 +312,6 @@ Sets the metadata of an item. Metadata may be of any type and can be used to sto Sets the text of the item at index ``idx``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_os.rst b/classes/class_os.rst index 634d0c5c4..305ccc298 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -69,17 +69,17 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_draw` **(** **)** const | +| :ref:`bool` | :ref:`can_draw` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_use_threads` **(** **)** const | +| :ref:`bool` | :ref:`can_use_threads` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`center_window` **(** **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close_midi_inputs` **(** **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | +| void | :ref:`delay_msec` **(** :ref:`int` msec **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | +| void | :ref:`delay_usec` **(** :ref:`int` usec **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -87,43 +87,43 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking=true, :ref:`Array` output=[ ], :ref:`bool` read_stderr=false **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | +| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_audio_driver_count` **(** **)** const | +| :ref:`int` | :ref:`get_audio_driver_count` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_audio_driver_name` **(** :ref:`int` driver **)** const | +| :ref:`String` | :ref:`get_audio_driver_name` **(** :ref:`int` driver **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_connected_midi_inputs` **(** **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VideoDriver` | :ref:`get_current_video_driver` **(** **)** const | +| :ref:`VideoDriver` | :ref:`get_current_video_driver` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | +| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | +| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | +| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | +| :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | +| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_executable_path` **(** **)** const | +| :ref:`String` | :ref:`get_executable_path` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_granted_permissions` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_granted_permissions` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_ime_selection` **(** **)** const | +| :ref:`Vector2` | :ref:`get_ime_selection` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_ime_text` **(** **)** const | +| :ref:`String` | :ref:`get_ime_text` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | +| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | +| :ref:`String` | :ref:`get_locale` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_model_name` **(** **)** const | +| :ref:`String` | :ref:`get_model_name` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | +| :ref:`String` | :ref:`get_name` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_power_percent_left` **(** **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -131,65 +131,65 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PowerState` | :ref:`get_power_state` **(** **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_id` **(** **)** const | +| :ref:`int` | :ref:`get_process_id` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_processor_count` **(** **)** const | +| :ref:`int` | :ref:`get_processor_count` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | +| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_count` **(** **)** const | +| :ref:`int` | :ref:`get_screen_count` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | +| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_screen_max_scale` **(** **)** const | +| :ref:`float` | :ref:`get_screen_max_scale` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | +| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_screen_scale` **(** :ref:`int` screen=-1 **)** const | +| :ref:`float` | :ref:`get_screen_scale` **(** :ref:`int` screen=-1 **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | +| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | +| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** const | +| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | +| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir **)** const | +| :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_system_time_msecs` **(** **)** const | +| :ref:`int` | :ref:`get_system_time_msecs` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | +| :ref:`int` | :ref:`get_system_time_secs` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tablet_driver_count` **(** **)** const | +| :ref:`int` | :ref:`get_tablet_driver_count` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tablet_driver_name` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_tablet_driver_name` **(** :ref:`int` idx **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | +| :ref:`int` | :ref:`get_ticks_msec` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_usec` **(** **)** const | +| :ref:`int` | :ref:`get_ticks_usec` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | +| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | +| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_unique_id` **(** **)** const | +| :ref:`String` | :ref:`get_unique_id` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time` **(** **)** const | +| :ref:`int` | :ref:`get_unix_time` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | +| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | +| :ref:`String` | :ref:`get_user_data_dir` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_video_driver_count` **(** **)** const | +| :ref:`int` | :ref:`get_video_driver_count` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`VideoDriver` driver **)** const | +| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`VideoDriver` driver **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** const | +| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_menu_add_item` **(** :ref:`String` menu, :ref:`String` label, :ref:`Variant` id, :ref:`Variant` meta **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -199,37 +199,37 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_menu_remove_item` **(** :ref:`String` menu, :ref:`int` idx **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | +| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | +| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | +| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | +| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hide_virtual_keyboard` **(** **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debug_build` **(** **)** const | +| :ref:`bool` | :ref:`is_debug_build` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** const | +| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scancode_unicode` **(** :ref:`int` code **)** const | +| :ref:`bool` | :ref:`is_scancode_unicode` **(** :ref:`int` code **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** const | +| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | +| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** const | +| :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_focused` **(** **)** const | +| :ref:`bool` | :ref:`is_window_focused` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`keyboard_get_current_layout` **(** **)** const | +| :ref:`int` | :ref:`keyboard_get_current_layout` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`keyboard_get_layout_count` **(** **)** const | +| :ref:`int` | :ref:`keyboard_get_layout_count` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`keyboard_get_layout_language` **(** :ref:`int` index **)** const | +| :ref:`String` | :ref:`keyboard_get_layout_language` **(** :ref:`int` index **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`keyboard_get_layout_name` **(** :ref:`int` index **)** const | +| :ref:`String` | :ref:`keyboard_get_layout_name` **(** :ref:`int` index **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`keyboard_set_current_layout` **(** :ref:`int` index **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -833,7 +833,7 @@ Displays a modal dialog box using the host OS' facilities. Execution is blocked .. _class_OS_method_can_draw: -- :ref:`bool` **can_draw** **(** **)** const +- :ref:`bool` **can_draw** **(** **)** |const| Returns ``true`` if the host OS allows drawing. @@ -841,7 +841,7 @@ Returns ``true`` if the host OS allows drawing. .. _class_OS_method_can_use_threads: -- :ref:`bool` **can_use_threads** **(** **)** const +- :ref:`bool` **can_use_threads** **(** **)** |const| Returns ``true`` if the current host platform is using multiple threads. @@ -867,7 +867,7 @@ Shuts down system MIDI driver. .. _class_OS_method_delay_msec: -- void **delay_msec** **(** :ref:`int` msec **)** const +- void **delay_msec** **(** :ref:`int` msec **)** |const| Delay execution of the current thread by ``msec`` milliseconds. @@ -875,7 +875,7 @@ Delay execution of the current thread by ``msec`` milliseconds. .. _class_OS_method_delay_usec: -- void **delay_usec** **(** :ref:`int` usec **)** const +- void **delay_usec** **(** :ref:`int` usec **)** |const| Delay execution of the current thread by ``usec`` microseconds. @@ -944,7 +944,7 @@ If you wish to access a shell built-in or perform a composite command, a platfor .. _class_OS_method_find_scancode_from_string: -- :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** const +- :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** |const| Returns the scancode of the given string (e.g. "Escape"). @@ -952,7 +952,7 @@ Returns the scancode of the given string (e.g. "Escape"). .. _class_OS_method_get_audio_driver_count: -- :ref:`int` **get_audio_driver_count** **(** **)** const +- :ref:`int` **get_audio_driver_count** **(** **)** |const| Returns the total number of available audio drivers. @@ -960,7 +960,7 @@ Returns the total number of available audio drivers. .. _class_OS_method_get_audio_driver_name: -- :ref:`String` **get_audio_driver_name** **(** :ref:`int` driver **)** const +- :ref:`String` **get_audio_driver_name** **(** :ref:`int` driver **)** |const| Returns the audio driver name for the given index. @@ -1004,7 +1004,7 @@ The returned array will be empty if the system MIDI driver has not previously be .. _class_OS_method_get_current_video_driver: -- :ref:`VideoDriver` **get_current_video_driver** **(** **)** const +- :ref:`VideoDriver` **get_current_video_driver** **(** **)** |const| Returns the currently used video driver, using one of the values from :ref:`VideoDriver`. @@ -1012,7 +1012,7 @@ Returns the currently used video driver, using one of the values from :ref:`Vide .. _class_OS_method_get_date: -- :ref:`Dictionary` **get_date** **(** :ref:`bool` utc=false **)** const +- :ref:`Dictionary` **get_date** **(** :ref:`bool` utc=false **)** |const| Returns current date as a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``dst`` (Daylight Savings Time). @@ -1020,7 +1020,7 @@ Returns current date as a dictionary of keys: ``year``, ``month``, ``day``, ``we .. _class_OS_method_get_datetime: -- :ref:`Dictionary` **get_datetime** **(** :ref:`bool` utc=false **)** const +- :ref:`Dictionary` **get_datetime** **(** :ref:`bool` utc=false **)** |const| Returns current datetime as a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``dst`` (Daylight Savings Time), ``hour``, ``minute``, ``second``. @@ -1028,7 +1028,7 @@ Returns current datetime as a dictionary of keys: ``year``, ``month``, ``day``, .. _class_OS_method_get_datetime_from_unix_time: -- :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** const +- :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** |const| Gets a dictionary of time values corresponding to the given UNIX epoch time (in seconds). @@ -1038,7 +1038,7 @@ The returned Dictionary's values will be the same as :ref:`get_datetime` **get_dynamic_memory_usage** **(** **)** const +- :ref:`int` **get_dynamic_memory_usage** **(** **)** |const| Returns the total amount of dynamic memory used (only works in debug). @@ -1046,7 +1046,7 @@ Returns the total amount of dynamic memory used (only works in debug). .. _class_OS_method_get_environment: -- :ref:`String` **get_environment** **(** :ref:`String` environment **)** const +- :ref:`String` **get_environment** **(** :ref:`String` environment **)** |const| Returns an environment variable. @@ -1054,7 +1054,7 @@ Returns an environment variable. .. _class_OS_method_get_executable_path: -- :ref:`String` **get_executable_path** **(** **)** const +- :ref:`String` **get_executable_path** **(** **)** |const| Returns the path to the current engine executable. @@ -1062,7 +1062,7 @@ Returns the path to the current engine executable. .. _class_OS_method_get_granted_permissions: -- :ref:`PoolStringArray` **get_granted_permissions** **(** **)** const +- :ref:`PoolStringArray` **get_granted_permissions** **(** **)** |const| With this function you can get the list of dangerous permissions that have been granted to the Android application. @@ -1072,7 +1072,7 @@ With this function you can get the list of dangerous permissions that have been .. _class_OS_method_get_ime_selection: -- :ref:`Vector2` **get_ime_selection** **(** **)** const +- :ref:`Vector2` **get_ime_selection** **(** **)** |const| Returns the IME cursor position (the currently-edited portion of the string) relative to the characters in the composition string. @@ -1084,7 +1084,7 @@ Returns the IME cursor position (the currently-edited portion of the string) rel .. _class_OS_method_get_ime_text: -- :ref:`String` **get_ime_text** **(** **)** const +- :ref:`String` **get_ime_text** **(** **)** |const| Returns the IME intermediate composition string. @@ -1096,7 +1096,7 @@ Returns the IME intermediate composition string. .. _class_OS_method_get_latin_keyboard_variant: -- :ref:`String` **get_latin_keyboard_variant** **(** **)** const +- :ref:`String` **get_latin_keyboard_variant** **(** **)** |const| Returns the current latin keyboard variant as a String. @@ -1108,7 +1108,7 @@ Possible return values are: ``"QWERTY"``, ``"AZERTY"``, ``"QZERTY"``, ``"DVORAK" .. _class_OS_method_get_locale: -- :ref:`String` **get_locale** **(** **)** const +- :ref:`String` **get_locale** **(** **)** |const| Returns the host OS locale. @@ -1116,7 +1116,7 @@ Returns the host OS locale. .. _class_OS_method_get_model_name: -- :ref:`String` **get_model_name** **(** **)** const +- :ref:`String` **get_model_name** **(** **)** |const| Returns the model name of the current device. @@ -1126,7 +1126,7 @@ Returns the model name of the current device. .. _class_OS_method_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** |const| Returns the name of the host OS. Possible values are: ``"Android"``, ``"iOS"``, ``"HTML5"``, ``"OSX"``, ``"Server"``, ``"Windows"``, ``"UWP"``, ``"X11"``. @@ -1164,7 +1164,7 @@ Returns the current state of the device regarding battery and power. See :ref:`P .. _class_OS_method_get_process_id: -- :ref:`int` **get_process_id** **(** **)** const +- :ref:`int` **get_process_id** **(** **)** |const| Returns the project's process ID. @@ -1174,7 +1174,7 @@ Returns the project's process ID. .. _class_OS_method_get_processor_count: -- :ref:`int` **get_processor_count** **(** **)** const +- :ref:`int` **get_processor_count** **(** **)** |const| Returns the number of threads available on the host machine. @@ -1182,7 +1182,7 @@ Returns the number of threads available on the host machine. .. _class_OS_method_get_real_window_size: -- :ref:`Vector2` **get_real_window_size** **(** **)** const +- :ref:`Vector2` **get_real_window_size** **(** **)** |const| Returns the window size including decorations like window borders. @@ -1190,7 +1190,7 @@ Returns the window size including decorations like window borders. .. _class_OS_method_get_scancode_string: -- :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** const +- :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** |const| Returns the given scancode as a string (e.g. Return values: ``"Escape"``, ``"Shift+Escape"``). @@ -1200,7 +1200,7 @@ See also :ref:`InputEventKey.scancode` an .. _class_OS_method_get_screen_count: -- :ref:`int` **get_screen_count** **(** **)** const +- :ref:`int` **get_screen_count** **(** **)** |const| Returns the number of displays attached to the host machine. @@ -1208,7 +1208,7 @@ Returns the number of displays attached to the host machine. .. _class_OS_method_get_screen_dpi: -- :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=-1 **)** const +- :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=-1 **)** |const| Returns the dots per inch density of the specified screen. If ``screen`` is ``-1`` (the default value), the current screen will be used. @@ -1229,7 +1229,7 @@ On Android devices, the actual screen densities are grouped into six generalized .. _class_OS_method_get_screen_max_scale: -- :ref:`float` **get_screen_max_scale** **(** **)** const +- :ref:`float` **get_screen_max_scale** **(** **)** |const| Return the greatest scale factor of all screens. @@ -1241,7 +1241,7 @@ Return the greatest scale factor of all screens. .. _class_OS_method_get_screen_position: -- :ref:`Vector2` **get_screen_position** **(** :ref:`int` screen=-1 **)** const +- :ref:`Vector2` **get_screen_position** **(** :ref:`int` screen=-1 **)** |const| Returns the position of the specified screen by index. If ``screen`` is ``-1`` (the default value), the current screen will be used. @@ -1249,7 +1249,7 @@ Returns the position of the specified screen by index. If ``screen`` is ``-1`` ( .. _class_OS_method_get_screen_scale: -- :ref:`float` **get_screen_scale** **(** :ref:`int` screen=-1 **)** const +- :ref:`float` **get_screen_scale** **(** :ref:`int` screen=-1 **)** |const| Return the scale factor of the specified screen by index. If ``screen`` is ``-1`` (the default value), the current screen will be used. @@ -1261,7 +1261,7 @@ Return the scale factor of the specified screen by index. If ``screen`` is ``-1` .. _class_OS_method_get_screen_size: -- :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** const +- :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** |const| Returns the dimensions in pixels of the specified screen. If ``screen`` is ``-1`` (the default value), the current screen will be used. @@ -1269,7 +1269,7 @@ Returns the dimensions in pixels of the specified screen. If ``screen`` is ``-1` .. _class_OS_method_get_splash_tick_msec: -- :ref:`int` **get_splash_tick_msec** **(** **)** const +- :ref:`int` **get_splash_tick_msec** **(** **)** |const| Returns the amount of time in milliseconds it took for the boot logo to appear. @@ -1277,7 +1277,7 @@ Returns the amount of time in milliseconds it took for the boot logo to appear. .. _class_OS_method_get_static_memory_peak_usage: -- :ref:`int` **get_static_memory_peak_usage** **(** **)** const +- :ref:`int` **get_static_memory_peak_usage** **(** **)** |const| Returns the maximum amount of static memory used (only works in debug). @@ -1285,7 +1285,7 @@ Returns the maximum amount of static memory used (only works in debug). .. _class_OS_method_get_static_memory_usage: -- :ref:`int` **get_static_memory_usage** **(** **)** const +- :ref:`int` **get_static_memory_usage** **(** **)** |const| Returns the amount of static memory being used by the program in bytes. @@ -1293,7 +1293,7 @@ Returns the amount of static memory being used by the program in bytes. .. _class_OS_method_get_system_dir: -- :ref:`String` **get_system_dir** **(** :ref:`SystemDir` dir **)** const +- :ref:`String` **get_system_dir** **(** :ref:`SystemDir` dir **)** |const| Returns the actual path to commonly used folders across different platforms. Available locations are specified in :ref:`SystemDir`. @@ -1303,7 +1303,7 @@ Returns the actual path to commonly used folders across different platforms. Ava .. _class_OS_method_get_system_time_msecs: -- :ref:`int` **get_system_time_msecs** **(** **)** const +- :ref:`int` **get_system_time_msecs** **(** **)** |const| Returns the epoch time of the operating system in milliseconds. @@ -1311,7 +1311,7 @@ Returns the epoch time of the operating system in milliseconds. .. _class_OS_method_get_system_time_secs: -- :ref:`int` **get_system_time_secs** **(** **)** const +- :ref:`int` **get_system_time_secs** **(** **)** |const| Returns the epoch time of the operating system in seconds. @@ -1319,7 +1319,7 @@ Returns the epoch time of the operating system in seconds. .. _class_OS_method_get_tablet_driver_count: -- :ref:`int` **get_tablet_driver_count** **(** **)** const +- :ref:`int` **get_tablet_driver_count** **(** **)** |const| Returns the total number of available tablet drivers. @@ -1329,7 +1329,7 @@ Returns the total number of available tablet drivers. .. _class_OS_method_get_tablet_driver_name: -- :ref:`String` **get_tablet_driver_name** **(** :ref:`int` idx **)** const +- :ref:`String` **get_tablet_driver_name** **(** :ref:`int` idx **)** |const| Returns the tablet driver name for the given index. @@ -1339,7 +1339,7 @@ Returns the tablet driver name for the given index. .. _class_OS_method_get_ticks_msec: -- :ref:`int` **get_ticks_msec** **(** **)** const +- :ref:`int` **get_ticks_msec** **(** **)** |const| Returns the amount of time passed in milliseconds since the engine started. @@ -1347,7 +1347,7 @@ Returns the amount of time passed in milliseconds since the engine started. .. _class_OS_method_get_ticks_usec: -- :ref:`int` **get_ticks_usec** **(** **)** const +- :ref:`int` **get_ticks_usec** **(** **)** |const| Returns the amount of time passed in microseconds since the engine started. @@ -1355,7 +1355,7 @@ Returns the amount of time passed in microseconds since the engine started. .. _class_OS_method_get_time: -- :ref:`Dictionary` **get_time** **(** :ref:`bool` utc=false **)** const +- :ref:`Dictionary` **get_time** **(** :ref:`bool` utc=false **)** |const| Returns current time as a dictionary of keys: hour, minute, second. @@ -1363,7 +1363,7 @@ Returns current time as a dictionary of keys: hour, minute, second. .. _class_OS_method_get_time_zone_info: -- :ref:`Dictionary` **get_time_zone_info** **(** **)** const +- :ref:`Dictionary` **get_time_zone_info** **(** **)** |const| Returns the current time zone as a dictionary with the keys: bias and name. @@ -1371,7 +1371,7 @@ Returns the current time zone as a dictionary with the keys: bias and name. .. _class_OS_method_get_unique_id: -- :ref:`String` **get_unique_id** **(** **)** const +- :ref:`String` **get_unique_id** **(** **)** |const| Returns a string that is unique to the device. @@ -1381,7 +1381,7 @@ Returns a string that is unique to the device. .. _class_OS_method_get_unix_time: -- :ref:`int` **get_unix_time** **(** **)** const +- :ref:`int` **get_unix_time** **(** **)** |const| Returns the current UNIX epoch timestamp. @@ -1389,7 +1389,7 @@ Returns the current UNIX epoch timestamp. .. _class_OS_method_get_unix_time_from_datetime: -- :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** const +- :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** |const| Gets an epoch time value from a dictionary of time values. @@ -1401,7 +1401,7 @@ You can pass the output from :ref:`get_datetime_from_unix_time` **get_user_data_dir** **(** **)** const +- :ref:`String` **get_user_data_dir** **(** **)** |const| Returns the absolute directory path where user data is written (``user://``). @@ -1417,7 +1417,7 @@ If the project name is empty, ``user://`` falls back to ``res://``. .. _class_OS_method_get_video_driver_count: -- :ref:`int` **get_video_driver_count** **(** **)** const +- :ref:`int` **get_video_driver_count** **(** **)** |const| Returns the number of video drivers supported on the current platform. @@ -1425,7 +1425,7 @@ Returns the number of video drivers supported on the current platform. .. _class_OS_method_get_video_driver_name: -- :ref:`String` **get_video_driver_name** **(** :ref:`VideoDriver` driver **)** const +- :ref:`String` **get_video_driver_name** **(** :ref:`VideoDriver` driver **)** |const| Returns the name of the video driver matching the given ``driver`` index. This index is a value from :ref:`VideoDriver`, and you can use :ref:`get_current_video_driver` to get the current backend's index. @@ -1441,7 +1441,7 @@ Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyb .. _class_OS_method_get_window_safe_area: -- :ref:`Rect2` **get_window_safe_area** **(** **)** const +- :ref:`Rect2` **get_window_safe_area** **(** **)** |const| Returns unobscured area of the window where interactive controls should be rendered. @@ -1489,7 +1489,7 @@ Removes the item at index "idx" from the global menu. Note that the indexes of i .. _class_OS_method_has_environment: -- :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const +- :ref:`bool` **has_environment** **(** :ref:`String` environment **)** |const| Returns ``true`` if an environment variable exists. @@ -1497,7 +1497,7 @@ Returns ``true`` if an environment variable exists. .. _class_OS_method_has_feature: -- :ref:`bool` **has_feature** **(** :ref:`String` tag_name **)** const +- :ref:`bool` **has_feature** **(** :ref:`String` tag_name **)** |const| Returns ``true`` if the feature for the given feature tag is supported in the currently running instance, depending on platform, build etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the `Feature Tags `_ documentation for more details. @@ -1507,7 +1507,7 @@ Returns ``true`` if the feature for the given feature tag is supported in the cu .. _class_OS_method_has_touchscreen_ui_hint: -- :ref:`bool` **has_touchscreen_ui_hint** **(** **)** const +- :ref:`bool` **has_touchscreen_ui_hint** **(** **)** |const| Returns ``true`` if the device has a touchscreen or emulates one. @@ -1515,7 +1515,7 @@ Returns ``true`` if the device has a touchscreen or emulates one. .. _class_OS_method_has_virtual_keyboard: -- :ref:`bool` **has_virtual_keyboard** **(** **)** const +- :ref:`bool` **has_virtual_keyboard** **(** **)** |const| Returns ``true`` if the platform has a virtual keyboard, ``false`` otherwise. @@ -1531,7 +1531,7 @@ Hides the virtual keyboard if it is shown, does nothing otherwise. .. _class_OS_method_is_debug_build: -- :ref:`bool` **is_debug_build** **(** **)** const +- :ref:`bool` **is_debug_build** **(** **)** |const| Returns ``true`` if the Godot binary used to run the project is a *debug* export template, or when running in the editor. @@ -1543,7 +1543,7 @@ To check whether the Godot binary used to run the project is an export template .. _class_OS_method_is_ok_left_and_cancel_right: -- :ref:`bool` **is_ok_left_and_cancel_right** **(** **)** const +- :ref:`bool` **is_ok_left_and_cancel_right** **(** **)** |const| Returns ``true`` if the **OK** button should appear on the left and **Cancel** on the right. @@ -1551,7 +1551,7 @@ Returns ``true`` if the **OK** button should appear on the left and **Cancel** o .. _class_OS_method_is_scancode_unicode: -- :ref:`bool` **is_scancode_unicode** **(** :ref:`int` code **)** const +- :ref:`bool` **is_scancode_unicode** **(** :ref:`int` code **)** |const| Returns ``true`` if the input scancode corresponds to a Unicode character. @@ -1559,7 +1559,7 @@ Returns ``true`` if the input scancode corresponds to a Unicode character. .. _class_OS_method_is_stdout_verbose: -- :ref:`bool` **is_stdout_verbose** **(** **)** const +- :ref:`bool` **is_stdout_verbose** **(** **)** |const| Returns ``true`` if the engine was executed with ``-v`` (verbose stdout). @@ -1567,7 +1567,7 @@ Returns ``true`` if the engine was executed with ``-v`` (verbose stdout). .. _class_OS_method_is_userfs_persistent: -- :ref:`bool` **is_userfs_persistent** **(** **)** const +- :ref:`bool` **is_userfs_persistent** **(** **)** |const| If ``true``, the ``user://`` file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable. @@ -1575,7 +1575,7 @@ If ``true``, the ``user://`` file system is persistent, so that its state is the .. _class_OS_method_is_window_always_on_top: -- :ref:`bool` **is_window_always_on_top** **(** **)** const +- :ref:`bool` **is_window_always_on_top** **(** **)** |const| Returns ``true`` if the window should always be on top of other windows. @@ -1583,7 +1583,7 @@ Returns ``true`` if the window should always be on top of other windows. .. _class_OS_method_is_window_focused: -- :ref:`bool` **is_window_focused** **(** **)** const +- :ref:`bool` **is_window_focused** **(** **)** |const| Returns ``true`` if the window is currently focused. @@ -1593,7 +1593,7 @@ Returns ``true`` if the window is currently focused. .. _class_OS_method_keyboard_get_current_layout: -- :ref:`int` **keyboard_get_current_layout** **(** **)** const +- :ref:`int` **keyboard_get_current_layout** **(** **)** |const| Returns active keyboard layout index. @@ -1603,7 +1603,7 @@ Returns active keyboard layout index. .. _class_OS_method_keyboard_get_layout_count: -- :ref:`int` **keyboard_get_layout_count** **(** **)** const +- :ref:`int` **keyboard_get_layout_count** **(** **)** |const| Returns the number of keyboard layouts. @@ -1613,7 +1613,7 @@ Returns the number of keyboard layouts. .. _class_OS_method_keyboard_get_layout_language: -- :ref:`String` **keyboard_get_layout_language** **(** :ref:`int` index **)** const +- :ref:`String` **keyboard_get_layout_language** **(** :ref:`int` index **)** |const| Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``. @@ -1623,7 +1623,7 @@ Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``in .. _class_OS_method_keyboard_get_layout_name: -- :ref:`String` **keyboard_get_layout_name** **(** :ref:`int` index **)** const +- :ref:`String` **keyboard_get_layout_name** **(** :ref:`int` index **)** |const| Returns the localized name of the keyboard layout at position ``index``. @@ -1901,3 +1901,6 @@ The ``multiline`` parameter needs to be set to ``true`` to be able to enter mult **Note:** This method is implemented on Android, iOS and UWP. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 692d1c884..4729b14b1 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -26,7 +26,7 @@ Methods +---------------------------------------+----------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`pack` **(** :ref:`Variant` value **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** const | +| :ref:`int` | :ref:`size` **(** **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------+ Property Descriptions @@ -51,5 +51,8 @@ Method Descriptions .. _class_PackedDataContainer_method_size: -- :ref:`int` **size** **(** **)** const +- :ref:`int` **size** **(** **)** |const| +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index e8c57a892..7f4d202e1 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -16,14 +16,17 @@ Reference version of :ref:`PackedDataContainer`. Methods ------- -+-----------------------+-------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** const | -+-----------------------+-------------------------------------------------------------------------+ ++-----------------------+---------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** |const| | ++-----------------------+---------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_PackedDataContainerRef_method_size: -- :ref:`int` **size** **(** **)** const +- :ref:`int` **size** **(** **)** |const| +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index db378faaa..0ac670d2b 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -65,15 +65,15 @@ Properties Methods ------- -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneState` | :ref:`get_state` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`instance` **(** :ref:`GenEditState` edit_state=0 **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`pack` **(** :ref:`Node` path **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneState` | :ref:`get_state` **(** **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`instance` **(** :ref:`GenEditState` edit_state=0 **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`pack` **(** :ref:`Node` path **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -118,7 +118,7 @@ Method Descriptions .. _class_PackedScene_method_can_instance: -- :ref:`bool` **can_instance** **(** **)** const +- :ref:`bool` **can_instance** **(** **)** |const| Returns ``true`` if the scene file has nodes. @@ -134,7 +134,7 @@ Returns the ``SceneState`` representing the scene file contents. .. _class_PackedScene_method_instance: -- :ref:`Node` **instance** **(** :ref:`GenEditState` edit_state=0 **)** const +- :ref:`Node` **instance** **(** :ref:`GenEditState` edit_state=0 **)** |const| Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers a :ref:`Node.NOTIFICATION_INSTANCED` notification on the root node. @@ -146,3 +146,6 @@ Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.owner`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index e71aba58e..9ef92bb0c 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -33,11 +33,11 @@ Methods ------- +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | +| :ref:`int` | :ref:`get_available_packet_count` **(** **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_packet_error` **(** **)** const | +| :ref:`Error` | :ref:`get_packet_error` **(** **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -90,7 +90,7 @@ Method Descriptions .. _class_PacketPeer_method_get_available_packet_count: -- :ref:`int` **get_available_packet_count** **(** **)** const +- :ref:`int` **get_available_packet_count** **(** **)** |const| Returns the number of packets currently available in the ring-buffer. @@ -106,7 +106,7 @@ Gets a raw packet. .. _class_PacketPeer_method_get_packet_error: -- :ref:`Error` **get_packet_error** **(** **)** const +- :ref:`Error` **get_packet_error** **(** **)** |const| Returns the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). @@ -136,3 +136,6 @@ Sends a raw packet. Sends a :ref:`Variant` as a packet. If ``full_objects`` (or :ref:`allow_object_decoding`) is ``true``, encoding objects is allowed (and can potentially include code). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_packetpeerdtls.rst b/classes/class_packetpeerdtls.rst index 666893255..a6d8cd716 100644 --- a/classes/class_packetpeerdtls.rst +++ b/classes/class_packetpeerdtls.rst @@ -26,7 +26,7 @@ Methods +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_from_peer` **(** **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** const | +| :ref:`Status` | :ref:`get_status` **(** **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`poll` **(** **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -79,7 +79,7 @@ Disconnects this peer, terminating the DTLS session. .. _class_PacketPeerDTLS_method_get_status: -- :ref:`Status` **get_status** **(** **)** const +- :ref:`Status` **get_status** **(** **)** |const| Returns the status of the connection. See :ref:`Status` for values. @@ -91,3 +91,6 @@ Returns the status of the connection. See :ref:`Status` object. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index de80a6827..d1136d72a 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -26,13 +26,13 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | +| :ref:`String` | :ref:`get_packet_ip` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_port` **(** **)** const | +| :ref:`int` | :ref:`get_packet_port` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | +| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | +| :ref:`bool` | :ref:`is_listening` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`join_multicast_group` **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -70,7 +70,7 @@ Note: Connecting to the remote peer does not help to protect from malicious atta .. _class_PacketPeerUDP_method_get_packet_ip: -- :ref:`String` **get_packet_ip** **(** **)** const +- :ref:`String` **get_packet_ip** **(** **)** |const| Returns the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). @@ -78,7 +78,7 @@ Returns the IP of the remote peer that sent the last packet(that was received wi .. _class_PacketPeerUDP_method_get_packet_port: -- :ref:`int` **get_packet_port** **(** **)** const +- :ref:`int` **get_packet_port** **(** **)** |const| Returns the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). @@ -86,7 +86,7 @@ Returns the port of the remote peer that sent the last packet(that was received .. _class_PacketPeerUDP_method_is_connected_to_host: -- :ref:`bool` **is_connected_to_host** **(** **)** const +- :ref:`bool` **is_connected_to_host** **(** **)** |const| Returns ``true`` if the UDP socket is open and has been connected to a remote address. See :ref:`connect_to_host`. @@ -94,7 +94,7 @@ Returns ``true`` if the UDP socket is open and has been connected to a remote ad .. _class_PacketPeerUDP_method_is_listening: -- :ref:`bool` **is_listening** **(** **)** const +- :ref:`bool` **is_listening** **(** **)** |const| Returns whether this ``PacketPeerUDP`` is listening. @@ -160,3 +160,6 @@ Note: :ref:`set_broadcast_enabled`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_panel.rst b/classes/class_panel.rst index fbfea1c33..7102b7e87 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -25,3 +25,6 @@ Theme Properties | :ref:`StyleBox` | panel | +---------------------------------+-------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index f005517b6..4dcd081b7 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -27,3 +27,6 @@ Theme Properties | :ref:`StyleBox` | panel | +---------------------------------+-------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index d85fff1bb..ccbf0ab0a 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -44,3 +44,6 @@ Property Descriptions :ref:`Texture` to be applied to the PanoramaSky. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index a6fa6a147..31c98ed17 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -134,3 +134,6 @@ Bottom-right limits for scrolling to end. If the camera is outside of this limit The ParallaxBackground's scroll value. Calculated automatically when using a :ref:`Camera2D`, but can be used to manually manage scrolling when no camera is present. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 002b051fa..757aa948c 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -82,3 +82,6 @@ The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`Par Multiplies the ParallaxLayer's motion. If an axis is set to ``0``, it will not scroll. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 72d553dab..0f3742c17 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -72,9 +72,9 @@ Methods ------- +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`capture_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`capture_aabb` **(** **)** |const| | +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_draw_pass_mesh` **(** :ref:`int` pass **)** const | +| :ref:`Mesh` | :ref:`get_draw_pass_mesh` **(** :ref:`int` pass **)** |const| | +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`restart` **(** **)** | +-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -409,7 +409,7 @@ Method Descriptions .. _class_Particles_method_capture_aabb: -- :ref:`AABB` **capture_aabb** **(** **)** const +- :ref:`AABB` **capture_aabb** **(** **)** |const| Returns the axis-aligned bounding box that contains all the particles that are active in the current frame. @@ -417,7 +417,7 @@ Returns the axis-aligned bounding box that contains all the particles that are a .. _class_Particles_method_get_draw_pass_mesh: -- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** const +- :ref:`Mesh` **get_draw_pass_mesh** **(** :ref:`int` pass **)** |const| Returns the :ref:`Mesh` that is drawn at index ``pass``. @@ -437,3 +437,6 @@ Restarts the particle emission, clearing existing particles. Sets the :ref:`Mesh` that is drawn at index ``pass``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 86851b8e9..afb3fdb85 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -65,11 +65,11 @@ Properties Methods ------- -+---------------------------+------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | -+---------------------------+------------------------------------------------------------------------------+ -| void | :ref:`restart` **(** **)** | -+---------------------------+------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`capture_rect` **(** **)** |const| | ++---------------------------+--------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------+ Enumerations ------------ @@ -344,7 +344,7 @@ Method Descriptions .. _class_Particles2D_method_capture_rect: -- :ref:`Rect2` **capture_rect** **(** **)** const +- :ref:`Rect2` **capture_rect** **(** **)** |const| Returns a rectangle containing the positions of all existing particles. @@ -356,3 +356,6 @@ Returns a rectangle containing the positions of all existing particles. Restarts all the existing particles. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index cf5f84469..47ca11802 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -141,13 +141,13 @@ Methods ------- +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** const | +| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`Parameter` param **)** const | +| :ref:`float` | :ref:`get_param` **(** :ref:`Parameter` param **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`Parameter` param **)** const | +| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`Parameter` param **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_param_texture` **(** :ref:`Parameter` param **)** const | +| :ref:`Texture` | :ref:`get_param_texture` **(** :ref:`Parameter` param **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag` **(** :ref:`Flags` flag, :ref:`bool` enable **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1117,7 +1117,7 @@ Method Descriptions .. _class_ParticlesMaterial_method_get_flag: -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** const +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| Returns ``true`` if the specified flag is enabled. @@ -1125,7 +1125,7 @@ Returns ``true`` if the specified flag is enabled. .. _class_ParticlesMaterial_method_get_param: -- :ref:`float` **get_param** **(** :ref:`Parameter` param **)** const +- :ref:`float` **get_param** **(** :ref:`Parameter` param **)** |const| Returns the value of the specified parameter. @@ -1133,7 +1133,7 @@ Returns the value of the specified parameter. .. _class_ParticlesMaterial_method_get_param_randomness: -- :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** const +- :ref:`float` **get_param_randomness** **(** :ref:`Parameter` param **)** |const| Returns the randomness ratio associated with the specified parameter. @@ -1141,7 +1141,7 @@ Returns the randomness ratio associated with the specified parameter. .. _class_ParticlesMaterial_method_get_param_texture: -- :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** const +- :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** |const| Returns the :ref:`Texture` used by the specified parameter. @@ -1177,3 +1177,6 @@ Sets the randomness ratio for the specified :ref:`Parameter` for the specified :ref:`Parameter`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_path.rst b/classes/class_path.rst index da852d03a..e17e2e95a 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -51,3 +51,6 @@ Property Descriptions A :ref:`Curve3D` describing the path. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 3e0387fca..295166c6e 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -44,3 +44,6 @@ Property Descriptions A :ref:`Curve2D` describing the path. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index 6cfc9d345..c01171959 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -183,3 +183,6 @@ The distance from the first vertex, considering 0.0 as the first vertex and 1.0 The node's offset perpendicular to the curve. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index adc1e2bc6..9a41e8cb1 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -174,3 +174,6 @@ The distance along the path as a number in the range 0.0 (for the first vertex) The node's offset perpendicular to the curve. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 596ce6907..d3ea21c80 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -63,3 +63,6 @@ Writes the files specified using all :ref:`add_file` | :ref:`get_monitor` **(** :ref:`Monitor` monitor **)** const | -+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_monitor` **(** :ref:`Monitor` monitor **)** |const| | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -169,7 +169,7 @@ Method Descriptions .. _class_Performance_method_get_monitor: -- :ref:`float` **get_monitor** **(** :ref:`Monitor` monitor **)** const +- :ref:`float` **get_monitor** **(** :ref:`Monitor` monitor **)** |const| Returns the value of one of the available monitors. You should provide one of the :ref:`Monitor` constants as the argument, like this: @@ -177,3 +177,6 @@ Returns the value of one of the available monitors. You should provide one of th print(Performance.get_monitor(Performance.TIME_FPS)) # Prints the FPS to the console +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index 1cbc6827c..215e695d4 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -34,3 +34,6 @@ Method Descriptions Generates and sets an optimized translation from the given :ref:`Translation` resource. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index f5cc8ccc1..8e240eae2 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -42,7 +42,7 @@ Methods +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_id` **(** **)** const | +| :ref:`int` | :ref:`get_bone_id` **(** **)** |const| | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_simulate_physics` **(** **)** | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -212,7 +212,7 @@ Method Descriptions .. _class_PhysicalBone_method_get_bone_id: -- :ref:`int` **get_bone_id** **(** **)** const +- :ref:`int` **get_bone_id** **(** **)** |const| ---- @@ -232,3 +232,6 @@ Method Descriptions - :ref:`bool` **is_static_body** **(** **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 12433e165..975ac7573 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -51,45 +51,45 @@ Properties Methods ------- -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_central_force` **(** :ref:`Vector2` force **)** | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_torque` **(** :ref:`float` torque **)** | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_torque_impulse` **(** :ref:`float` impulse **)** | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_contact_collider_shape_metadata` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_count` **(** **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`get_space_state` **(** **)** | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`integrate_forces` **(** **)** | -+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_central_force` **(** :ref:`Vector2` force **)** | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_torque` **(** :ref:`float` torque **)** | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_torque_impulse` **(** :ref:`float` impulse **)** | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_contact_collider_shape_metadata` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_count` **(** **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** |const| | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`get_space_state` **(** **)** | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`integrate_forces` **(** **)** | ++-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -273,7 +273,7 @@ Applies a rotational impulse to the body. .. _class_Physics2DDirectBodyState_method_get_contact_collider: -- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const +- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** |const| Returns the collider's :ref:`RID`. @@ -281,7 +281,7 @@ Returns the collider's :ref:`RID`. .. _class_Physics2DDirectBodyState_method_get_contact_collider_id: -- :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** |const| Returns the collider's object id. @@ -289,7 +289,7 @@ Returns the collider's object id. .. _class_Physics2DDirectBodyState_method_get_contact_collider_object: -- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const +- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** |const| Returns the collider object. This depends on how it was created (will return a scene node if such was used to create it). @@ -297,7 +297,7 @@ Returns the collider object. This depends on how it was created (will return a s .. _class_Physics2DDirectBodyState_method_get_contact_collider_position: -- :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** |const| Returns the contact position in the collider. @@ -305,7 +305,7 @@ Returns the contact position in the collider. .. _class_Physics2DDirectBodyState_method_get_contact_collider_shape: -- :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |const| Returns the collider's shape index. @@ -313,7 +313,7 @@ Returns the collider's shape index. .. _class_Physics2DDirectBodyState_method_get_contact_collider_shape_metadata: -- :ref:`Variant` **get_contact_collider_shape_metadata** **(** :ref:`int` contact_idx **)** const +- :ref:`Variant` **get_contact_collider_shape_metadata** **(** :ref:`int` contact_idx **)** |const| Returns the collided shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. @@ -321,7 +321,7 @@ Returns the collided shape's metadata. This metadata is different from :ref:`Obj .. _class_Physics2DDirectBodyState_method_get_contact_collider_velocity_at_position: -- :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| Returns the linear velocity vector at the collider's contact point. @@ -329,7 +329,7 @@ Returns the linear velocity vector at the collider's contact point. .. _class_Physics2DDirectBodyState_method_get_contact_count: -- :ref:`int` **get_contact_count** **(** **)** const +- :ref:`int` **get_contact_count** **(** **)** |const| Returns the number of contacts this body has with other bodies. @@ -339,7 +339,7 @@ Returns the number of contacts this body has with other bodies. .. _class_Physics2DDirectBodyState_method_get_contact_local_normal: -- :ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** |const| Returns the local normal at the contact point. @@ -347,7 +347,7 @@ Returns the local normal at the contact point. .. _class_Physics2DDirectBodyState_method_get_contact_local_position: -- :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** |const| Returns the local position of the contact point. @@ -355,7 +355,7 @@ Returns the local position of the contact point. .. _class_Physics2DDirectBodyState_method_get_contact_local_shape: -- :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** |const| Returns the local shape index of the collision. @@ -375,3 +375,6 @@ Returns the current state of the space, useful for queries. Calls the built-in force integration code. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index b5988d175..8a80fa6e2 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -159,3 +159,6 @@ Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryPa The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index acf4f509e..ca365e4da 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -32,23 +32,23 @@ Methods +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`area_create` **(** **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_canvas_instance_id` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_canvas_instance_id` **(** :ref:`RID` area **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const | +| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +| :ref:`Transform2D` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | +| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | +| :ref:`Transform2D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -100,37 +100,37 @@ Methods +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`body_create` **(** **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_canvas_instance_id` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_canvas_instance_id` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CCDMode` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | +| :ref:`CCDMode` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Physics2DDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | +| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const | +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`Variant` | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`Transform2D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** const | +| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -180,7 +180,7 @@ Methods +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** const | +| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`DampedStringParam` param, :ref:`float` value **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -190,9 +190,9 @@ Methods +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`JointParam` param **)** const | +| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`JointParam` param **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | +| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -208,9 +208,9 @@ Methods +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` active **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | +| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -218,9 +218,9 @@ Methods +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** |const| | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -605,13 +605,13 @@ Creates an :ref:`Area2D`. .. _class_Physics2DServer_method_area_get_canvas_instance_id: -- :ref:`int` **area_get_canvas_instance_id** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_canvas_instance_id** **(** :ref:`RID` area **)** |const| ---- .. _class_Physics2DServer_method_area_get_object_instance_id: -- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** |const| Gets the instance ID of the object the area is assigned to. @@ -619,7 +619,7 @@ Gets the instance ID of the object the area is assigned to. .. _class_Physics2DServer_method_area_get_param: -- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const +- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |const| Returns an area parameter value. See :ref:`AreaParameter` for a list of available parameters. @@ -627,7 +627,7 @@ Returns an area parameter value. See :ref:`AreaParameter` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| Returns the :ref:`RID` of the nth shape of an area. @@ -635,7 +635,7 @@ Returns the :ref:`RID` of the nth shape of an area. .. _class_Physics2DServer_method_area_get_shape_count: -- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** |const| Returns the number of shapes assigned to an area. @@ -643,7 +643,7 @@ Returns the number of shapes assigned to an area. .. _class_Physics2DServer_method_area_get_shape_transform: -- :ref:`Transform2D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`Transform2D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| Returns the transform matrix of a shape within an area. @@ -651,7 +651,7 @@ Returns the transform matrix of a shape within an area. .. _class_Physics2DServer_method_area_get_space: -- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const +- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** |const| Returns the space assigned to the area. @@ -659,7 +659,7 @@ Returns the space assigned to the area. .. _class_Physics2DServer_method_area_get_space_override_mode: -- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const +- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** |const| Returns the space override mode for the area. @@ -667,7 +667,7 @@ Returns the space override mode for the area. .. _class_Physics2DServer_method_area_get_transform: -- :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** const +- :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** |const| Returns the transform matrix for an area. @@ -871,13 +871,13 @@ Creates a physics body. .. _class_Physics2DServer_method_body_get_canvas_instance_id: -- :ref:`int` **body_get_canvas_instance_id** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_canvas_instance_id** **(** :ref:`RID` body **)** |const| ---- .. _class_Physics2DServer_method_body_get_collision_layer: -- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** |const| Returns the physics layer or layers a body belongs to. @@ -885,7 +885,7 @@ Returns the physics layer or layers a body belongs to. .. _class_Physics2DServer_method_body_get_collision_mask: -- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** |const| Returns the physics layer or layers a body can collide with. @@ -893,7 +893,7 @@ Returns the physics layer or layers a body can collide with. .. _class_Physics2DServer_method_body_get_continuous_collision_detection_mode: -- :ref:`CCDMode` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** const +- :ref:`CCDMode` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** |const| Returns the continuous collision detection mode. @@ -909,7 +909,7 @@ Returns the :ref:`Physics2DDirectBodyState` of t .. _class_Physics2DServer_method_body_get_max_contacts_reported: -- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** |const| Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. @@ -917,7 +917,7 @@ Returns the maximum contacts that can be reported. See :ref:`body_set_max_contac .. _class_Physics2DServer_method_body_get_mode: -- :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const +- :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** |const| Returns the body mode. @@ -925,7 +925,7 @@ Returns the body mode. .. _class_Physics2DServer_method_body_get_object_instance_id: -- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** |const| Gets the instance ID of the object the area is assigned to. @@ -933,7 +933,7 @@ Gets the instance ID of the object the area is assigned to. .. _class_Physics2DServer_method_body_get_param: -- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const +- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |const| Returns the value of a body parameter. See :ref:`BodyParameter` for a list of available parameters. @@ -941,7 +941,7 @@ Returns the value of a body parameter. See :ref:`BodyParameter` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| Returns the :ref:`RID` of the nth shape of a body. @@ -949,7 +949,7 @@ Returns the :ref:`RID` of the nth shape of a body. .. _class_Physics2DServer_method_body_get_shape_count: -- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** |const| Returns the number of shapes assigned to a body. @@ -957,7 +957,7 @@ Returns the number of shapes assigned to a body. .. _class_Physics2DServer_method_body_get_shape_metadata: -- :ref:`Variant` **body_get_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Variant` **body_get_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| Returns the metadata of a shape of a body. @@ -965,7 +965,7 @@ Returns the metadata of a shape of a body. .. _class_Physics2DServer_method_body_get_shape_transform: -- :ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| Returns the transform matrix of a body shape. @@ -973,7 +973,7 @@ Returns the transform matrix of a body shape. .. _class_Physics2DServer_method_body_get_space: -- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const +- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** |const| Returns the :ref:`RID` of the space assigned to a body. @@ -981,7 +981,7 @@ Returns the :ref:`RID` of the space assigned to a body. .. _class_Physics2DServer_method_body_get_state: -- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const +- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| Returns a body state. @@ -989,7 +989,7 @@ Returns a body state. .. _class_Physics2DServer_method_body_is_omitting_force_integration: -- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** |const| Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). @@ -1139,6 +1139,8 @@ Assigns a space to the body (see :ref:`space_create` constants. +Note that the method doesn't take effect immediately. The state will change on the next physics frame. + ---- .. _class_Physics2DServer_method_body_test_motion: @@ -1183,7 +1185,7 @@ Creates a damped spring joint between two bodies. If not specified, the second b .. _class_Physics2DServer_method_damped_string_joint_get_param: -- :ref:`float` **damped_string_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** const +- :ref:`float` **damped_string_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** |const| Returns the value of a damped spring joint parameter. @@ -1223,7 +1225,7 @@ Creates a groove joint between two bodies. If not specified, the bodies are assu .. _class_Physics2DServer_method_joint_get_param: -- :ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** const +- :ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** |const| Returns the value of a joint parameter. @@ -1231,7 +1233,7 @@ Returns the value of a joint parameter. .. _class_Physics2DServer_method_joint_get_type: -- :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const +- :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** |const| Returns a joint's type (see :ref:`JointType`). @@ -1287,7 +1289,7 @@ Activates or deactivates the 2D physics engine. .. _class_Physics2DServer_method_shape_get_data: -- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const +- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** |const| Returns the shape data. @@ -1295,7 +1297,7 @@ Returns the shape data. .. _class_Physics2DServer_method_shape_get_type: -- :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const +- :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** |const| Returns a shape's type (see :ref:`ShapeType`). @@ -1327,7 +1329,7 @@ Returns the state of a space, a :ref:`Physics2DDirectSpaceState` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const +- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |const| Returns the value of a space parameter. @@ -1335,7 +1337,7 @@ Returns the value of a space parameter. .. _class_Physics2DServer_method_space_is_active: -- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const +- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** |const| Returns whether the space is active. @@ -1355,3 +1357,6 @@ Marks a space as active. It will not have an effect, unless it is assigned to an Sets the value for a space parameter. See :ref:`SpaceParameter` for a list of available parameters. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 83210278f..7168a4c34 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -93,7 +93,7 @@ If ``true``, the query will take :ref:`PhysicsBody2D`\ s in | *Getter* | get_collision_layer() | +-----------+----------------------------+ -The physics layer(s) the query will take into account (as a bitmask). +The physics layer(s) the query will take into account (as a bitmask). See `Collision layers and masks `_ in the documentation for more information. ---- @@ -182,3 +182,6 @@ Method Descriptions Sets the :ref:`Shape2D` that will be used for collision/intersection queries. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index 174db6eef..49b5960a6 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -21,24 +21,24 @@ The result of a 2D shape query in :ref:`Physics2DServer`. Methods ------- -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_count` **(** **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_count` **(** **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_Physics2DShapeQueryResult_method_get_result_count: -- :ref:`int` **get_result_count** **(** **)** const +- :ref:`int` **get_result_count** **(** **)** |const| Returns the number of objects that intersected with the shape. @@ -46,7 +46,7 @@ Returns the number of objects that intersected with the shape. .. _class_Physics2DShapeQueryResult_method_get_result_object: -- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const +- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** |const| Returns the :ref:`Object` that intersected with the shape at index ``idx``. @@ -54,7 +54,7 @@ Returns the :ref:`Object` that intersected with the shape at index .. _class_Physics2DShapeQueryResult_method_get_result_object_id: -- :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const +- :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** |const| Returns the instance ID of the :ref:`Object` that intersected with the shape at index ``idx``. @@ -62,7 +62,7 @@ Returns the instance ID of the :ref:`Object` that intersected with .. _class_Physics2DShapeQueryResult_method_get_result_object_shape: -- :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const +- :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** |const| Returns the child index of the object's :ref:`Shape` that intersected with the shape at index ``idx``. @@ -70,7 +70,10 @@ Returns the child index of the object's :ref:`Shape` that intersect .. _class_Physics2DShapeQueryResult_method_get_result_rid: -- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const +- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** |const| Returns the :ref:`RID` of the object that intersected with the shape at index ``idx``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index 1ebf14e4f..7e47a1005 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -141,3 +141,6 @@ Property Descriptions | *Getter* | get_motion_remainder() | +-----------+------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 0422677a2..c846c5a17 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -42,9 +42,9 @@ Methods +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the :ref:`collision_mask` property. -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. +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. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -88,7 +88,7 @@ A contact is detected if object A is in any of the layers that object B scans, o | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The physics layers this area scans for collisions. +The physics layers this area scans for collisions. See `Collision layers and masks `_ in the documentation for more information. Method Descriptions ------------------- @@ -111,7 +111,7 @@ Returns an array of nodes that were added as collision exceptions for this body. .. _class_PhysicsBody_method_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the :ref:`collision_layer`. @@ -119,7 +119,7 @@ Returns an individual bit on the :ref:`collision_layer` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the :ref:`collision_mask`. @@ -147,3 +147,6 @@ Sets individual bits on the :ref:`collision_layer` bitmask. Use this if you only need to change one layer's value. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 9126a5473..1622af8f2 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -46,9 +46,9 @@ Methods +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -76,7 +76,7 @@ The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the :ref:`collision_mask` property. -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. +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. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -92,7 +92,7 @@ A contact is detected if object A is in any of the layers that object B scans, o | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The physics layers this area scans for collisions. +The physics layers this area scans for collisions. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -123,7 +123,7 @@ Returns an array of nodes that were added as collision exceptions for this body. .. _class_PhysicsBody2D_method_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the :ref:`collision_layer`. @@ -131,7 +131,7 @@ Returns an individual bit on the :ref:`collision_layer` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the :ref:`collision_mask`. @@ -159,3 +159,6 @@ Sets individual bits on the :ref:`collision_layer` bitmask. Use this if you only need to change one layer's value. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index ccf431a1e..948d6903e 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -50,45 +50,45 @@ Properties Methods ------- -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_central_force` **(** :ref:`Vector3` force **)** | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` j **)** | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` j **)** | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` j **)** | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_count` **(** **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_contact_impulse` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`integrate_forces` **(** **)** | -+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_central_force` **(** :ref:`Vector3` force **)** | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` j **)** | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` j **)** | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` j **)** | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_count` **(** **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_contact_impulse` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** |const| | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`integrate_forces` **(** **)** | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -296,7 +296,7 @@ Apply a torque impulse (which will be affected by the body mass and shape). This .. _class_PhysicsDirectBodyState_method_get_contact_collider: -- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const +- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** |const| Returns the collider's :ref:`RID`. @@ -304,7 +304,7 @@ Returns the collider's :ref:`RID`. .. _class_PhysicsDirectBodyState_method_get_contact_collider_id: -- :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** |const| Returns the collider's object id. @@ -312,7 +312,7 @@ Returns the collider's object id. .. _class_PhysicsDirectBodyState_method_get_contact_collider_object: -- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const +- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** |const| Returns the collider object. @@ -320,7 +320,7 @@ Returns the collider object. .. _class_PhysicsDirectBodyState_method_get_contact_collider_position: -- :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** |const| Returns the contact position in the collider. @@ -328,7 +328,7 @@ Returns the contact position in the collider. .. _class_PhysicsDirectBodyState_method_get_contact_collider_shape: -- :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |const| Returns the collider's shape index. @@ -336,7 +336,7 @@ Returns the collider's shape index. .. _class_PhysicsDirectBodyState_method_get_contact_collider_velocity_at_position: -- :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| Returns the linear velocity vector at the collider's contact point. @@ -344,7 +344,7 @@ Returns the linear velocity vector at the collider's contact point. .. _class_PhysicsDirectBodyState_method_get_contact_count: -- :ref:`int` **get_contact_count** **(** **)** const +- :ref:`int` **get_contact_count** **(** **)** |const| Returns the number of contacts this body has with other bodies. @@ -354,7 +354,7 @@ Returns the number of contacts this body has with other bodies. .. _class_PhysicsDirectBodyState_method_get_contact_impulse: -- :ref:`float` **get_contact_impulse** **(** :ref:`int` contact_idx **)** const +- :ref:`float` **get_contact_impulse** **(** :ref:`int` contact_idx **)** |const| Impulse created by the contact. Only implemented for Bullet physics. @@ -362,7 +362,7 @@ Impulse created by the contact. Only implemented for Bullet physics. .. _class_PhysicsDirectBodyState_method_get_contact_local_normal: -- :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** |const| Returns the local normal at the contact point. @@ -370,7 +370,7 @@ Returns the local normal at the contact point. .. _class_PhysicsDirectBodyState_method_get_contact_local_position: -- :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** |const| Returns the local position of the contact point. @@ -378,7 +378,7 @@ Returns the local position of the contact point. .. _class_PhysicsDirectBodyState_method_get_contact_local_shape: -- :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const +- :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** |const| Returns the local shape index of the collision. @@ -398,3 +398,6 @@ Returns the current state of the space, useful for queries. Calls the built-in force integration code. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 64006f252..29eb46b2d 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -121,3 +121,6 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index 8c5962cd7..bd6d9332a 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -96,3 +96,6 @@ The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum fr If ``true``, the physics engine will use the friction of the object marked as "rough" when two objects collide. If ``false``, the physics engine will use the lowest friction of all colliding objects instead. If ``true`` for both colliding objects, the physics engine will use the highest friction. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 18cb9095f..f04e5c7ab 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -32,23 +32,23 @@ Methods +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`area_create` **(** **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const | +| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +| :ref:`Transform` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | +| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | +| :ref:`Transform` | :ref:`area_get_transform` **(** :ref:`RID` area **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`area_is_ray_pickable` **(** :ref:`RID` area **)** const | +| :ref:`bool` | :ref:`area_is_ray_pickable` **(** :ref:`RID` area **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -100,39 +100,39 @@ Methods +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`body_create` **(** :ref:`BodyMode` mode=2, :ref:`bool` init_sleeping=false **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PhysicsDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_kinematic_safe_margin` **(** :ref:`RID` body **)** const | +| :ref:`float` | :ref:`body_get_kinematic_safe_margin` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | +| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const | +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`Transform` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** const | +| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const | +| :ref:`bool` | :ref:`body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** const | +| :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_ray_pickable` **(** :ref:`RID` body **)** const | +| :ref:`bool` | :ref:`body_is_ray_pickable` **(** :ref:`RID` body **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -172,7 +172,7 @@ Methods +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const | +| :ref:`float` | :ref:`cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -188,9 +188,9 @@ Methods +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const | +| :ref:`bool` | :ref:`hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const | +| :ref:`float` | :ref:`hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -206,17 +206,17 @@ Methods +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`joint_create_slider` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** const | +| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | +| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** const | +| :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** const | +| :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const | +| :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -228,13 +228,13 @@ Methods +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shape_create` **(** :ref:`ShapeType` type **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | +| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const | +| :ref:`float` | :ref:`slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -242,9 +242,9 @@ Methods +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PhysicsDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** |const| | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | +------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -911,7 +911,7 @@ Creates an :ref:`Area`. .. _class_PhysicsServer_method_area_get_object_instance_id: -- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** |const| Gets the instance ID of the object the area is assigned to. @@ -919,7 +919,7 @@ Gets the instance ID of the object the area is assigned to. .. _class_PhysicsServer_method_area_get_param: -- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const +- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |const| Returns an area parameter value. A list of available parameters is on the :ref:`AreaParameter` constants. @@ -927,7 +927,7 @@ Returns an area parameter value. A list of available parameters is on the :ref:` .. _class_PhysicsServer_method_area_get_shape: -- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| Returns the :ref:`RID` of the nth shape of an area. @@ -935,7 +935,7 @@ Returns the :ref:`RID` of the nth shape of an area. .. _class_PhysicsServer_method_area_get_shape_count: -- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** |const| Returns the number of shapes assigned to an area. @@ -943,7 +943,7 @@ Returns the number of shapes assigned to an area. .. _class_PhysicsServer_method_area_get_shape_transform: -- :ref:`Transform` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`Transform` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |const| Returns the transform matrix of a shape within an area. @@ -951,7 +951,7 @@ Returns the transform matrix of a shape within an area. .. _class_PhysicsServer_method_area_get_space: -- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const +- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** |const| Returns the space assigned to the area. @@ -959,7 +959,7 @@ Returns the space assigned to the area. .. _class_PhysicsServer_method_area_get_space_override_mode: -- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const +- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** |const| Returns the space override mode for the area. @@ -967,7 +967,7 @@ Returns the space override mode for the area. .. _class_PhysicsServer_method_area_get_transform: -- :ref:`Transform` **area_get_transform** **(** :ref:`RID` area **)** const +- :ref:`Transform` **area_get_transform** **(** :ref:`RID` area **)** |const| Returns the transform matrix for an area. @@ -975,7 +975,7 @@ Returns the transform matrix for an area. .. _class_PhysicsServer_method_area_is_ray_pickable: -- :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** const +- :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** |const| If ``true``, area collides with rays. @@ -1179,7 +1179,7 @@ Creates a physics body. The first parameter can be any value from :ref:`BodyMode .. _class_PhysicsServer_method_body_get_collision_layer: -- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** |const| Returns the physics layer or layers a body belongs to. @@ -1187,7 +1187,7 @@ Returns the physics layer or layers a body belongs to. .. _class_PhysicsServer_method_body_get_collision_mask: -- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** |const| Returns the physics layer or layers a body can collide with. @@ -1205,13 +1205,13 @@ Returns the :ref:`PhysicsDirectBodyState` of the b .. _class_PhysicsServer_method_body_get_kinematic_safe_margin: -- :ref:`float` **body_get_kinematic_safe_margin** **(** :ref:`RID` body **)** const +- :ref:`float` **body_get_kinematic_safe_margin** **(** :ref:`RID` body **)** |const| ---- .. _class_PhysicsServer_method_body_get_max_contacts_reported: -- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** |const| Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. @@ -1219,7 +1219,7 @@ Returns the maximum contacts that can be reported. See :ref:`body_set_max_contac .. _class_PhysicsServer_method_body_get_mode: -- :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const +- :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** |const| Returns the body mode. @@ -1227,7 +1227,7 @@ Returns the body mode. .. _class_PhysicsServer_method_body_get_object_instance_id: -- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** |const| Gets the instance ID of the object the area is assigned to. @@ -1235,7 +1235,7 @@ Gets the instance ID of the object the area is assigned to. .. _class_PhysicsServer_method_body_get_param: -- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const +- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |const| Returns the value of a body parameter. A list of available parameters is on the :ref:`BodyParameter` constants. @@ -1243,7 +1243,7 @@ Returns the value of a body parameter. A list of available parameters is on the .. _class_PhysicsServer_method_body_get_shape: -- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| Returns the :ref:`RID` of the nth shape of a body. @@ -1251,7 +1251,7 @@ Returns the :ref:`RID` of the nth shape of a body. .. _class_PhysicsServer_method_body_get_shape_count: -- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** |const| Returns the number of shapes assigned to a body. @@ -1259,7 +1259,7 @@ Returns the number of shapes assigned to a body. .. _class_PhysicsServer_method_body_get_shape_transform: -- :ref:`Transform` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Transform` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |const| Returns the transform matrix of a body shape. @@ -1267,7 +1267,7 @@ Returns the transform matrix of a body shape. .. _class_PhysicsServer_method_body_get_space: -- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const +- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** |const| Returns the :ref:`RID` of the space assigned to a body. @@ -1275,7 +1275,7 @@ Returns the :ref:`RID` of the space assigned to a body. .. _class_PhysicsServer_method_body_get_state: -- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const +- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |const| Returns a body state. @@ -1283,13 +1283,13 @@ Returns a body state. .. _class_PhysicsServer_method_body_is_axis_locked: -- :ref:`bool` **body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const +- :ref:`bool` **body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |const| ---- .. _class_PhysicsServer_method_body_is_continuous_collision_detection_enabled: -- :ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** |const| If ``true``, the continuous collision detection mode is enabled. @@ -1297,7 +1297,7 @@ If ``true``, the continuous collision detection mode is enabled. .. _class_PhysicsServer_method_body_is_omitting_force_integration: -- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** |const| Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). @@ -1305,7 +1305,7 @@ Returns whether a body uses a callback function to calculate its own physics (se .. _class_PhysicsServer_method_body_is_ray_pickable: -- :ref:`bool` **body_is_ray_pickable** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_ray_pickable** **(** :ref:`RID` body **)** |const| If ``true``, the body can be detected by rays. @@ -1463,7 +1463,7 @@ Sets a body state (see :ref:`BodyState` constants) .. _class_PhysicsServer_method_cone_twist_joint_get_param: -- :ref:`float` **cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const +- :ref:`float` **cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** |const| Gets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` constants). @@ -1527,7 +1527,7 @@ Returns an Info defined by the :ref:`ProcessInfo .. _class_PhysicsServer_method_hinge_joint_get_flag: -- :ref:`bool` **hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const +- :ref:`bool` **hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** |const| Gets a hinge_joint flag (see :ref:`HingeJointFlag` constants). @@ -1535,7 +1535,7 @@ Gets a hinge_joint flag (see :ref:`HingeJointFlag` **hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const +- :ref:`float` **hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** |const| Gets a hinge_joint parameter (see :ref:`HingeJointParam`). @@ -1599,7 +1599,7 @@ Creates a :ref:`SliderJoint`. .. _class_PhysicsServer_method_joint_get_solver_priority: -- :ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** const +- :ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** |const| Gets the priority value of the Joint. @@ -1607,7 +1607,7 @@ Gets the priority value of the Joint. .. _class_PhysicsServer_method_joint_get_type: -- :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const +- :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** |const| Returns the type of the Joint. @@ -1623,7 +1623,7 @@ Sets the priority value of the Joint. .. _class_PhysicsServer_method_pin_joint_get_local_a: -- :ref:`Vector3` **pin_joint_get_local_a** **(** :ref:`RID` joint **)** const +- :ref:`Vector3` **pin_joint_get_local_a** **(** :ref:`RID` joint **)** |const| Returns position of the joint in the local space of body a of the joint. @@ -1631,7 +1631,7 @@ Returns position of the joint in the local space of body a of the joint. .. _class_PhysicsServer_method_pin_joint_get_local_b: -- :ref:`Vector3` **pin_joint_get_local_b** **(** :ref:`RID` joint **)** const +- :ref:`Vector3` **pin_joint_get_local_b** **(** :ref:`RID` joint **)** |const| Returns position of the joint in the local space of body b of the joint. @@ -1639,7 +1639,7 @@ Returns position of the joint in the local space of body b of the joint. .. _class_PhysicsServer_method_pin_joint_get_param: -- :ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const +- :ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |const| Gets a pin_joint parameter (see :ref:`PinJointParam` constants). @@ -1687,7 +1687,7 @@ Creates a shape of a type from :ref:`ShapeType`. D .. _class_PhysicsServer_method_shape_get_data: -- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const +- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** |const| Returns the shape data. @@ -1695,7 +1695,7 @@ Returns the shape data. .. _class_PhysicsServer_method_shape_get_type: -- :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const +- :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** |const| Returns the type of shape (see :ref:`ShapeType` constants). @@ -1711,7 +1711,7 @@ Sets the shape data that defines its shape and size. The data to be passed depen .. _class_PhysicsServer_method_slider_joint_get_param: -- :ref:`float` **slider_joint_get_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const +- :ref:`float` **slider_joint_get_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** |const| Gets a slider_joint parameter (see :ref:`SliderJointParam` constants). @@ -1743,7 +1743,7 @@ Returns the state of a space, a :ref:`PhysicsDirectSpaceState` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const +- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |const| Returns the value of a space parameter. @@ -1751,7 +1751,7 @@ Returns the value of a space parameter. .. _class_PhysicsServer_method_space_is_active: -- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const +- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** |const| Returns whether the space is active. @@ -1771,3 +1771,6 @@ Marks a space as active. It will not have an effect, unless it is assigned to an Sets the value for a space parameter. A list of available parameters is on the :ref:`SpaceParameter` constants. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 49cdf3123..52915dd59 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -91,7 +91,7 @@ If ``true``, the query will take :ref:`PhysicsBody`\ s into a | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The physics layer(s) the query will take into account (as a bitmask). +The physics layer(s) the query will take into account (as a bitmask). See `Collision layers and masks `_ in the documentation for more information. ---- @@ -164,3 +164,6 @@ Method Descriptions Sets the :ref:`Shape` that will be used for collision/intersection queries. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index 494c71672..287a52a0f 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -21,24 +21,24 @@ The result of a 3D shape query in :ref:`PhysicsServer`. See Methods ------- -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_count` **(** **)** const | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** const | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** const | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_count` **(** **)** |const| | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** |const| | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** |const| | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** |const| | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** |const| | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_PhysicsShapeQueryResult_method_get_result_count: -- :ref:`int` **get_result_count** **(** **)** const +- :ref:`int` **get_result_count** **(** **)** |const| Returns the number of objects that intersected with the shape. @@ -46,7 +46,7 @@ Returns the number of objects that intersected with the shape. .. _class_PhysicsShapeQueryResult_method_get_result_object: -- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const +- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** |const| Returns the :ref:`Object` that intersected with the shape at index ``idx``. @@ -54,7 +54,7 @@ Returns the :ref:`Object` that intersected with the shape at index .. _class_PhysicsShapeQueryResult_method_get_result_object_id: -- :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const +- :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** |const| Returns the instance ID of the :ref:`Object` that intersected with the shape at index ``idx``. @@ -62,7 +62,7 @@ Returns the instance ID of the :ref:`Object` that intersected with .. _class_PhysicsShapeQueryResult_method_get_result_object_shape: -- :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const +- :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** |const| Returns the child index of the object's :ref:`Shape` that intersected with the shape at index ``idx``. @@ -70,7 +70,10 @@ Returns the child index of the object's :ref:`Shape` that intersect .. _class_PhysicsShapeQueryResult_method_get_result_rid: -- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const +- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** |const| Returns the :ref:`RID` of the object that intersected with the shape at index ``idx``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index fa9010b4f..06f794ed7 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -33,7 +33,7 @@ Methods ------- +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** const | +| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ @@ -111,7 +111,7 @@ Method Descriptions .. _class_PinJoint_method_get_param: -- :ref:`float` **get_param** **(** :ref:`Param` param **)** const +- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| Returns the value of the specified parameter. @@ -123,3 +123,6 @@ Returns the value of the specified parameter. Sets the value of the specified parameter. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index 49989b38b..27e55a8d1 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -42,3 +42,6 @@ Property Descriptions The higher this value, the more the bond to the pinned partner can flex. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_plane.rst b/classes/class_plane.rst index e922d60be..653341bee 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -260,3 +260,6 @@ Returns a copy of the plane, normalized. Returns the orthogonal projection of ``point`` into a point in the plane. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 36f742c2c..ca376ea5b 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -78,3 +78,6 @@ Number of subdivision along the Z axis. Number of subdivision along the X axis. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 2a3935df7..e9e386669 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -42,3 +42,6 @@ Property Descriptions The :ref:`Plane` used by the ``PlaneShape`` for collision. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_pluginscript.rst b/classes/class_pluginscript.rst index 9904ec7c0..89d0cc818 100644 --- a/classes/class_pluginscript.rst +++ b/classes/class_pluginscript.rst @@ -16,16 +16,19 @@ PluginScript Methods ------- -+-------------------------------+------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`new` **(** ... **)** vararg | -+-------------------------------+------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** ... **)** |vararg| | ++-------------------------------+--------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_PluginScript_method_new: -- :ref:`Variant` **new** **(** ... **)** vararg +- :ref:`Variant` **new** **(** ... **)** |vararg| Returns a new instance of the script. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_pointmesh.rst b/classes/class_pointmesh.rst index 1dc91b484..891844d46 100644 --- a/classes/class_pointmesh.rst +++ b/classes/class_pointmesh.rst @@ -22,3 +22,6 @@ PointMeshes, must be used with a material that has a point size. Point size can When using PointMeshes, properties that normally alter vertices will be ignored, including billboard mode, grow, and cull face. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 1c38c8324..65ddf6b26 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -69,11 +69,11 @@ Methods +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_bone` **(** :ref:`int` index **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_count` **(** **)** const | +| :ref:`int` | :ref:`get_bone_count` **(** **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_bone_path` **(** :ref:`int` index **)** const | +| :ref:`NodePath` | :ref:`get_bone_path` **(** :ref:`int` index **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_bone_weights` **(** :ref:`int` index **)** const | +| :ref:`PoolRealArray` | :ref:`get_bone_weights` **(** :ref:`int` index **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_path` **(** :ref:`int` index, :ref:`NodePath` path **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -368,7 +368,7 @@ Removes the specified bone from this ``Polygon2D``. .. _class_Polygon2D_method_get_bone_count: -- :ref:`int` **get_bone_count** **(** **)** const +- :ref:`int` **get_bone_count** **(** **)** |const| Returns the number of bones in this ``Polygon2D``. @@ -376,7 +376,7 @@ Returns the number of bones in this ``Polygon2D``. .. _class_Polygon2D_method_get_bone_path: -- :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** const +- :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** |const| Returns the path to the node associated with the specified bone. @@ -384,7 +384,7 @@ Returns the path to the node associated with the specified bone. .. _class_Polygon2D_method_get_bone_weights: -- :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** const +- :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** |const| Returns the height values of the specified bone. @@ -404,3 +404,6 @@ Sets the path to the node associated with the specified bone. Sets the weight values for the specified bone. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 478bf0c37..f7d976414 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -19,15 +19,15 @@ Methods +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | +| :ref:`Rect2` | :ref:`get_bounds` **(** **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | +| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | +| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | +| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,31 +45,31 @@ Method Descriptions .. _class_PolygonPathFinder_method_get_bounds: -- :ref:`Rect2` **get_bounds** **(** **)** const +- :ref:`Rect2` **get_bounds** **(** **)** |const| ---- .. _class_PolygonPathFinder_method_get_closest_point: -- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** const +- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** |const| ---- .. _class_PolygonPathFinder_method_get_intersections: -- :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const +- :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** |const| ---- .. _class_PolygonPathFinder_method_get_point_penalty: -- :ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** const +- :ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** |const| ---- .. _class_PolygonPathFinder_method_is_point_inside: -- :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** const +- :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** |const| ---- @@ -83,3 +83,6 @@ Method Descriptions - void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index ee5dbccd2..9ed413357 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -199,3 +199,6 @@ Returns the size of the array. Returns the slice of the ``PoolByteArray`` between indices (inclusive) as a new ``PoolByteArray``. Any negative index is considered to be from the end of the array. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index 38fe0c73c..017936e01 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -134,3 +134,6 @@ Changes the :ref:`Color` at the given index. Returns the size of the array. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index 92fca18fc..d8e8299c6 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -136,3 +136,6 @@ Changes the int at the given index. Returns the array size. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index 43622ede2..c42ee95d9 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -134,3 +134,6 @@ Changes the float at the given index. Returns the size of the array. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 25113f0ec..7a0bdb070 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -144,3 +144,6 @@ Changes the :ref:`String` at the given index. Returns the size of the array. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index 507dfdcbd..6f3097f80 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -134,3 +134,6 @@ Changes the :ref:`Vector2` at the given index. Returns the size of the array. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 091ec4424..ec95c570a 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -134,3 +134,6 @@ Changes the :ref:`Vector3` at the given index. Returns the size of the array. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 4e0df034f..13952b709 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -91,6 +91,8 @@ Property Descriptions If ``true``, the popup will not be hidden when a click event occurs outside of it, or when it receives the ``ui_cancel`` action event. +**Note:** Enabling this property doesn't affect the Close or Cancel buttons' behavior in dialogs that inherit from this class. As a workaround, you can use :ref:`WindowDialog.get_close_button` or :ref:`ConfirmationDialog.get_cancel` and hide the buttons in question by setting their :ref:`CanvasItem.visible` property to ``false``. + Method Descriptions ------------------- @@ -140,3 +142,6 @@ Popup (show the control in modal form) in the center of the screen relative to t Shrink popup to keep to the minimum size of content. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_popupdialog.rst b/classes/class_popupdialog.rst index b682f44e2..0c5c7c2ae 100644 --- a/classes/class_popupdialog.rst +++ b/classes/class_popupdialog.rst @@ -25,3 +25,6 @@ Theme Properties | :ref:`StyleBox` | panel | +---------------------------------+-------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index dad679a02..6747b1b9e 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -71,41 +71,41 @@ Methods +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_index` **(** **)** const | +| :ref:`int` | :ref:`get_current_index` **(** **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | +| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | +| :ref:`int` | :ref:`get_item_count` **(** **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | +| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | +| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | +| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_window_lose_focus` **(** **)** const | +| :ref:`bool` | :ref:`is_hide_on_window_lose_focus` **(** **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_radio_checkable` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_item_radio_checkable` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` idx **)** const | +| :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` idx **)** |const| | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -464,13 +464,13 @@ Removes all items from the ``PopupMenu``. .. _class_PopupMenu_method_get_current_index: -- :ref:`int` **get_current_index** **(** **)** const +- :ref:`int` **get_current_index** **(** **)** |const| ---- .. _class_PopupMenu_method_get_item_accelerator: -- :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** const +- :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** |const| Returns the accelerator of the item at index ``idx``. Accelerators are special combinations of keys that activate the item, no matter which control is focused. @@ -478,7 +478,7 @@ Returns the accelerator of the item at index ``idx``. Accelerators are special c .. _class_PopupMenu_method_get_item_count: -- :ref:`int` **get_item_count** **(** **)** const +- :ref:`int` **get_item_count** **(** **)** |const| Returns the number of items in the ``PopupMenu``. @@ -486,7 +486,7 @@ Returns the number of items in the ``PopupMenu``. .. _class_PopupMenu_method_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** |const| Returns the icon of the item at index ``idx``. @@ -494,7 +494,7 @@ Returns the icon of the item at index ``idx``. .. _class_PopupMenu_method_get_item_id: -- :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const +- :ref:`int` **get_item_id** **(** :ref:`int` idx **)** |const| Returns the id of the item at index ``idx``. ``id`` can be manually assigned, while index can not. @@ -502,7 +502,7 @@ Returns the id of the item at index ``idx``. ``id`` can be manually assigned, wh .. _class_PopupMenu_method_get_item_index: -- :ref:`int` **get_item_index** **(** :ref:`int` id **)** const +- :ref:`int` **get_item_index** **(** :ref:`int` id **)** |const| Returns the index of the item containing the specified ``id``. Index is automatically assigned to each item by the engine. Index can not be set manually. @@ -510,7 +510,7 @@ Returns the index of the item containing the specified ``id``. Index is automati .. _class_PopupMenu_method_get_item_metadata: -- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** |const| Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`set_item_metadata`, which provides a simple way of assigning context data to items. @@ -518,7 +518,7 @@ Returns the metadata of the specified item, which might be of any type. You can .. _class_PopupMenu_method_get_item_shortcut: -- :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** const +- :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** |const| Returns the :ref:`ShortCut` associated with the specified ``idx`` item. @@ -526,7 +526,7 @@ Returns the :ref:`ShortCut` associated with the specified ``idx` .. _class_PopupMenu_method_get_item_submenu: -- :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** |const| Returns the submenu name of the item at index ``idx``. See :ref:`add_submenu_item` for more info on how to add a submenu. @@ -534,7 +534,7 @@ Returns the submenu name of the item at index ``idx``. See :ref:`add_submenu_ite .. _class_PopupMenu_method_get_item_text: -- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** |const| Returns the text of the item at index ``idx``. @@ -542,7 +542,7 @@ Returns the text of the item at index ``idx``. .. _class_PopupMenu_method_get_item_tooltip: -- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** |const| Returns the tooltip associated with the specified index index ``idx``. @@ -550,7 +550,7 @@ Returns the tooltip associated with the specified index index ``idx``. .. _class_PopupMenu_method_is_hide_on_window_lose_focus: -- :ref:`bool` **is_hide_on_window_lose_focus** **(** **)** const +- :ref:`bool` **is_hide_on_window_lose_focus** **(** **)** |const| Returns ``true`` if the popup will be hidden when the window loses focus or not. @@ -558,7 +558,7 @@ Returns ``true`` if the popup will be hidden when the window loses focus or not. .. _class_PopupMenu_method_is_item_checkable: -- :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button. @@ -568,7 +568,7 @@ Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if .. _class_PopupMenu_method_is_item_checked: -- :ref:`bool` **is_item_checked** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_checked** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item at index ``idx`` is checked. @@ -576,7 +576,7 @@ Returns ``true`` if the item at index ``idx`` is checked. .. _class_PopupMenu_method_is_item_disabled: -- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked. @@ -586,7 +586,7 @@ See :ref:`set_item_disabled` for more .. _class_PopupMenu_method_is_item_radio_checkable: -- :ref:`bool` **is_item_radio_checkable** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_radio_checkable** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item at index ``idx`` has radio button-style checkability. @@ -596,7 +596,7 @@ Returns ``true`` if the item at index ``idx`` has radio button-style checkabilit .. _class_PopupMenu_method_is_item_separator: -- :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** |const| Returns ``true`` if the item is a separator. If it is, it will be displayed as a line. See :ref:`add_separator` for more info on how to add a separator. @@ -604,7 +604,7 @@ Returns ``true`` if the item is a separator. If it is, it will be displayed as a .. _class_PopupMenu_method_is_item_shortcut_disabled: -- :ref:`bool` **is_item_shortcut_disabled** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_item_shortcut_disabled** **(** :ref:`int` idx **)** |const| Returns ``true`` if the specified item's shortcut is disabled. @@ -764,3 +764,6 @@ Toggles the check state of the item of the specified index ``idx``. Cycle to the next state of an multistate item. See :ref:`add_multistate_item` for details. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index c3bd22ae1..aa699562c 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -25,3 +25,6 @@ Theme Properties | :ref:`StyleBox` | panel | +---------------------------------+-------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_position2d.rst b/classes/class_position2d.rst index e3a65d033..006549803 100644 --- a/classes/class_position2d.rst +++ b/classes/class_position2d.rst @@ -18,3 +18,6 @@ Description Generic 2D position hint for editing. It's just like a plain :ref:`Node2D`, but it displays as a cross in the 2D editor at all times. You can set cross' visual size by using the gizmo in the 2D editor while the node is selected. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_position3d.rst b/classes/class_position3d.rst index 8ad06d5c5..775563f51 100644 --- a/classes/class_position3d.rst +++ b/classes/class_position3d.rst @@ -18,3 +18,6 @@ Description Generic 3D position hint for editing. It's just like a plain :ref:`Spatial`, but it displays as a cross in the 3D editor at all times. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index cf5baf534..18c4b659c 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -34,9 +34,9 @@ Properties Methods ------- -+---------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | -+---------------------------+--------------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** |const| | ++---------------------------+----------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -92,7 +92,7 @@ Method Descriptions .. _class_PrimitiveMesh_method_get_mesh_arrays: -- :ref:`Array` **get_mesh_arrays** **(** **)** const +- :ref:`Array` **get_mesh_arrays** **(** **)** |const| Returns mesh arrays used to constitute surface of :ref:`Mesh`. The result can be passed to :ref:`ArrayMesh.add_surface_from_arrays` to create a new surface. For example: @@ -102,3 +102,6 @@ Returns mesh arrays used to constitute surface of :ref:`Mesh`. The r var arr_mesh := ArrayMesh.new() arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, c.get_mesh_arrays()) +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 7e4ef0d6c..57e55c728 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -114,3 +114,6 @@ Number of added edge loops along the Y axis. Number of added edge loops along the X axis. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index dd3061c12..ea3b501ad 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -345,3 +345,6 @@ The direction of the sun using polar coordinates. Size of :ref:`Texture` that the ProceduralSky will generate. The size is set using :ref:`TextureSize`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index ea3ced5a0..b157a7f20 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -61,3 +61,6 @@ Property Descriptions If ``true``, the fill percentage is displayed on the bar. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 4bf2de614..10dd102db 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -683,17 +683,17 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** :ref:`String` name **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack, :ref:`bool` replace_files=true **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -833,7 +833,9 @@ Icon set in ``.icns`` format used on macOS to set the game's icon. This is done | *Default* | ``""`` | +-----------+--------+ -The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. +The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. The window title will be set to match the project name automatically on startup. + +**Note:** Changing this value will also change the user data folder's path if :ref:`application/config/use_custom_user_dir` is ``false``. After renaming the project, you will no longer be able to access existing data in ``user://`` unless you rename the old folder to match the new project name. See `Data paths `_ in the documentation for more information. ---- @@ -3817,6 +3819,8 @@ Enabling this setting uses the legacy method to draw batches containing only one Turns batching on and off. Batching increases performance by reducing the amount of graphics API drawcalls. +**Note:** Currently only effective when using the GLES2 renderer. + ---- .. _class_ProjectSettings_property_rendering/batching/options/use_batching_in_editor: @@ -3829,6 +3833,8 @@ Turns batching on and off. Batching increases performance by reducing the amount Switches on batching within the editor. +**Note:** Currently only effective when using the GLES2 renderer. + ---- .. _class_ProjectSettings_property_rendering/batching/parameters/batch_buffer_size: @@ -4683,7 +4689,7 @@ Clears the whole configuration (not recommended, may break things). .. _class_ProjectSettings_method_get_order: -- :ref:`int` **get_order** **(** :ref:`String` name **)** const +- :ref:`int` **get_order** **(** :ref:`String` name **)** |const| Returns the order of a configuration value (influences when saved to the config file). @@ -4691,7 +4697,7 @@ Returns the order of a configuration value (influences when saved to the config .. _class_ProjectSettings_method_get_setting: -- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** |const| Returns the value of a setting. @@ -4705,7 +4711,7 @@ Returns the value of a setting. .. _class_ProjectSettings_method_globalize_path: -- :ref:`String` **globalize_path** **(** :ref:`String` path **)** const +- :ref:`String` **globalize_path** **(** :ref:`String` path **)** |const| Converts a localized path (``res://``) to a full native OS path. @@ -4713,7 +4719,7 @@ Converts a localized path (``res://``) to a full native OS path. .. _class_ProjectSettings_method_has_setting: -- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const +- :ref:`bool` **has_setting** **(** :ref:`String` name **)** |const| Returns ``true`` if a configuration value is present. @@ -4731,7 +4737,7 @@ Loads the contents of the .pck or .zip file specified by ``pack`` into the resou .. _class_ProjectSettings_method_localize_path: -- :ref:`String` **localize_path** **(** :ref:`String` path **)** const +- :ref:`String` **localize_path** **(** :ref:`String` path **)** |const| Convert a path to a localized path (``res://`` path). @@ -4797,3 +4803,6 @@ Sets the value of a setting. ProjectSettings.set_setting("application/config/name", "Example") +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 3dde67702..c47003898 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -108,3 +108,6 @@ Method Descriptions - void **broadcast** **(** :ref:`String` name, :ref:`Variant` parameters **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index dc36b4881..799b13482 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -35,3 +35,6 @@ Property Descriptions | *Getter* | get_base() | +----------+-----------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index dfc2c6bee..fdf992697 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -42,3 +42,6 @@ Property Descriptions Size on the X and Y axes. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_quat.rst b/classes/class_quat.rst index bb75eb8cb..d98140327 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -284,3 +284,6 @@ Returns the result of the spherical linear interpolation between this quaternion Returns a vector transformed (multiplied) by this quaternion. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index a35fa7429..e1ee81a59 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -121,3 +121,6 @@ Generates a pseudo-random 32-bit signed integer between ``from`` and ``to`` (inc Setups a time-based seed to generator. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_range.rst b/classes/class_range.rst index 5f3c02465..bb30d8fab 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -247,3 +247,6 @@ Binds two ranges together along with any ranges previously grouped with either o Stops range from sharing its member variables with any other. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 1cac10c1b..d38affc47 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -60,17 +60,17 @@ Methods +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_raycast_update` **(** **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | +| :ref:`Object` | :ref:`get_collider` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +| :ref:`int` | :ref:`get_collider_shape` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | +| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_point` **(** **)** const | +| :ref:`Vector3` | :ref:`get_collision_point` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | +| :ref:`bool` | :ref:`is_colliding` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_exception` **(** :ref:`Object` node **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -142,7 +142,7 @@ If ``true``, collision with :ref:`PhysicsBody`\ s will be rep | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. +The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -217,7 +217,7 @@ Use this method to update the collision information immediately instead of waiti .. _class_RayCast_method_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Object` **get_collider** **(** **)** |const| Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -225,7 +225,7 @@ Returns the first object that the ray intersects, or ``null`` if no object is in .. _class_RayCast_method_get_collider_shape: -- :ref:`int` **get_collider_shape** **(** **)** const +- :ref:`int` **get_collider_shape** **(** **)** |const| Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -233,7 +233,7 @@ Returns the shape ID of the first object that the ray intersects, or ``0`` if no .. _class_RayCast_method_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns ``true`` if the bit index passed is turned on. @@ -243,7 +243,7 @@ Returns ``true`` if the bit index passed is turned on. .. _class_RayCast_method_get_collision_normal: -- :ref:`Vector3` **get_collision_normal** **(** **)** const +- :ref:`Vector3` **get_collision_normal** **(** **)** |const| Returns the normal of the intersecting object's shape at the collision point. @@ -251,7 +251,7 @@ Returns the normal of the intersecting object's shape at the collision point. .. _class_RayCast_method_get_collision_point: -- :ref:`Vector3` **get_collision_point** **(** **)** const +- :ref:`Vector3` **get_collision_point** **(** **)** |const| Returns the collision point at which the ray intersects the closest object. @@ -261,7 +261,7 @@ Returns the collision point at which the ray intersects the closest object. .. _class_RayCast_method_is_colliding: -- :ref:`bool` **is_colliding** **(** **)** const +- :ref:`bool` **is_colliding** **(** **)** |const| Returns whether any object is intersecting with the ray's vector (considering the vector length). @@ -291,3 +291,6 @@ Sets the bit index passed to the ``value`` passed. **Note:** Bit indexes range from 0-19. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index a4219cf6e..c8a4e3a6b 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -60,17 +60,17 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_raycast_update` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | +| :ref:`Object` | :ref:`get_collider` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +| :ref:`int` | :ref:`get_collider_shape` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | +| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | +| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | +| :ref:`bool` | :ref:`is_colliding` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_exception` **(** :ref:`Object` node **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -142,7 +142,7 @@ If ``true``, collision with :ref:`PhysicsBody2D`\ s will be | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. +The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -215,7 +215,7 @@ Updates the collision information for the ray. Use this method to update the col .. _class_RayCast2D_method_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Object` **get_collider** **(** **)** |const| Returns the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -223,7 +223,7 @@ Returns the first object that the ray intersects, or ``null`` if no object is in .. _class_RayCast2D_method_get_collider_shape: -- :ref:`int` **get_collider_shape** **(** **)** const +- :ref:`int` **get_collider_shape** **(** **)** |const| Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). @@ -231,7 +231,7 @@ Returns the shape ID of the first object that the ray intersects, or ``0`` if no .. _class_RayCast2D_method_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the collision mask. @@ -239,7 +239,7 @@ Returns an individual bit on the collision mask. .. _class_RayCast2D_method_get_collision_normal: -- :ref:`Vector2` **get_collision_normal** **(** **)** const +- :ref:`Vector2` **get_collision_normal** **(** **)** |const| Returns the normal of the intersecting object's shape at the collision point. @@ -247,7 +247,7 @@ Returns the normal of the intersecting object's shape at the collision point. .. _class_RayCast2D_method_get_collision_point: -- :ref:`Vector2` **get_collision_point** **(** **)** const +- :ref:`Vector2` **get_collision_point** **(** **)** |const| Returns the collision point at which the ray intersects the closest object. @@ -257,7 +257,7 @@ Returns the collision point at which the ray intersects the closest object. .. _class_RayCast2D_method_is_colliding: -- :ref:`bool` **is_colliding** **(** **)** const +- :ref:`bool` **is_colliding** **(** **)** |const| Returns whether any object is intersecting with the ray's vector (considering the vector length). @@ -285,3 +285,6 @@ Removes a collision exception so the ray does report collisions with the specifi Sets or clears individual bits on the collision mask. This makes selecting the areas scanned easier. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 99c65db65..00d1f9e21 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -60,3 +60,6 @@ The ray's length. If ``true``, allow the shape to return the correct normal. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 590fc18ae..034c677ac 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -60,3 +60,6 @@ The ray's length. If ``true``, allow the shape to return the correct normal. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index d8d98fd41..896ceca20 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -227,3 +227,6 @@ Returns ``true`` if this ``Rect2`` and ``rect`` are approximately equal, by call Returns a larger ``Rect2`` that contains this ``Rect2`` and ``b``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index ffafa972e..0f8a8fa9d 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -42,3 +42,6 @@ Property Descriptions The rectangle's half extents. The width and height of this shape is twice the half extents. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 1292a708b..8fab16c98 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -71,3 +71,6 @@ Decrements the internal reference counter. Use this only if you really know what Returns ``true`` if the decrement was successful, ``false`` otherwise. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index fd06d5959..f99f22b52 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -60,3 +60,6 @@ Sets the border :ref:`Color` of the ``ReferenceRect``. If set to ``true``, the ``ReferenceRect`` will only be visible while in editor. Otherwise, ``ReferenceRect`` will be visible in game. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 04556acd3..1d28281a6 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -264,3 +264,6 @@ Sets the origin offset to be used when this reflection probe is in box project m Sets how frequently the probe is updated. Can be :ref:`UPDATE_ONCE` or :ref:`UPDATE_ALWAYS`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 529512814..6095f6a46 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -75,25 +75,25 @@ If you need to process multiple results, :ref:`search_all` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`compile` **(** :ref:`String` pattern **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_group_count` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_names` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pattern` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`compile` **(** :ref:`String` pattern **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_group_count` **(** **)** |const| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_names` **(** **)** |const| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pattern` **(** **)** |const| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** |const| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -116,7 +116,7 @@ Compiles and assign the search pattern to use. Returns :ref:`@GlobalScope.OK` **get_group_count** **(** **)** const +- :ref:`int` **get_group_count** **(** **)** |const| Returns the number of capturing groups in compiled pattern. @@ -124,7 +124,7 @@ Returns the number of capturing groups in compiled pattern. .. _class_RegEx_method_get_names: -- :ref:`Array` **get_names** **(** **)** const +- :ref:`Array` **get_names** **(** **)** |const| Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. @@ -132,7 +132,7 @@ Returns an array of names of named capturing groups in the compiled pattern. The .. _class_RegEx_method_get_pattern: -- :ref:`String` **get_pattern** **(** **)** const +- :ref:`String` **get_pattern** **(** **)** |const| Returns the original search pattern that was compiled. @@ -140,7 +140,7 @@ Returns the original search pattern that was compiled. .. _class_RegEx_method_is_valid: -- :ref:`bool` **is_valid** **(** **)** const +- :ref:`bool` **is_valid** **(** **)** |const| Returns whether this object has a valid search pattern assigned. @@ -148,7 +148,7 @@ Returns whether this object has a valid search pattern assigned. .. _class_RegEx_method_search: -- :ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const +- :ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** |const| 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. @@ -156,7 +156,7 @@ Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` **search_all** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const +- :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. @@ -164,7 +164,10 @@ Searches the text for the compiled pattern. Returns an array of :ref:`RegExMatch .. _class_RegEx_method_sub: -- :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const +- :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** |const| Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as ``$1`` and ``$name`` are expanded and resolved. By default, only the first instance is replaced, but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index e80782372..57aef18e1 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -32,15 +32,15 @@ Properties Methods ------- -+-----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_end` **(** :ref:`Variant` name=0 **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_group_count` **(** **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_start` **(** :ref:`Variant` name=0 **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string` **(** :ref:`Variant` name=0 **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------+ ++-----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_end` **(** :ref:`Variant` name=0 **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_group_count` **(** **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_start` **(** :ref:`Variant` name=0 **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string` **(** :ref:`Variant` name=0 **)** |const| | ++-----------------------------+----------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -90,7 +90,7 @@ Method Descriptions .. _class_RegExMatch_method_get_end: -- :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const +- :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** |const| 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. @@ -100,7 +100,7 @@ Returns -1 if the group did not match or doesn't exist. .. _class_RegExMatch_method_get_group_count: -- :ref:`int` **get_group_count** **(** **)** const +- :ref:`int` **get_group_count** **(** **)** |const| Returns the number of capturing groups. @@ -108,7 +108,7 @@ Returns the number of capturing groups. .. _class_RegExMatch_method_get_start: -- :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const +- :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** |const| 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. @@ -118,9 +118,12 @@ Returns -1 if the group did not match or doesn't exist. .. _class_RegExMatch_method_get_string: -- :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const +- :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** |const| 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. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 002f38e4c..fac50b569 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -132,3 +132,6 @@ Method Descriptions ``RemoteTransform`` caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache` forces it to update the cache again. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index f257b0eef..2ab179f3a 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -132,3 +132,6 @@ Method Descriptions ``RemoteTransform2D`` caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache` forces it to update the cache again. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 48d32f9ac..ba27bc6c2 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -41,19 +41,19 @@ Properties Methods ------- -+---------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_setup_local_to_scene` **(** **)** virtual | -+---------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** const | -+---------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_local_scene` **(** **)** const | -+---------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+---------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`setup_local_to_scene` **(** **)** | -+---------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`take_over_path` **(** :ref:`String` path **)** | -+---------------------------------+----------------------------------------------------------------------------------------------------------------+ ++---------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_setup_local_to_scene` **(** **)** |virtual| | ++---------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** |const| | ++---------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_local_scene` **(** **)** |const| | ++---------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** |const| | ++---------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`setup_local_to_scene` **(** **)** | ++---------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`take_over_path` **(** :ref:`String` path **)** | ++---------------------------------+------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -118,7 +118,7 @@ Method Descriptions .. _class_Resource_method__setup_local_to_scene: -- void **_setup_local_to_scene** **(** **)** virtual +- void **_setup_local_to_scene** **(** **)** |virtual| Virtual function which can be overridden to customize the behavior value of :ref:`setup_local_to_scene`. @@ -126,7 +126,7 @@ Virtual function which can be overridden to customize the behavior value of :ref .. _class_Resource_method_duplicate: -- :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const +- :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** |const| Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing ``true`` to the ``subresources`` argument which will copy the subresources. @@ -136,7 +136,7 @@ Duplicates the resource, returning a new resource. By default, sub-resources are .. _class_Resource_method_get_local_scene: -- :ref:`Node` **get_local_scene** **(** **)** const +- :ref:`Node` **get_local_scene** **(** **)** |const| If :ref:`resource_local_to_scene` is enabled and the resource was loaded from a :ref:`PackedScene` instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns ``null``. @@ -144,7 +144,7 @@ If :ref:`resource_local_to_scene` **get_rid** **(** **)** const +- :ref:`RID` **get_rid** **(** **)** |const| Returns 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. @@ -166,3 +166,6 @@ For most resources, this method performs no base logic. :ref:`ViewportTexture`, as the latter would error out if another resource was already cached for the given path. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index 2b6b40fc2..af58172f6 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -25,26 +25,26 @@ Extending this class allows you to define your own loader. Be sure to respect th Methods ------- -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_dependencies` **(** :ref:`String` path, :ref:`String` add_types **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resource_type` **(** :ref:`String` path **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles_type` **(** :ref:`String` typename **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`load` **(** :ref:`String` path, :ref:`String` original_path **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rename_dependencies` **(** :ref:`String` path, :ref:`String` renames **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_dependencies` **(** :ref:`String` path, :ref:`String` add_types **)** |virtual| | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** **)** |virtual| | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resource_type` **(** :ref:`String` path **)** |virtual| | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles_type` **(** :ref:`String` typename **)** |virtual| | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`load` **(** :ref:`String` path, :ref:`String` original_path **)** |virtual| | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rename_dependencies` **(** :ref:`String` path, :ref:`String` renames **)** |virtual| | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_ResourceFormatLoader_method_get_dependencies: -- void **get_dependencies** **(** :ref:`String` path, :ref:`String` add_types **)** virtual +- void **get_dependencies** **(** :ref:`String` path, :ref:`String` add_types **)** |virtual| If implemented, gets the dependencies of a given resource. If ``add_types`` is ``true``, paths should be appended ``::TypeName``, where ``TypeName`` is the class name of the dependency. @@ -54,7 +54,7 @@ If implemented, gets the dependencies of a given resource. If ``add_types`` is ` .. _class_ResourceFormatLoader_method_get_recognized_extensions: -- :ref:`PoolStringArray` **get_recognized_extensions** **(** **)** virtual +- :ref:`PoolStringArray` **get_recognized_extensions** **(** **)** |virtual| Gets the list of extensions for files this loader is able to read. @@ -62,7 +62,7 @@ Gets the list of extensions for files this loader is able to read. .. _class_ResourceFormatLoader_method_get_resource_type: -- :ref:`String` **get_resource_type** **(** :ref:`String` path **)** virtual +- :ref:`String` **get_resource_type** **(** :ref:`String` path **)** |virtual| Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return ``""``. @@ -72,7 +72,7 @@ Gets the class name of the resource associated with the given path. If the loade .. _class_ResourceFormatLoader_method_handles_type: -- :ref:`bool` **handles_type** **(** :ref:`String` typename **)** virtual +- :ref:`bool` **handles_type** **(** :ref:`String` typename **)** |virtual| Tells which resource class this loader can load. @@ -82,7 +82,7 @@ Tells which resource class this loader can load. .. _class_ResourceFormatLoader_method_load: -- :ref:`Variant` **load** **(** :ref:`String` path, :ref:`String` original_path **)** virtual +- :ref:`Variant` **load** **(** :ref:`String` path, :ref:`String` original_path **)** |virtual| Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, ``original_path`` will target the source file. Returns a :ref:`Resource` object on success, or an :ref:`Error` constant in case of failure. @@ -90,9 +90,12 @@ Loads a resource when the engine finds this loader to be compatible. If the load .. _class_ResourceFormatLoader_method_rename_dependencies: -- :ref:`int` **rename_dependencies** **(** :ref:`String` path, :ref:`String` renames **)** virtual +- :ref:`int` **rename_dependencies** **(** :ref:`String` path, :ref:`String` renames **)** |virtual| If implemented, renames dependencies within the given resource and saves it. ``renames`` is a dictionary ``{ String => String }`` mapping old dependency paths to new paths. Returns :ref:`@GlobalScope.OK` on success, or an :ref:`Error` constant in case of failure. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index cc0608ddd..12be5b058 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -23,20 +23,20 @@ By default, Godot saves resources as ``.tres`` (text-based), ``.res`` (binary) o Methods ------- -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` resource **)** virtual | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`recognize` **(** :ref:`Resource` resource **)** virtual | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** virtual | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` resource **)** |virtual| | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`recognize` **(** :ref:`Resource` resource **)** |virtual| | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** |virtual| | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_ResourceFormatSaver_method_get_recognized_extensions: -- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` resource **)** virtual +- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` resource **)** |virtual| Returns the list of extensions available for saving the resource object, provided it is recognized (see :ref:`recognize`). @@ -44,7 +44,7 @@ Returns the list of extensions available for saving the resource object, provide .. _class_ResourceFormatSaver_method_recognize: -- :ref:`bool` **recognize** **(** :ref:`Resource` resource **)** virtual +- :ref:`bool` **recognize** **(** :ref:`Resource` resource **)** |virtual| Returns whether the given resource object can be saved by this saver. @@ -52,9 +52,12 @@ Returns whether the given resource object can be saved by this saver. .. _class_ResourceFormatSaver_method_save: -- :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** virtual +- :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** |virtual| Saves the given resource object to a file at the target ``path``. ``flags`` is a bitmask composed with :ref:`SaverFlags` constants. Returns :ref:`@GlobalScope.OK` on success, or an :ref:`Error` constant in case of failure. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index af3c84468..54efc27eb 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -15,3 +15,6 @@ ResourceImporter +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 11ad6a203..c8e4f8779 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -21,17 +21,17 @@ Interactive :ref:`Resource` loader. This object is returned by : Methods ------- -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_resource` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stage` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stage_count` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`poll` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`wait` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_resource` **(** **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stage` **(** **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stage_count` **(** **)** |const| | ++---------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`poll` **(** **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`wait` **(** **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -46,7 +46,7 @@ Returns the loaded resource if the load operation completed successfully, ``null .. _class_ResourceInteractiveLoader_method_get_stage: -- :ref:`int` **get_stage** **(** **)** const +- :ref:`int` **get_stage** **(** **)** |const| Returns the load stage. The total amount of stages can be queried with :ref:`get_stage_count`. @@ -54,7 +54,7 @@ Returns the load stage. The total amount of stages can be queried with :ref:`get .. _class_ResourceInteractiveLoader_method_get_stage_count: -- :ref:`int` **get_stage_count** **(** **)** const +- :ref:`int` **get_stage_count** **(** **)** |const| Returns the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. @@ -84,3 +84,6 @@ Returns :ref:`@GlobalScope.ERR_FILE_EOF` code if a poll has failed, aborting the operation. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 5a872e8df..68252f485 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -122,3 +122,6 @@ An optional ``type_hint`` can be used to further specify the :ref:`Resource` **(** :ref:`String` name, :ref:`Resource` resource **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** const | +| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_resource` **(** :ref:`String` name **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -50,7 +50,7 @@ Adds a resource to the preloader with the given ``name``. If a resource with the .. _class_ResourcePreloader_method_get_resource: -- :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const +- :ref:`Resource` **get_resource** **(** :ref:`String` name **)** |const| Returns the resource associated to ``name``. @@ -58,7 +58,7 @@ Returns the resource associated to ``name``. .. _class_ResourcePreloader_method_get_resource_list: -- :ref:`PoolStringArray` **get_resource_list** **(** **)** const +- :ref:`PoolStringArray` **get_resource_list** **(** **)** |const| Returns the list of resources inside the preloader. @@ -66,7 +66,7 @@ Returns the list of resources inside the preloader. .. _class_ResourcePreloader_method_has_resource: -- :ref:`bool` **has_resource** **(** :ref:`String` name **)** const +- :ref:`bool` **has_resource** **(** :ref:`String` name **)** |const| Returns ``true`` if the preloader contains a resource associated to ``name``. @@ -86,3 +86,6 @@ Removes the resource associated to ``name`` from the preloader. Renames a resource inside the preloader from ``name`` to ``newname``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 49351849d..7afb7d8ba 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -85,3 +85,6 @@ The ``flags`` bitmask can be specified to customize the save behavior. Returns :ref:`@GlobalScope.OK` on success. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_richtexteffect.rst b/classes/class_richtexteffect.rst index c828ec7a9..9adbf5d35 100644 --- a/classes/class_richtexteffect.rst +++ b/classes/class_richtexteffect.rst @@ -37,16 +37,19 @@ Tutorials Methods ------- -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_process_custom_fx` **(** :ref:`CharFXTransform` char_fx **)** virtual | -+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_process_custom_fx` **(** :ref:`CharFXTransform` char_fx **)** |virtual| | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_RichTextEffect_method__process_custom_fx: -- :ref:`bool` **_process_custom_fx** **(** :ref:`CharFXTransform` char_fx **)** virtual +- :ref:`bool` **_process_custom_fx** **(** :ref:`CharFXTransform` char_fx **)** |virtual| Override this method to modify properties in ``char_fx``. The method must return ``true`` if the character could be transformed successfully. If the method returns ``false``, it will skip transformation to avoid displaying broken text. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index beb283a8a..498bd9d81 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -20,6 +20,8 @@ Rich text can contain custom text, fonts, images and some basic formatting. The **Note:** 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. +**Note:** Unlike :ref:`Label`, RichTextLabel doesn't have a *property* to horizontally align text to the center. Instead, enable :ref:`bbcode_enabled` and surround the text in a ``[center]`` tag as follows: ``[center]Example[/center]``. There is currently no built-in way to vertically align text either, but this can be emulated by relying on anchors/containers and the :ref:`fit_content_height` property. + Tutorials --------- @@ -70,15 +72,15 @@ Methods +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_content_height` **(** **)** const | +| :ref:`int` | :ref:`get_content_height` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | +| :ref:`int` | :ref:`get_line_count` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | +| :ref:`int` | :ref:`get_total_character_count` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | +| :ref:`int` | :ref:`get_visible_line_count` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`install_effect` **(** :ref:`Variant` effect **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -572,7 +574,7 @@ Clears the tag stack and sets :ref:`bbcode_text` **get_content_height** **(** **)** const +- :ref:`int` **get_content_height** **(** **)** |const| Returns the height of the content. @@ -580,7 +582,7 @@ Returns the height of the content. .. _class_RichTextLabel_method_get_line_count: -- :ref:`int` **get_line_count** **(** **)** const +- :ref:`int` **get_line_count** **(** **)** |const| Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line. @@ -588,7 +590,7 @@ Returns the total number of newlines in the tag stack's text tags. Considers wra .. _class_RichTextLabel_method_get_total_character_count: -- :ref:`int` **get_total_character_count** **(** **)** const +- :ref:`int` **get_total_character_count** **(** **)** |const| Returns the total number of characters from text tags. Does not include BBCodes. @@ -604,7 +606,7 @@ Returns the vertical scrollbar. .. _class_RichTextLabel_method_get_visible_line_count: -- :ref:`int` **get_visible_line_count** **(** **)** const +- :ref:`int` **get_visible_line_count** **(** **)** |const| Returns the number of visible lines. @@ -798,3 +800,6 @@ For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width wou If ``expand`` is ``false``, the column will not contribute to the total ratio. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_rid.rst b/classes/class_rid.rst index c79ed7bc1..8d2f83a87 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -42,3 +42,6 @@ Creates a new RID instance with the ID of a given resource. When not handed a va Returns the ID of the referenced resource. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 9d693b0da..f1f052832 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -26,6 +26,8 @@ A RigidBody has 4 behavior :ref:`mode`\ s: Rigid, If you need to override the default physics behavior, you can write a custom force integration function. See :ref:`custom_integrator`. +With Bullet physics (the default), the center of mass is the RigidBody3D center. With GodotPhysics, the center of mass is the average of the :ref:`CollisionShape` centers. + Tutorials --------- @@ -85,31 +87,31 @@ Properties Methods ------- -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** virtual | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_central_force` **(** :ref:`Vector3` force **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` impulse **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` impulse **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_axis_lock` **(** :ref:`BodyAxis` axis **)** const | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`get_inverse_inertia_tensor` **(** **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_lock` **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** |virtual| | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_central_force` **(** :ref:`Vector3` force **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` impulse **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` impulse **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_axis_lock` **(** :ref:`BodyAxis` axis **)** |const| | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** |const| | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`get_inverse_inertia_tensor` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_lock` **(** :ref:`BodyAxis` axis, :ref:`bool` lock **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -342,6 +344,8 @@ Deprecated, use :ref:`PhysicsMaterial.bounce`. +**Note:** A RigidBody3D will never enter sleep mode automatically if its :ref:`mode` is :ref:`MODE_CHARACTER`. It can still be put to sleep manually by setting its :ref:`sleeping` property to ``true``. + ---- .. _class_RigidBody_property_contact_monitor: @@ -559,7 +563,7 @@ Method Descriptions .. _class_RigidBody_method__integrate_forces: -- void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState` state **)** virtual +- void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState` state **)** |virtual| Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it works in addition to the usual physics behavior, but the :ref:`custom_integrator` property allows you to disable the default behavior and do fully custom force integration for a body. @@ -621,7 +625,7 @@ Applies a torque impulse which will be affected by the body mass and shape. This .. _class_RigidBody_method_get_axis_lock: -- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** const +- :ref:`bool` **get_axis_lock** **(** :ref:`BodyAxis` axis **)** |const| Returns ``true`` if the specified linear or rotational axis is locked. @@ -629,7 +633,7 @@ Returns ``true`` if the specified linear or rotational axis is locked. .. _class_RigidBody_method_get_colliding_bodies: -- :ref:`Array` **get_colliding_bodies** **(** **)** const +- :ref:`Array` **get_colliding_bodies** **(** **)** |const| Returns a list of the bodies colliding with this one. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`contacts_reported` to be set high enough to detect all the collisions. @@ -659,3 +663,6 @@ Locks the specified linear or rotational axis. Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index b4e7511de..ce869000d 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -26,6 +26,8 @@ Please also keep in mind that physics bodies manage their own transform which ov If you need to override the default physics behavior or add a transformation at runtime, you can write a custom force integration. See :ref:`custom_integrator`. +The center of mass is always located at the node's origin without taking into account the :ref:`CollisionShape2D` centroid offsets. + Properties ---------- @@ -75,7 +77,7 @@ Methods ------- +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_integrate_forces` **(** :ref:`Physics2DDirectBodyState` state **)** virtual | +| void | :ref:`_integrate_forces` **(** :ref:`Physics2DDirectBodyState` state **)** |virtual| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_central_force` **(** :ref:`Vector2` force **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -89,7 +91,7 @@ Methods +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_torque_impulse` **(** :ref:`float` torque **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | +| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -277,6 +279,8 @@ Deprecated, use :ref:`PhysicsMaterial.bounce`. +**Note:** A RigidBody2D will never enter sleep mode automatically if its :ref:`mode` is :ref:`MODE_CHARACTER`. It can still be put to sleep manually by setting its :ref:`sleeping` property to ``true``. + ---- .. _class_RigidBody2D_property_contact_monitor: @@ -508,7 +512,7 @@ Method Descriptions .. _class_RigidBody2D_method__integrate_forces: -- void **_integrate_forces** **(** :ref:`Physics2DDirectBodyState` state **)** virtual +- void **_integrate_forces** **(** :ref:`Physics2DDirectBodyState` state **)** |virtual| Allows you to read and safely modify the simulation state for the object. Use this instead of :ref:`Node._physics_process` if you need to directly change the body's ``position`` or other physics properties. By default, it works in addition to the usual physics behavior, but :ref:`custom_integrator` allows you to disable the default behavior and write custom force integration for a body. @@ -564,7 +568,7 @@ Applies a rotational impulse to the body. .. _class_RigidBody2D_method_get_colliding_bodies: -- :ref:`Array` **get_colliding_bodies** **(** **)** const +- :ref:`Array` **get_colliding_bodies** **(** **)** |const| Returns a list of the bodies colliding with this one. Requires :ref:`contact_monitor` to be set to ``true`` and :ref:`contacts_reported` to be set high enough to detect all the collisions. @@ -586,3 +590,6 @@ Sets the body's velocity on the given axis. The velocity in the given vector axi Returns ``true`` if a collision would result from moving in the given vector. ``margin`` increases the size of the shapes involved in the collision detection, and ``result`` is an object of type :ref:`Physics2DTestMotionResult`, which contains additional information about the collision (should there be one). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index dfabadf13..718e9b017 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -89,3 +89,6 @@ Property Descriptions | *Getter* | get_zero_y() | +----------+-------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 8b06e774a..81be53492 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -23,47 +23,47 @@ This class cannot be instantiated directly, it is retrieved for a given scene as Methods ------- -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_count` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_method` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_index` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_count` **(** **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connection_method` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_count` **(** **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_index` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_name` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** |const| | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -93,7 +93,7 @@ Method Descriptions .. _class_SceneState_method_get_connection_binds: -- :ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** const +- :ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** |const| Returns the list of bound parameters for the signal at ``idx``. @@ -101,7 +101,7 @@ Returns the list of bound parameters for the signal at ``idx``. .. _class_SceneState_method_get_connection_count: -- :ref:`int` **get_connection_count** **(** **)** const +- :ref:`int` **get_connection_count** **(** **)** |const| Returns the number of signal connections in the scene. @@ -111,7 +111,7 @@ The ``idx`` argument used to query connection metadata in other ``get_connection .. _class_SceneState_method_get_connection_flags: -- :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** const +- :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** |const| Returns the connection flags for the signal at ``idx``. See :ref:`ConnectFlags` constants. @@ -119,7 +119,7 @@ Returns the connection flags for the signal at ``idx``. See :ref:`ConnectFlags` **get_connection_method** **(** :ref:`int` idx **)** const +- :ref:`String` **get_connection_method** **(** :ref:`int` idx **)** |const| Returns the method connected to the signal at ``idx``. @@ -127,7 +127,7 @@ Returns the method connected to the signal at ``idx``. .. _class_SceneState_method_get_connection_signal: -- :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const +- :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** |const| Returns the name of the signal at ``idx``. @@ -135,7 +135,7 @@ Returns the name of the signal at ``idx``. .. _class_SceneState_method_get_connection_source: -- :ref:`NodePath` **get_connection_source** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **get_connection_source** **(** :ref:`int` idx **)** |const| Returns the path to the node that owns the signal at ``idx``, relative to the root node. @@ -143,7 +143,7 @@ Returns the path to the node that owns the signal at ``idx``, relative to the ro .. _class_SceneState_method_get_connection_target: -- :ref:`NodePath` **get_connection_target** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **get_connection_target** **(** :ref:`int` idx **)** |const| Returns the path to the node that owns the method connected to the signal at ``idx``, relative to the root node. @@ -151,7 +151,7 @@ Returns the path to the node that owns the method connected to the signal at ``i .. _class_SceneState_method_get_node_count: -- :ref:`int` **get_node_count** **(** **)** const +- :ref:`int` **get_node_count** **(** **)** |const| Returns the number of nodes in the scene. @@ -161,7 +161,7 @@ The ``idx`` argument used to query node data in other ``get_node_*`` methods in .. _class_SceneState_method_get_node_groups: -- :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const +- :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** |const| Returns the list of group names associated with the node at ``idx``. @@ -169,7 +169,7 @@ Returns the list of group names associated with the node at ``idx``. .. _class_SceneState_method_get_node_index: -- :ref:`int` **get_node_index** **(** :ref:`int` idx **)** const +- :ref:`int` **get_node_index** **(** :ref:`int` idx **)** |const| Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instanced or inherited scene among siblings from the base scene. Despite the name, this index is not related to the ``idx`` argument used here and in other methods. @@ -177,7 +177,7 @@ Returns the node's index, which is its position relative to its siblings. This i .. _class_SceneState_method_get_node_instance: -- :ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** const +- :ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** |const| Returns a :ref:`PackedScene` for the node at ``idx`` (i.e. the whole branch starting at this node, with its child nodes and resources), or ``null`` if the node is not an instance. @@ -185,7 +185,7 @@ Returns a :ref:`PackedScene` for the node at ``idx`` (i.e. th .. _class_SceneState_method_get_node_instance_placeholder: -- :ref:`String` **get_node_instance_placeholder** **(** :ref:`int` idx **)** const +- :ref:`String` **get_node_instance_placeholder** **(** :ref:`int` idx **)** |const| Returns the path to the represented scene file if the node at ``idx`` is an :ref:`InstancePlaceholder`. @@ -193,7 +193,7 @@ Returns the path to the represented scene file if the node at ``idx`` is an :ref .. _class_SceneState_method_get_node_name: -- :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const +- :ref:`String` **get_node_name** **(** :ref:`int` idx **)** |const| Returns the name of the node at ``idx``. @@ -201,7 +201,7 @@ Returns the name of the node at ``idx``. .. _class_SceneState_method_get_node_owner_path: -- :ref:`NodePath` **get_node_owner_path** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **get_node_owner_path** **(** :ref:`int` idx **)** |const| Returns the path to the owner of the node at ``idx``, relative to the root node. @@ -209,7 +209,7 @@ Returns the path to the owner of the node at ``idx``, relative to the root node. .. _class_SceneState_method_get_node_path: -- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const +- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** |const| Returns the path to the node at ``idx``. @@ -219,7 +219,7 @@ If ``for_parent`` is ``true``, returns the path of the ``idx`` node's parent ins .. _class_SceneState_method_get_node_property_count: -- :ref:`int` **get_node_property_count** **(** :ref:`int` idx **)** const +- :ref:`int` **get_node_property_count** **(** :ref:`int` idx **)** |const| Returns the number of exported or overridden properties for the node at ``idx``. @@ -229,7 +229,7 @@ The ``prop_idx`` argument used to query node property data in other ``get_node_p .. _class_SceneState_method_get_node_property_name: -- :ref:`String` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +- :ref:`String` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** |const| Returns the name of the property at ``prop_idx`` for the node at ``idx``. @@ -237,7 +237,7 @@ Returns the name of the property at ``prop_idx`` for the node at ``idx``. .. _class_SceneState_method_get_node_property_value: -- :ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +- :ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** |const| Returns the value of the property at ``prop_idx`` for the node at ``idx``. @@ -245,7 +245,7 @@ Returns the value of the property at ``prop_idx`` for the node at ``idx``. .. _class_SceneState_method_get_node_type: -- :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const +- :ref:`String` **get_node_type** **(** :ref:`int` idx **)** |const| Returns the type of the node at ``idx``. @@ -253,7 +253,10 @@ Returns the type of the node at ``idx``. .. _class_SceneState_method_is_node_instance_placeholder: -- :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** const +- :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** |const| Returns ``true`` if the node at ``idx`` is an :ref:`InstancePlaceholder`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 5462f3e1d..14b7b3922 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -60,9 +60,9 @@ Methods ------- +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method, ... **)** vararg | +| :ref:`Variant` | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method, ... **)** |vararg| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method, ... **)** vararg | +| :ref:`Variant` | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method, ... **)** |vararg| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`change_scene` **(** :ref:`String` path **)** | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -70,25 +70,25 @@ Methods +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | +| :ref:`int` | :ref:`get_frame` **(** **)** |const| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | +| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** |const| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** |const| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** const | +| :ref:`int` | :ref:`get_node_count` **(** **)** |const| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | +| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** |const| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** |const| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | +| :ref:`bool` | :ref:`has_network_peer` **(** **)** |const| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_input_handled` **(** **)** | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_server` **(** **)** const | +| :ref:`bool` | :ref:`is_network_server` **(** **)** |const| | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`notify_group` **(** :ref:`String` group, :ref:`int` notification **)** | +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -477,7 +477,7 @@ Method Descriptions .. _class_SceneTree_method_call_group: -- :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method, ... **)** vararg +- :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method, ... **)** |vararg| Calls ``method`` on each member of the given group. @@ -485,7 +485,7 @@ Calls ``method`` on each member of the given group. .. _class_SceneTree_method_call_group_flags: -- :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method, ... **)** vararg +- :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method, ... **)** |vararg| Calls ``method`` on each member of the given group, respecting the given :ref:`GroupCallFlags`. @@ -530,7 +530,7 @@ Commonly used to create a one-shot delay timer as in the following example: .. _class_SceneTree_method_get_frame: -- :ref:`int` **get_frame** **(** **)** const +- :ref:`int` **get_frame** **(** **)** |const| Returns the current frame number, i.e. the total frame count since the application started. @@ -538,7 +538,7 @@ Returns the current frame number, i.e. the total frame count since the applicati .. _class_SceneTree_method_get_network_connected_peers: -- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const +- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** |const| Returns the peer IDs of all connected peers of this ``SceneTree``'s :ref:`network_peer`. @@ -546,7 +546,7 @@ Returns the peer IDs of all connected peers of this ``SceneTree``'s :ref:`networ .. _class_SceneTree_method_get_network_unique_id: -- :ref:`int` **get_network_unique_id** **(** **)** const +- :ref:`int` **get_network_unique_id** **(** **)** |const| Returns the unique peer ID of this ``SceneTree``'s :ref:`network_peer`. @@ -554,7 +554,7 @@ Returns the unique peer ID of this ``SceneTree``'s :ref:`network_peer` **get_node_count** **(** **)** const +- :ref:`int` **get_node_count** **(** **)** |const| Returns the number of nodes in this ``SceneTree``. @@ -570,7 +570,7 @@ Returns a list of all nodes assigned to the given group. .. _class_SceneTree_method_get_rpc_sender_id: -- :ref:`int` **get_rpc_sender_id** **(** **)** const +- :ref:`int` **get_rpc_sender_id** **(** **)** |const| Returns the sender's peer ID for the most recently received RPC call. @@ -578,7 +578,7 @@ Returns the sender's peer ID for the most recently received RPC call. .. _class_SceneTree_method_has_group: -- :ref:`bool` **has_group** **(** :ref:`String` name **)** const +- :ref:`bool` **has_group** **(** :ref:`String` name **)** |const| Returns ``true`` if the given group exists. @@ -586,7 +586,7 @@ Returns ``true`` if the given group exists. .. _class_SceneTree_method_has_network_peer: -- :ref:`bool` **has_network_peer** **(** **)** const +- :ref:`bool` **has_network_peer** **(** **)** |const| Returns ``true`` if there is a :ref:`network_peer` set. @@ -602,7 +602,7 @@ Returns ``true`` if the most recent :ref:`InputEvent` was mark .. _class_SceneTree_method_is_network_server: -- :ref:`bool` **is_network_server** **(** **)** const +- :ref:`bool` **is_network_server** **(** **)** |const| Returns ``true`` if this ``SceneTree``'s :ref:`network_peer` is in server mode (listening for connections). @@ -700,3 +700,6 @@ To handle 'Go Back' button when this option is disabled, use :ref:`MainLoop.NOTI Configures screen stretching to the given :ref:`StretchMode`, :ref:`StretchAspect`, minimum size and ``shrink`` ratio. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index ce0eef22c..88afca39d 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -58,3 +58,6 @@ Property Descriptions The time remaining. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_script.rst b/classes/class_script.rst index 76cbbc2ea..9824c88d7 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -38,11 +38,11 @@ Methods ------- +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | +| :ref:`bool` | :ref:`can_instance` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_base_script` **(** **)** const | +| :ref:`Script` | :ref:`get_base_script` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_instance_base_type` **(** **)** const | +| :ref:`String` | :ref:`get_instance_base_type` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_property_default_value` **(** :ref:`String` property **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,13 +54,13 @@ Methods +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_script_signal_list` **(** **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | +| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_source_code` **(** **)** const | +| :ref:`bool` | :ref:`has_source_code` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | +| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tool` **(** **)** const | +| :ref:`bool` | :ref:`is_tool` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ @@ -85,7 +85,7 @@ Method Descriptions .. _class_Script_method_can_instance: -- :ref:`bool` **can_instance** **(** **)** const +- :ref:`bool` **can_instance** **(** **)** |const| Returns ``true`` if the script can be instanced. @@ -93,7 +93,7 @@ Returns ``true`` if the script can be instanced. .. _class_Script_method_get_base_script: -- :ref:`Script` **get_base_script** **(** **)** const +- :ref:`Script` **get_base_script** **(** **)** |const| Returns the script directly inherited by this script. @@ -101,7 +101,7 @@ Returns the script directly inherited by this script. .. _class_Script_method_get_instance_base_type: -- :ref:`String` **get_instance_base_type** **(** **)** const +- :ref:`String` **get_instance_base_type** **(** **)** |const| Returns the script's base type. @@ -149,7 +149,7 @@ Returns the list of user signals defined in this ``Script``. .. _class_Script_method_has_script_signal: -- :ref:`bool` **has_script_signal** **(** :ref:`String` signal_name **)** const +- :ref:`bool` **has_script_signal** **(** :ref:`String` signal_name **)** |const| Returns ``true`` if the script, or a base class, defines a signal with the given name. @@ -157,7 +157,7 @@ Returns ``true`` if the script, or a base class, defines a signal with the given .. _class_Script_method_has_source_code: -- :ref:`bool` **has_source_code** **(** **)** const +- :ref:`bool` **has_source_code** **(** **)** |const| Returns ``true`` if the script contains non-empty source code. @@ -165,7 +165,7 @@ Returns ``true`` if the script contains non-empty source code. .. _class_Script_method_instance_has: -- :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** const +- :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** |const| Returns ``true`` if ``base_object`` is an instance of this script. @@ -173,7 +173,7 @@ Returns ``true`` if ``base_object`` is an instance of this script. .. _class_Script_method_is_tool: -- :ref:`bool` **is_tool** **(** **)** const +- :ref:`bool` **is_tool** **(** **)** |const| Returns ``true`` if the script is a tool script. A tool script can run in the editor. @@ -185,3 +185,6 @@ Returns ``true`` if the script is a tool script. A tool script can run in the ed Reloads the script's class implementation. Returns an error code. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index 248971781..18ab2189c 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -65,3 +65,6 @@ Method Descriptions Prefills required fields to configure the ScriptCreateDialog for use. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 1eb9c475c..b4e038b8a 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -21,21 +21,21 @@ Description Methods ------- -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_drop_data_fw` **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** const | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`drop_data_fw` **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_current_script` **(** **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_drag_data_fw` **(** :ref:`Vector2` point, :ref:`Control` from **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scripts` **(** **)** const | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`goto_line` **(** :ref:`int` line_number **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_script_create_dialog` **(** :ref:`String` base_name, :ref:`String` base_path **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_drop_data_fw` **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`drop_data_fw` **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_current_script` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_drag_data_fw` **(** :ref:`Vector2` point, :ref:`Control` from **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scripts` **(** **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`goto_line` **(** :ref:`int` line_number **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`open_script_create_dialog` **(** :ref:`String` base_name, :ref:`String` base_path **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -59,7 +59,7 @@ Method Descriptions .. _class_ScriptEditor_method_can_drop_data_fw: -- :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** const +- :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** |const| ---- @@ -85,7 +85,7 @@ Returns a :ref:`Script` that is currently active in editor. .. _class_ScriptEditor_method_get_open_scripts: -- :ref:`Array` **get_open_scripts** **(** **)** const +- :ref:`Array` **get_open_scripts** **(** **)** |const| Returns an array with all :ref:`Script` objects which are currently open in editor. @@ -103,3 +103,6 @@ Goes to the specified line in the current script. - void **open_script_create_dialog** **(** :ref:`String` base_name, :ref:`String` base_path **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index b29857c49..96ea71ceb 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -57,3 +57,6 @@ Property Descriptions Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the ``ScrollBar`` is focused. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 80ae7a8e1..f839e1d2c 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -184,3 +184,6 @@ Returns the horizontal scrollbar :ref:`HScrollBar` of this ``S Returns the vertical scrollbar :ref:`VScrollBar` of this ``ScrollContainer``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 979e340ff..2d3fa0af7 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -60,3 +60,6 @@ The segment's first point position. The segment's second point position. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index fb8cceea4..90f56094b 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -49,3 +49,6 @@ Lowers the ``Semaphore``, allowing one more thread in. Returns :ref:`@GlobalScop Tries to wait for the ``Semaphore``, if its value is zero, blocks until non-zero. Returns :ref:`@GlobalScope.OK` on success, :ref:`@GlobalScope.ERR_BUSY` otherwise. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_separator.rst b/classes/class_separator.rst index 6017a7e13..320676f4a 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -20,3 +20,6 @@ Description Separator is a :ref:`Control` used for separating other controls. It's purely a visual decoration. Horizontal (:ref:`HSeparator`) and Vertical (:ref:`VSeparator`) versions are available. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_shader.rst b/classes/class_shader.rst index e254734f5..f6c9b2c1a 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -30,21 +30,21 @@ Tutorials Properties ---------- -+-----------------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`code` | ``""`` | -+-----------------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`custom_defines` | ``"#define MAX_LIGHT_DATA_STRUCTS 409#define MAX_FORWARD_LIGHTS 8#define MAX_REFLECTION_DATA_STRUCTS 455#define MAX_SKELETON_BONES 1365"`` | -+-----------------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------+--------+ +| :ref:`String` | :ref:`code` | ``""`` | ++-----------------------------+-------------------------------------------------------------+--------+ +| :ref:`String` | :ref:`custom_defines` | ``""`` | ++-----------------------------+-------------------------------------------------------------+--------+ Methods ------- +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | +| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`get_mode` **(** **)** const | +| :ref:`Mode` | :ref:`get_mode` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,13 +91,13 @@ Returns the shader's code as the user has written it, not the full generated cod - :ref:`String` **custom_defines** -+-----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| *Default* | ``"#define MAX_LIGHT_DATA_STRUCTS 409#define MAX_FORWARD_LIGHTS 8#define MAX_REFLECTION_DATA_STRUCTS 455#define MAX_SKELETON_BONES 1365"`` | -+-----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| *Setter* | set_custom_defines(value) | -+-----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| *Getter* | get_custom_defines() | -+-----------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------+---------------------------+ +| *Default* | ``""`` | ++-----------+---------------------------+ +| *Setter* | set_custom_defines(value) | ++-----------+---------------------------+ +| *Getter* | get_custom_defines() | ++-----------+---------------------------+ Returns the shader's custom defines. Custom defines can be used in Godot to add GLSL preprocessor directives (e.g: extensions) required for the shader logic. @@ -108,7 +108,7 @@ Method Descriptions .. _class_Shader_method_get_default_texture_param: -- :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const +- :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** |const| Returns the texture that is set as default for the specified parameter. @@ -118,7 +118,7 @@ Returns the texture that is set as default for the specified parameter. .. _class_Shader_method_get_mode: -- :ref:`Mode` **get_mode** **(** **)** const +- :ref:`Mode` **get_mode** **(** **)** |const| Returns the shader mode for the shader, either :ref:`MODE_CANVAS_ITEM`, :ref:`MODE_SPATIAL` or :ref:`MODE_PARTICLES`. @@ -126,7 +126,7 @@ Returns the shader mode for the shader, either :ref:`MODE_CANVAS_ITEM` **has_param** **(** :ref:`String` name **)** const +- :ref:`bool` **has_param** **(** :ref:`String` name **)** |const| Returns ``true`` if the shader has this param defined as a uniform in its code. @@ -142,3 +142,6 @@ Sets the default texture to be used with a texture uniform. The default is used **Note:** ``param`` must match the name of the uniform in the code exactly. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 2403f15d2..0256e4889 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -34,7 +34,7 @@ Methods ------- +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | +| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -63,7 +63,7 @@ Method Descriptions .. _class_ShaderMaterial_method_get_shader_param: -- :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** const +- :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** |const| Returns the current value set for this material of a uniform in the shader. @@ -91,3 +91,6 @@ Returns the default value of the material property with given ``name``. Changes the value set for this material of a uniform in the shader. **Note:** ``param`` must match the name of the uniform in the code exactly. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_shape.rst b/classes/class_shape.rst index e663c41b9..5db420802 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -49,3 +49,6 @@ Property Descriptions The collision margin for the shape. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index d6e0003be..a9cb972c5 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -113,3 +113,6 @@ This method needs the transformation matrix for this shape (``local_xform``), th Draws a solid shape onto a :ref:`CanvasItem` with the :ref:`VisualServer` API filled with the specified ``color``. The exact drawing method is specific for each shape and cannot be configured. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 60c2a252d..fd3aef6bb 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -30,13 +30,13 @@ Properties Methods ------- -+-----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shortcut` **(** :ref:`InputEvent` event **)** const | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_as_text` **(** **)** |const| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shortcut` **(** :ref:`InputEvent` event **)** |const| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** |const| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -60,7 +60,7 @@ Method Descriptions .. _class_ShortCut_method_get_as_text: -- :ref:`String` **get_as_text** **(** **)** const +- :ref:`String` **get_as_text** **(** **)** |const| Returns the shortcut's :ref:`InputEvent` as a :ref:`String`. @@ -68,7 +68,7 @@ Returns the shortcut's :ref:`InputEvent` as a :ref:`String` **is_shortcut** **(** :ref:`InputEvent` event **)** const +- :ref:`bool` **is_shortcut** **(** :ref:`InputEvent` event **)** |const| Returns ``true`` if the shortcut's :ref:`InputEvent` equals ``event``. @@ -76,7 +76,10 @@ Returns ``true`` if the shortcut's :ref:`InputEvent` equals `` .. _class_ShortCut_method_is_valid: -- :ref:`bool` **is_valid** **(** **)** const +- :ref:`bool` **is_valid** **(** **)** |const| If ``true``, this shortcut is valid. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index e154037ab..e38fdee9c 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -34,25 +34,25 @@ Methods +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_bones_global_pose_override` **(** **)** | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_count` **(** **)** const | +| :ref:`int` | :ref:`get_bone_count` **(** **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_custom_pose` **(** :ref:`int` bone_idx **)** const | +| :ref:`Transform` | :ref:`get_bone_custom_pose` **(** :ref:`int` bone_idx **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_global_pose` **(** :ref:`int` bone_idx **)** const | +| :ref:`Transform` | :ref:`get_bone_global_pose` **(** :ref:`int` bone_idx **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** const | +| :ref:`String` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_parent` **(** :ref:`int` bone_idx **)** const | +| :ref:`int` | :ref:`get_bone_parent` **(** :ref:`int` bone_idx **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_pose` **(** :ref:`int` bone_idx **)** const | +| :ref:`Transform` | :ref:`get_bone_pose` **(** :ref:`int` bone_idx **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_rest` **(** :ref:`int` bone_idx **)** const | +| :ref:`Transform` | :ref:`get_bone_rest` **(** :ref:`int` bone_idx **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_bound_child_nodes_to_bone` **(** :ref:`int` bone_idx **)** const | +| :ref:`Array` | :ref:`get_bound_child_nodes_to_bone` **(** :ref:`int` bone_idx **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bone_rest_disabled` **(** :ref:`int` bone_idx **)** const | +| :ref:`bool` | :ref:`is_bone_rest_disabled` **(** :ref:`int` bone_idx **)** |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`localize_rests` **(** **)** | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -125,7 +125,7 @@ Clear all the bones in this skeleton. .. _class_Skeleton_method_find_bone: -- :ref:`int` **find_bone** **(** :ref:`String` name **)** const +- :ref:`int` **find_bone** **(** :ref:`String` name **)** |const| Returns the bone index that matches ``name`` as its name. @@ -133,7 +133,7 @@ Returns the bone index that matches ``name`` as its name. .. _class_Skeleton_method_get_bone_count: -- :ref:`int` **get_bone_count** **(** **)** const +- :ref:`int` **get_bone_count** **(** **)** |const| Returns the amount of bones in the skeleton. @@ -141,7 +141,7 @@ Returns the amount of bones in the skeleton. .. _class_Skeleton_method_get_bone_custom_pose: -- :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** |const| Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. @@ -149,7 +149,7 @@ Returns the custom pose of the specified bone. Custom pose is applied on top of .. _class_Skeleton_method_get_bone_global_pose: -- :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** |const| Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. @@ -157,7 +157,7 @@ Returns the overall transform of the specified bone, with respect to the skeleto .. _class_Skeleton_method_get_bone_name: -- :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const +- :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** |const| Returns the name of the bone at index ``index``. @@ -165,7 +165,7 @@ Returns the name of the bone at index ``index``. .. _class_Skeleton_method_get_bone_parent: -- :ref:`int` **get_bone_parent** **(** :ref:`int` bone_idx **)** const +- :ref:`int` **get_bone_parent** **(** :ref:`int` bone_idx **)** |const| Returns the bone index which is the parent of the bone at ``bone_idx``. If -1, then bone has no parent. @@ -175,7 +175,7 @@ Returns the bone index which is the parent of the bone at ``bone_idx``. If -1, t .. _class_Skeleton_method_get_bone_pose: -- :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** |const| Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. @@ -183,7 +183,7 @@ Returns the pose transform of the specified bone. Pose is applied on top of the .. _class_Skeleton_method_get_bone_rest: -- :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** |const| Returns the rest transform for a bone ``bone_idx``. @@ -191,7 +191,7 @@ Returns the rest transform for a bone ``bone_idx``. .. _class_Skeleton_method_get_bound_child_nodes_to_bone: -- :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const +- :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** |const| *Deprecated soon.* @@ -199,7 +199,7 @@ Returns the rest transform for a bone ``bone_idx``. .. _class_Skeleton_method_is_bone_rest_disabled: -- :ref:`bool` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** const +- :ref:`bool` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** |const| ---- @@ -295,3 +295,6 @@ Sets the rest transform for bone ``bone_idx``. - void **unparent_bone_and_rest** **(** :ref:`int` bone_idx **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index 413ead89d..0d68c1391 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -29,9 +29,9 @@ Methods +-----------------------------+-----------------------------------------------------------------------------------------+ | :ref:`Bone2D` | :ref:`get_bone` **(** :ref:`int` idx **)** | +-----------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_count` **(** **)** const | +| :ref:`int` | :ref:`get_bone_count` **(** **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_skeleton` **(** **)** const | +| :ref:`RID` | :ref:`get_skeleton` **(** **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------+ Signals @@ -54,7 +54,7 @@ Returns a :ref:`Bone2D` from the node hierarchy parented by Skelet .. _class_Skeleton2D_method_get_bone_count: -- :ref:`int` **get_bone_count** **(** **)** const +- :ref:`int` **get_bone_count** **(** **)** |const| Returns the number of :ref:`Bone2D` nodes in the node hierarchy parented by Skeleton2D. @@ -62,7 +62,10 @@ Returns the number of :ref:`Bone2D` nodes in the node hierarchy pa .. _class_Skeleton2D_method_get_skeleton: -- :ref:`RID` **get_skeleton** **(** **)** const +- :ref:`RID` **get_skeleton** **(** **)** |const| Returns the :ref:`RID` of a Skeleton2D instance. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index d80cd8227..209cde896 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -42,7 +42,7 @@ Methods ------- +---------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`Skeleton` | :ref:`get_parent_skeleton` **(** **)** const | +| :ref:`Skeleton` | :ref:`get_parent_skeleton` **(** **)** |const| | +---------------------------------+------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_running` **(** **)** | +---------------------------------+------------------------------------------------------------------------------------------------+ @@ -197,7 +197,7 @@ Method Descriptions .. _class_SkeletonIK_method_get_parent_skeleton: -- :ref:`Skeleton` **get_parent_skeleton** **(** **)** const +- :ref:`Skeleton` **get_parent_skeleton** **(** **)** |const| ---- @@ -217,3 +217,6 @@ Method Descriptions - void **stop** **(** **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_skin.rst b/classes/class_skin.rst index 8e0e47134..5b5aa60df 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -21,13 +21,13 @@ Methods +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_binds` **(** **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bind_bone` **(** :ref:`int` bind_index **)** const | +| :ref:`int` | :ref:`get_bind_bone` **(** :ref:`int` bind_index **)** |const| | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bind_count` **(** **)** const | +| :ref:`int` | :ref:`get_bind_count` **(** **)** |const| | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bind_name` **(** :ref:`int` bind_index **)** const | +| :ref:`String` | :ref:`get_bind_name` **(** :ref:`int` bind_index **)** |const| | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bind_pose` **(** :ref:`int` bind_index **)** const | +| :ref:`Transform` | :ref:`get_bind_pose` **(** :ref:`int` bind_index **)** |const| | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bind_bone` **(** :ref:`int` bind_index, :ref:`int` bone **)** | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,25 +55,25 @@ Method Descriptions .. _class_Skin_method_get_bind_bone: -- :ref:`int` **get_bind_bone** **(** :ref:`int` bind_index **)** const +- :ref:`int` **get_bind_bone** **(** :ref:`int` bind_index **)** |const| ---- .. _class_Skin_method_get_bind_count: -- :ref:`int` **get_bind_count** **(** **)** const +- :ref:`int` **get_bind_count** **(** **)** |const| ---- .. _class_Skin_method_get_bind_name: -- :ref:`String` **get_bind_name** **(** :ref:`int` bind_index **)** const +- :ref:`String` **get_bind_name** **(** :ref:`int` bind_index **)** |const| ---- .. _class_Skin_method_get_bind_pose: -- :ref:`Transform` **get_bind_pose** **(** :ref:`int` bind_index **)** const +- :ref:`Transform` **get_bind_pose** **(** :ref:`int` bind_index **)** |const| ---- @@ -99,3 +99,6 @@ Method Descriptions - void **set_bind_pose** **(** :ref:`int` bind_index, :ref:`Transform` pose **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_skinreference.rst b/classes/class_skinreference.rst index 60550d1ac..9fd1d538b 100644 --- a/classes/class_skinreference.rst +++ b/classes/class_skinreference.rst @@ -16,22 +16,25 @@ SkinReference Methods ------- -+-------------------------+--------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_skeleton` **(** **)** const | -+-------------------------+--------------------------------------------------------------------------------+ -| :ref:`Skin` | :ref:`get_skin` **(** **)** const | -+-------------------------+--------------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_skeleton` **(** **)** |const| | ++-------------------------+----------------------------------------------------------------------------------+ +| :ref:`Skin` | :ref:`get_skin` **(** **)** |const| | ++-------------------------+----------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_SkinReference_method_get_skeleton: -- :ref:`RID` **get_skeleton** **(** **)** const +- :ref:`RID` **get_skeleton** **(** **)** |const| ---- .. _class_SkinReference_method_get_skin: -- :ref:`Skin` **get_skin** **(** **)** const +- :ref:`Skin` **get_skin** **(** **)** |const| +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 42decb22f..134949aa3 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -87,3 +87,6 @@ See :ref:`RadianceSize` constants for values. **Note:** Some hardware will have trouble with higher radiance sizes, especially :ref:`RADIANCE_SIZE_512` and above. Only use such high values on high-end hardware. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 24b9cb9e9..7b20869c6 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -20,6 +20,8 @@ Description Base class for GUI sliders. +**Note:** The :ref:`Range.changed` and :ref:`Range.value_changed` signals are part of the :ref:`Range` class which this class inherits from. + Properties ---------- @@ -102,3 +104,6 @@ Number of ticks displayed on the slider, including border ticks. Ticks are unifo If ``true``, the slider will display ticks for minimum and maximum values. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 70020e1e3..b72cf99ba 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -71,7 +71,7 @@ Methods ------- +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** const | +| :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`float` value **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ @@ -531,7 +531,7 @@ Method Descriptions .. _class_SliderJoint_method_get_param: -- :ref:`float` **get_param** **(** :ref:`Param` param **)** const +- :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| ---- @@ -539,3 +539,6 @@ Method Descriptions - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_softbody.rst b/classes/class_softbody.rst index a3b8f97b4..367499c45 100644 --- a/classes/class_softbody.rst +++ b/classes/class_softbody.rst @@ -62,9 +62,9 @@ Methods +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -106,7 +106,7 @@ The physics layers this SoftBody is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. -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. +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. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -122,7 +122,7 @@ A contact is detected if object A is in any of the layers that object B scans, o | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The physics layers this SoftBody scans for collisions. +The physics layers this SoftBody scans for collisions. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -293,7 +293,7 @@ Returns an array of nodes that were added as collision exceptions for this body. .. _class_SoftBody_method_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the collision mask. @@ -301,7 +301,7 @@ Returns an individual bit on the collision mask. .. _class_SoftBody_method_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the collision mask. @@ -329,3 +329,6 @@ Sets individual bits on the layer mask. Use this if you only need to change one Sets individual bits on the collision mask. Use this if you only need to change one layer's value. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index cc92160fc..c240a6e14 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -56,9 +56,9 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_update_transform` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | +| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | +| :ref:`World` | :ref:`get_world` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -68,15 +68,15 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hide` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scale_disabled` **(** **)** const | +| :ref:`bool` | :ref:`is_scale_disabled` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -110,9 +110,9 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | +| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | +| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`translate` **(** :ref:`Vector3` offset **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -289,7 +289,7 @@ Forces the transform to update. Transform changes in physics are not instant for .. _class_Spatial_method_get_parent_spatial: -- :ref:`Spatial` **get_parent_spatial** **(** **)** const +- :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``. @@ -297,7 +297,7 @@ Returns the parent ``Spatial``, or an empty :ref:`Object` if no pa .. _class_Spatial_method_get_world: -- :ref:`World` **get_world** **(** **)** const +- :ref:`World` **get_world** **(** **)** |const| Returns the current :ref:`World` resource this ``Spatial`` node is registered to. @@ -337,7 +337,7 @@ Disables rendering of this node. Changes :ref:`visible` **is_local_transform_notification_enabled** **(** **)** const +- :ref:`bool` **is_local_transform_notification_enabled** **(** **)** |const| Returns whether node notifies about its local transformation changes. ``Spatial`` will not propagate this by default. @@ -345,7 +345,7 @@ Returns whether node notifies about its local transformation changes. ``Spatial` .. _class_Spatial_method_is_scale_disabled: -- :ref:`bool` **is_scale_disabled** **(** **)** const +- :ref:`bool` **is_scale_disabled** **(** **)** |const| Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformation scale. @@ -353,7 +353,7 @@ Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformat .. _class_Spatial_method_is_set_as_toplevel: -- :ref:`bool` **is_set_as_toplevel** **(** **)** const +- :ref:`bool` **is_set_as_toplevel** **(** **)** |const| Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations. @@ -361,7 +361,7 @@ Returns whether this node is set as Toplevel, that is whether it ignores its par .. _class_Spatial_method_is_transform_notification_enabled: -- :ref:`bool` **is_transform_notification_enabled** **(** **)** const +- :ref:`bool` **is_transform_notification_enabled** **(** **)** |const| Returns whether the node notifies about its global and local transformation changes. ``Spatial`` will not propagate this by default. @@ -369,7 +369,7 @@ Returns whether the node notifies about its global and local transformation chan .. _class_Spatial_method_is_visible_in_tree: -- :ref:`bool` **is_visible_in_tree** **(** **)** const +- :ref:`bool` **is_visible_in_tree** **(** **)** |const| Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree. @@ -509,7 +509,7 @@ Enables rendering of this node. Changes :ref:`visible` **to_global** **(** :ref:`Vector3` local_point **)** const +- :ref:`Vector3` **to_global** **(** :ref:`Vector3` local_point **)** |const| Transforms ``local_point`` from this node's local space to world space. @@ -517,7 +517,7 @@ Transforms ``local_point`` from this node's local space to world space. .. _class_Spatial_method_to_local: -- :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** const +- :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** |const| Transforms ``global_point`` from world space to this node's local space. @@ -547,3 +547,6 @@ Changes the node's position by the given offset :ref:`Vector3` in Updates the :ref:`SpatialGizmo` of this node. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_spatialgizmo.rst b/classes/class_spatialgizmo.rst index 6f00ac6cb..d0613a861 100644 --- a/classes/class_spatialgizmo.rst +++ b/classes/class_spatialgizmo.rst @@ -15,3 +15,6 @@ SpatialGizmo +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 12197180d..81a2067c6 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -234,11 +234,11 @@ Methods ------- +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_feature` **(** :ref:`Feature` feature **)** const | +| :ref:`bool` | :ref:`get_feature` **(** :ref:`Feature` feature **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** const | +| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`TextureParam` param **)** const | +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`TextureParam` param **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_feature` **(** :ref:`Feature` feature, :ref:`bool` enable **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -2214,7 +2214,7 @@ Method Descriptions .. _class_SpatialMaterial_method_get_feature: -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** const +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| Returns ``true``, if the specified :ref:`Feature` is enabled. @@ -2222,7 +2222,7 @@ Returns ``true``, if the specified :ref:`Feature` .. _class_SpatialMaterial_method_get_flag: -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** const +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| Returns ``true``, if the specified flag is enabled. See :ref:`Flags` enumerator for options. @@ -2230,7 +2230,7 @@ Returns ``true``, if the specified flag is enabled. See :ref:`Flags` **get_texture** **(** :ref:`TextureParam` param **)** const +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| Returns the :ref:`Texture` associated with the specified :ref:`TextureParam`. @@ -2258,3 +2258,6 @@ If ``true``, enables the specified flag. Flags are optional behaviour that can b Sets the :ref:`Texture` to be used by the specified :ref:`TextureParam`. This function is called when setting members ending in ``*_texture``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst index b3383609e..00fcf4874 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -24,7 +24,7 @@ Methods ------- +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_tracked_linear_velocity` **(** **)** const | +| :ref:`Vector3` | :ref:`get_tracked_linear_velocity` **(** **)** |const| | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reset` **(** :ref:`Vector3` position **)** | +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ @@ -51,7 +51,7 @@ Method Descriptions .. _class_SpatialVelocityTracker_method_get_tracked_linear_velocity: -- :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const +- :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** |const| ---- @@ -65,3 +65,6 @@ Method Descriptions - void **update_position** **(** :ref:`Vector3` position **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index 37c6e556f..1d2995128 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -116,3 +116,6 @@ Radius of sphere. Number of segments along the height of the sphere. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 9e3e6af81..e498698af 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -42,3 +42,6 @@ Property Descriptions The sphere's radius. The shape's diameter is double the radius. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 32cc43ea6..d3d8cddd4 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -143,3 +143,6 @@ Applies the current value of this ``SpinBox``. Returns the :ref:`LineEdit` instance from this ``SpinBox``. You can use it to access properties and methods of :ref:`LineEdit`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 9c0feee72..3f7121ce2 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -124,3 +124,6 @@ Method Descriptions Clamps the :ref:`split_offset` value to not go outside the currently possible minimal and maximum values. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index 7a719b5ff..2a60c6d12 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -101,3 +101,6 @@ The spotlight's light energy attenuation curve. The maximal range that can be reached by the spotlight. Note that the effectively lit area may appear to be smaller depending on the :ref:`spot_attenuation` in use. No matter the :ref:`spot_attenuation` in use, the light will never reach anything outside this range. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst index 50b8bf62c..5d37d0d9c 100644 --- a/classes/class_springarm.rst +++ b/classes/class_springarm.rst @@ -65,7 +65,7 @@ Property Descriptions | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The layers against which the collision check shall be done. +The layers against which the collision check shall be done. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -154,3 +154,6 @@ Returns the spring arm's current length. Removes the given :ref:`RID` from the list of :ref:`PhysicsBody` objects excluded from the collision check. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index a11f58076..bf6ea63e5 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -52,11 +52,11 @@ Properties Methods ------- -+---------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+---------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pixel_opaque` **(** :ref:`Vector2` pos **)** const | -+---------------------------+-----------------------------------------------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_rect` **(** **)** |const| | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pixel_opaque` **(** :ref:`Vector2` pos **)** |const| | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -287,7 +287,7 @@ Method Descriptions .. _class_Sprite_method_get_rect: -- :ref:`Rect2` **get_rect** **(** **)** const +- :ref:`Rect2` **get_rect** **(** **)** |const| Returns a :ref:`Rect2` representing the Sprite's boundary in local coordinates. Can be used to detect if the Sprite was clicked. Example: @@ -302,9 +302,12 @@ Returns a :ref:`Rect2` representing the Sprite's boundary in local .. _class_Sprite_method_is_pixel_opaque: -- :ref:`bool` **is_pixel_opaque** **(** :ref:`Vector2` pos **)** const +- :ref:`bool` **is_pixel_opaque** **(** :ref:`Vector2` pos **)** |const| Returns ``true``, if the pixel at the given position is opaque and ``false`` in other case. **Note:** It also returns ``false``, if the sprite's texture is ``null`` or if the given position is invalid. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index c9730f7bc..024eab7dd 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -18,8 +18,6 @@ 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. -**Note:** There are `known performance issues `_ when using ``Sprite3D``. Consider using a :ref:`MeshInstance` with a :ref:`QuadMesh` as the mesh instead. You can still have billboarding by enabling billboard properties in the QuadMesh's :ref:`SpatialMaterial`. - Properties ---------- @@ -141,7 +139,7 @@ The region of the atlas texture to display. :ref:`region_enabled` object to draw. +:ref:`Texture` object to draw. If :ref:`GeometryInstance.material_override` is used, this will be overridden. ---- @@ -159,3 +157,6 @@ The region of the atlas texture to display. :ref:`region_enabled` | :ref:`generate_triangle_mesh` **(** **)** const | +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_draw_flag` **(** :ref:`DrawFlags` flag **)** const | +| :ref:`bool` | :ref:`get_draw_flag` **(** :ref:`DrawFlags` flag **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_draw_flag` **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -315,13 +315,13 @@ Method Descriptions .. _class_SpriteBase3D_method_generate_triangle_mesh: -- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const +- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** |const| ---- .. _class_SpriteBase3D_method_get_draw_flag: -- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** const +- :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| Returns the value of the specified flag. @@ -329,7 +329,7 @@ Returns the value of the specified flag. .. _class_SpriteBase3D_method_get_item_rect: -- :ref:`Rect2` **get_item_rect** **(** **)** const +- :ref:`Rect2` **get_item_rect** **(** **)** |const| Returns the rectangle representing this sprite. @@ -341,3 +341,6 @@ Returns the rectangle representing this sprite. If ``true``, the specified flag will be enabled. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 91ff646a2..132f96140 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -18,6 +18,8 @@ Description Sprite frame library for :ref:`AnimatedSprite`. Contains frames and animation data for playback. +**Note:** You can associate a set of normal maps by creating additional ``SpriteFrames`` resources with a ``_normal`` suffix. For example, having 2 ``SpriteFrames`` resources ``run`` and ``run_normal`` will make it so the ``run`` animation uses the normal map. + Properties ---------- @@ -37,17 +39,17 @@ Methods +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_all` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | +| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_animation_names` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_animation_names` **(** **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | +| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | +| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** |const| | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_animation` **(** :ref:`String` anim **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -108,7 +110,7 @@ Removes all animations. A "default" animation will be created. .. _class_SpriteFrames_method_get_animation_loop: -- :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** const +- :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** |const| If ``true``, the given animation will loop. @@ -116,7 +118,7 @@ If ``true``, the given animation will loop. .. _class_SpriteFrames_method_get_animation_names: -- :ref:`PoolStringArray` **get_animation_names** **(** **)** const +- :ref:`PoolStringArray` **get_animation_names** **(** **)** |const| Returns an array containing the names associated to each animation. Values are placed in alphabetical order. @@ -124,7 +126,7 @@ Returns an array containing the names associated to each animation. Values are p .. _class_SpriteFrames_method_get_animation_speed: -- :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const +- :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** |const| The animation's speed in frames per second. @@ -132,7 +134,7 @@ The animation's speed in frames per second. .. _class_SpriteFrames_method_get_frame: -- :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const +- :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** |const| Returns the animation's selected frame. @@ -140,7 +142,7 @@ Returns the animation's selected frame. .. _class_SpriteFrames_method_get_frame_count: -- :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** const +- :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** |const| Returns the number of frames in the animation. @@ -148,7 +150,7 @@ Returns the number of frames in the animation. .. _class_SpriteFrames_method_has_animation: -- :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const +- :ref:`bool` **has_animation** **(** :ref:`String` anim **)** |const| If ``true``, the named animation exists. @@ -200,3 +202,6 @@ The animation's speed in frames per second. Sets the texture of the given frame. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index acbab955d..064414655 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -116,3 +116,6 @@ The physics material override for the body. If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 7e52b7472..af16bae40 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -116,3 +116,6 @@ The physics material override for the body. If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 6c88be169..a82a8bf1e 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -39,7 +39,7 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_8` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_bytes` **(** **)** const | +| :ref:`int` | :ref:`get_available_bytes` **(** **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -148,7 +148,7 @@ Gets a signed byte from the stream. .. _class_StreamPeer_method_get_available_bytes: -- :ref:`int` **get_available_bytes** **(** **)** const +- :ref:`int` **get_available_bytes** **(** **)** |const| Returns the amount of bytes this ``StreamPeer`` has available. @@ -374,3 +374,6 @@ Note: To put an UTF-8 string without prepending its size, you can use :ref:`put_ Puts a Variant into the stream. If ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 53db89987..b275ea269 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -26,11 +26,11 @@ Methods +-------------------------------------------------+--------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | +| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** |const| | +-------------------------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position` **(** **)** const | +| :ref:`int` | :ref:`get_position` **(** **)** |const| | +-------------------------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_size` **(** **)** const | +| :ref:`int` | :ref:`get_size` **(** **)** |const| | +-------------------------------------------------+--------------------------------------------------------------------------------------------+ | void | :ref:`resize` **(** :ref:`int` size **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------+ @@ -63,19 +63,19 @@ Method Descriptions .. _class_StreamPeerBuffer_method_duplicate: -- :ref:`StreamPeerBuffer` **duplicate** **(** **)** const +- :ref:`StreamPeerBuffer` **duplicate** **(** **)** |const| ---- .. _class_StreamPeerBuffer_method_get_position: -- :ref:`int` **get_position** **(** **)** const +- :ref:`int` **get_position** **(** **)** |const| ---- .. _class_StreamPeerBuffer_method_get_size: -- :ref:`int` **get_size** **(** **)** const +- :ref:`int` **get_size** **(** **)** |const| ---- @@ -89,3 +89,6 @@ Method Descriptions - void **seek** **(** :ref:`int` position **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_streampeergdnative.rst b/classes/class_streampeergdnative.rst index 4211aae09..f2baa84dd 100644 --- a/classes/class_streampeergdnative.rst +++ b/classes/class_streampeergdnative.rst @@ -13,3 +13,6 @@ StreamPeerGDNative +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 889eda0f2..ea8ff79ee 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -40,7 +40,7 @@ Methods +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_from_stream` **(** **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** const | +| :ref:`Status` | :ref:`get_status` **(** **)** |const| | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`poll` **(** **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -118,7 +118,7 @@ Disconnects from host. .. _class_StreamPeerSSL_method_get_status: -- :ref:`Status` **get_status** **(** **)** const +- :ref:`Status` **get_status** **(** **)** |const| Returns the status of the connection. See :ref:`Status` for values. @@ -130,3 +130,6 @@ Returns the status of the connection. See :ref:`Status` for it to work properly. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 8f7884f37..a2cafa982 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -26,13 +26,13 @@ Methods +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_from_host` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | +| :ref:`String` | :ref:`get_connected_host` **(** **)** |const| | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connected_port` **(** **)** const | +| :ref:`int` | :ref:`get_connected_port` **(** **)** |const| | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Status` | :ref:`get_status` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | +| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** |const| | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_no_delay` **(** :ref:`bool` enabled **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,7 +81,7 @@ Disconnects from host. .. _class_StreamPeerTCP_method_get_connected_host: -- :ref:`String` **get_connected_host** **(** **)** const +- :ref:`String` **get_connected_host** **(** **)** |const| Returns the IP of this peer. @@ -89,7 +89,7 @@ Returns the IP of this peer. .. _class_StreamPeerTCP_method_get_connected_port: -- :ref:`int` **get_connected_port** **(** **)** const +- :ref:`int` **get_connected_port** **(** **)** |const| Returns the port of this peer. @@ -105,7 +105,7 @@ Returns the status of the connection, see :ref:`Status` **is_connected_to_host** **(** **)** const +- :ref:`bool` **is_connected_to_host** **(** **)** |const| Returns ``true`` if this peer is currently connected to a host, ``false`` otherwise. @@ -119,3 +119,6 @@ Disables Nagle's algorithm to improve latency for small packets. **Note:** For applications that send large packets or need to transfer a lot of data, this can decrease the total available bandwidth. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index 481b08bda..304515f98 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -60,3 +60,6 @@ Method Descriptions Loads the texture from the given path. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_string.rst b/classes/class_string.rst index d0945b6f7..75cca843f 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -1081,3 +1081,6 @@ Returns a copy of the string with special characters escaped using the XML stand Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 461315080..5223e5252 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -37,23 +37,23 @@ Methods ------- +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const | +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_center_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_center_size` **(** **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CanvasItem` | :ref:`get_current_item_drawn` **(** **)** const | +| :ref:`CanvasItem` | :ref:`get_current_item_drawn` **(** **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_margin` **(** :ref:`Margin` margin **)** const | +| :ref:`float` | :ref:`get_default_margin` **(** :ref:`Margin` margin **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`Margin` margin **)** const | +| :ref:`float` | :ref:`get_margin` **(** :ref:`Margin` margin **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | +| :ref:`Vector2` | :ref:`get_offset` **(** **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_margin` **(** :ref:`Margin` margin, :ref:`float` offset **)** | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | +| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** |const| | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions @@ -138,7 +138,7 @@ Method Descriptions .. _class_StyleBox_method_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** |const| Draws this stylebox using a :ref:`CanvasItem` with given :ref:`RID`. @@ -148,7 +148,7 @@ You can get a :ref:`RID` value using :ref:`Object.get_instance_id` **get_center_size** **(** **)** const +- :ref:`Vector2` **get_center_size** **(** **)** |const| Returns the size of this ``StyleBox`` without the margins. @@ -156,7 +156,7 @@ Returns the size of this ``StyleBox`` without the margins. .. _class_StyleBox_method_get_current_item_drawn: -- :ref:`CanvasItem` **get_current_item_drawn** **(** **)** const +- :ref:`CanvasItem` **get_current_item_drawn** **(** **)** |const| Returns the :ref:`CanvasItem` that handles its :ref:`CanvasItem.NOTIFICATION_DRAW` or :ref:`CanvasItem._draw` callback at this moment. @@ -164,7 +164,7 @@ Returns the :ref:`CanvasItem` that handles its :ref:`CanvasIte .. _class_StyleBox_method_get_default_margin: -- :ref:`float` **get_default_margin** **(** :ref:`Margin` margin **)** const +- :ref:`float` **get_default_margin** **(** :ref:`Margin` margin **)** |const| Returns the default value of the specified :ref:`Margin`. @@ -172,7 +172,7 @@ Returns the default value of the specified :ref:`Margin` **get_margin** **(** :ref:`Margin` margin **)** const +- :ref:`float` **get_margin** **(** :ref:`Margin` margin **)** |const| Returns the content margin offset for the specified :ref:`Margin`. @@ -182,7 +182,7 @@ Positive values reduce size inwards, unlike :ref:`Control`'s marg .. _class_StyleBox_method_get_minimum_size: -- :ref:`Vector2` **get_minimum_size** **(** **)** const +- :ref:`Vector2` **get_minimum_size** **(** **)** |const| Returns the minimum size that this stylebox can be shrunk to. @@ -190,7 +190,7 @@ Returns the minimum size that this stylebox can be shrunk to. .. _class_StyleBox_method_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** |const| Returns the "offset" of a stylebox. This helper function returns a value equivalent to ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``. @@ -206,7 +206,10 @@ Sets the default value of the specified :ref:`Margin` .. _class_StyleBox_method_test_mask: -- :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const +- :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** |const| Test a position in a rectangle, return whether it passes the mask test. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index 4865372a2..0df424b31 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -18,3 +18,6 @@ Description Empty stylebox (really does not display anything). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 8a398ff34..f64f5fa20 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -94,13 +94,13 @@ Methods ------- +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_width` **(** :ref:`Margin` margin **)** const | +| :ref:`int` | :ref:`get_border_width` **(** :ref:`Margin` margin **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_width_min` **(** **)** const | +| :ref:`int` | :ref:`get_border_width_min` **(** **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_corner_radius` **(** :ref:`Corner` corner **)** const | +| :ref:`int` | :ref:`get_corner_radius` **(** :ref:`Corner` corner **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin` **(** :ref:`Margin` margin **)** const | +| :ref:`float` | :ref:`get_expand_margin` **(** :ref:`Margin` margin **)** |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_border_width` **(** :ref:`Margin` margin, :ref:`int` width **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -481,7 +481,7 @@ Method Descriptions .. _class_StyleBoxFlat_method_get_border_width: -- :ref:`int` **get_border_width** **(** :ref:`Margin` margin **)** const +- :ref:`int` **get_border_width** **(** :ref:`Margin` margin **)** |const| Returns the given ``margin``'s border width. See :ref:`Margin` for possible values. @@ -489,7 +489,7 @@ Returns the given ``margin``'s border width. See :ref:`Margin` **get_border_width_min** **(** **)** const +- :ref:`int` **get_border_width_min** **(** **)** |const| Returns the smallest border width out of all four borders. @@ -497,7 +497,7 @@ Returns the smallest border width out of all four borders. .. _class_StyleBoxFlat_method_get_corner_radius: -- :ref:`int` **get_corner_radius** **(** :ref:`Corner` corner **)** const +- :ref:`int` **get_corner_radius** **(** :ref:`Corner` corner **)** |const| Returns the given ``corner``'s radius. See :ref:`Corner` for possible values. @@ -505,7 +505,7 @@ Returns the given ``corner``'s radius. See :ref:`Corner` **get_expand_margin** **(** :ref:`Margin` margin **)** const +- :ref:`float` **get_expand_margin** **(** :ref:`Margin` margin **)** |const| Returns the size of the given ``margin``'s expand margin. See :ref:`Margin` for possible values. @@ -573,3 +573,6 @@ Sets the expand margin to ``size`` pixels for all margins. Sets the expand margin for each margin to ``size_left``, ``size_top``, ``size_right``, and ``size_bottom`` pixels. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index a7954c076..b06e4e9cd 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -114,3 +114,6 @@ The line's thickness in pixels. If ``true``, the line will be vertical. If ``false``, the line will be horizontal. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 6f7787dbb..f3ca45bea 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -57,9 +57,9 @@ Methods ------- +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`Margin` margin **)** const | +| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`Margin` margin **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin_size` **(** :ref:`Margin` margin **)** const | +| :ref:`float` | :ref:`get_margin_size` **(** :ref:`Margin` margin **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -360,7 +360,7 @@ Method Descriptions .. _class_StyleBoxTexture_method_get_expand_margin_size: -- :ref:`float` **get_expand_margin_size** **(** :ref:`Margin` margin **)** const +- :ref:`float` **get_expand_margin_size** **(** :ref:`Margin` margin **)** |const| Returns the size of the given ``margin``'s expand margin. See :ref:`Margin` for possible values. @@ -368,7 +368,7 @@ Returns the size of the given ``margin``'s expand margin. See :ref:`Margin` **get_margin_size** **(** :ref:`Margin` margin **)** const +- :ref:`float` **get_margin_size** **(** :ref:`Margin` margin **)** |const| Returns the size of the given ``margin``. See :ref:`Margin` for possible values. @@ -404,3 +404,6 @@ Sets the expand margin to ``size`` pixels for the given ``margin``. See :ref:`Ma Sets the margin to ``size`` pixels for the given ``margin``. See :ref:`Margin` for possible values. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index c01faa6c0..c199a34bd 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -278,3 +278,6 @@ Shrinks the vertex array by creating an index array (avoids reusing vertices). Sets :ref:`Material` to be used by the :ref:`Mesh` you are constructing. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 8bee3c321..92958f8e4 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -43,23 +43,23 @@ Methods ------- +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | +| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Popup` | :ref:`get_popup` **(** **)** const | +| :ref:`Popup` | :ref:`get_popup` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_previous_tab` **(** **)** const | +| :ref:`int` | :ref:`get_previous_tab` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` tab_idx **)** const | +| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` tab_idx **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | +| :ref:`int` | :ref:`get_tab_count` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | +| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_popup` **(** :ref:`Node` popup **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -245,7 +245,7 @@ Method Descriptions .. _class_TabContainer_method_get_current_tab_control: -- :ref:`Control` **get_current_tab_control** **(** **)** const +- :ref:`Control` **get_current_tab_control** **(** **)** |const| Returns the child :ref:`Control` node located at the active tab index. @@ -253,7 +253,7 @@ Returns the child :ref:`Control` node located at the active tab i .. _class_TabContainer_method_get_popup: -- :ref:`Popup` **get_popup** **(** **)** const +- :ref:`Popup` **get_popup** **(** **)** |const| Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. @@ -261,7 +261,7 @@ Returns the :ref:`Popup` node instance if one has been set already .. _class_TabContainer_method_get_previous_tab: -- :ref:`int` **get_previous_tab** **(** **)** const +- :ref:`int` **get_previous_tab** **(** **)** |const| Returns the previously active tab index. @@ -269,7 +269,7 @@ Returns the previously active tab index. .. _class_TabContainer_method_get_tab_control: -- :ref:`Control` **get_tab_control** **(** :ref:`int` tab_idx **)** const +- :ref:`Control` **get_tab_control** **(** :ref:`int` tab_idx **)** |const| Returns the :ref:`Control` node from the tab at index ``tab_idx``. @@ -277,7 +277,7 @@ Returns the :ref:`Control` node from the tab at index ``tab_idx`` .. _class_TabContainer_method_get_tab_count: -- :ref:`int` **get_tab_count** **(** **)** const +- :ref:`int` **get_tab_count** **(** **)** |const| Returns the number of tabs. @@ -285,7 +285,7 @@ Returns the number of tabs. .. _class_TabContainer_method_get_tab_disabled: -- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const +- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** |const| Returns ``true`` if the tab at index ``tab_idx`` is disabled. @@ -293,7 +293,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. _class_TabContainer_method_get_tab_icon: -- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** |const| Returns the :ref:`Texture` for the tab at index ``tab_idx`` or ``null`` if the tab has no :ref:`Texture`. @@ -301,7 +301,7 @@ Returns the :ref:`Texture` for the tab at index ``tab_idx`` or `` .. _class_TabContainer_method_get_tab_title: -- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const +- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** |const| 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`. @@ -309,7 +309,7 @@ Returns the title of the tab at index ``tab_idx``. Tab titles default to the nam .. _class_TabContainer_method_get_tabs_rearrange_group: -- :ref:`int` **get_tabs_rearrange_group** **(** **)** const +- :ref:`int` **get_tabs_rearrange_group** **(** **)** |const| Returns the ``TabContainer`` rearrange group id. @@ -355,3 +355,6 @@ Sets a title for the tab at index ``tab_idx``. Tab titles default to the name of Defines rearrange group id, choose for each ``TabContainer`` the same value to enable tab drag between ``TabContainer``. Enable drag with ``set_drag_to_rearrange_enabled(true)``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 09af531ab..8aa4183fd 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -41,23 +41,23 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** const | +| :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_select_with_rmb` **(** **)** const | +| :ref:`bool` | :ref:`get_select_with_rmb` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | +| :ref:`int` | :ref:`get_tab_count` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_offset` **(** **)** const | +| :ref:`int` | :ref:`get_tab_offset` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | +| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | +| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ @@ -313,7 +313,7 @@ Moves the scroll view to make the tab visible. .. _class_Tabs_method_get_offset_buttons_visible: -- :ref:`bool` **get_offset_buttons_visible** **(** **)** const +- :ref:`bool` **get_offset_buttons_visible** **(** **)** |const| Returns ``true`` if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible. @@ -321,7 +321,7 @@ Returns ``true`` if the offset buttons (the ones that appear when there's not en .. _class_Tabs_method_get_select_with_rmb: -- :ref:`bool` **get_select_with_rmb** **(** **)** const +- :ref:`bool` **get_select_with_rmb** **(** **)** |const| Returns ``true`` if select with right mouse button is enabled. @@ -329,7 +329,7 @@ Returns ``true`` if select with right mouse button is enabled. .. _class_Tabs_method_get_tab_count: -- :ref:`int` **get_tab_count** **(** **)** const +- :ref:`int` **get_tab_count** **(** **)** |const| Returns the number of tabs. @@ -337,7 +337,7 @@ Returns the number of tabs. .. _class_Tabs_method_get_tab_disabled: -- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const +- :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** |const| Returns ``true`` if the tab at index ``tab_idx`` is disabled. @@ -345,7 +345,7 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. _class_Tabs_method_get_tab_icon: -- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** |const| Returns the :ref:`Texture` for the tab at index ``tab_idx`` or ``null`` if the tab has no :ref:`Texture`. @@ -353,7 +353,7 @@ Returns the :ref:`Texture` for the tab at index ``tab_idx`` or `` .. _class_Tabs_method_get_tab_offset: -- :ref:`int` **get_tab_offset** **(** **)** const +- :ref:`int` **get_tab_offset** **(** **)** |const| Returns the number of hidden tabs offsetted to the left. @@ -361,7 +361,7 @@ Returns the number of hidden tabs offsetted to the left. .. _class_Tabs_method_get_tab_rect: -- :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const +- :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** |const| Returns tab :ref:`Rect2` with local position and size. @@ -369,7 +369,7 @@ Returns tab :ref:`Rect2` with local position and size. .. _class_Tabs_method_get_tab_title: -- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const +- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** |const| 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`. @@ -377,7 +377,7 @@ Returns the title of the tab at index ``tab_idx``. Tab titles default to the nam .. _class_Tabs_method_get_tabs_rearrange_group: -- :ref:`int` **get_tabs_rearrange_group** **(** **)** const +- :ref:`int` **get_tabs_rearrange_group** **(** **)** |const| Returns the ``Tabs``' rearrange group ID. @@ -439,3 +439,6 @@ Sets a ``title`` for the tab at index ``tab_idx``. Defines the rearrange group ID. Choose for each ``Tabs`` the same value to dragging tabs between ``Tabs``. Enable drag with ``set_drag_to_rearrange_enabled(true)``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index da510d0fc..64d29738c 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -22,9 +22,9 @@ Methods ------- +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | +| :ref:`bool` | :ref:`is_connection_available` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | +| :ref:`bool` | :ref:`is_listening` **(** **)** |const| | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ @@ -38,7 +38,7 @@ Method Descriptions .. _class_TCP_Server_method_is_connection_available: -- :ref:`bool` **is_connection_available** **(** **)** const +- :ref:`bool` **is_connection_available** **(** **)** |const| Returns ``true`` if a connection is available for taking. @@ -46,7 +46,7 @@ Returns ``true`` if a connection is available for taking. .. _class_TCP_Server_method_is_listening: -- :ref:`bool` **is_listening** **(** **)** const +- :ref:`bool` **is_listening** **(** **)** |const| Returns ``true`` if the server is currently listening for connections. @@ -80,3 +80,6 @@ Stops listening. If a connection is available, returns a StreamPeerTCP with the connection. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index fe4a775d3..96e83ffe0 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -76,6 +76,8 @@ Properties +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`v_scroll_speed` | ``80.0`` | +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`virtual_keyboard_enabled` | ``true`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ | :ref:`bool` | :ref:`wrap_enabled` | ``false`` | +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+ @@ -87,7 +89,7 @@ Methods +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_fold` **(** :ref:`int` line **)** const | +| :ref:`bool` | :ref:`can_fold` **(** :ref:`int` line **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`center_viewport_to_cursor` **(** **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -97,9 +99,9 @@ Methods +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`copy` **(** **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | +| :ref:`int` | :ref:`cursor_get_column` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | +| :ref:`int` | :ref:`cursor_get_line` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -113,37 +115,37 @@ Methods +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fold_line` **(** :ref:`int` line **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_breakpoints` **(** **)** const | +| :ref:`Array` | :ref:`get_breakpoints` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** const | +| :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | +| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | +| :ref:`int` | :ref:`get_line_count` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | +| :ref:`int` | :ref:`get_selection_from_column` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | +| :ref:`int` | :ref:`get_selection_from_line` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selection_text` **(** **)** const | +| :ref:`String` | :ref:`get_selection_text` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | +| :ref:`int` | :ref:`get_selection_to_column` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | +| :ref:`int` | :ref:`get_selection_to_line` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | +| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_keyword_color` **(** :ref:`String` keyword **)** const | +| :ref:`bool` | :ref:`has_keyword_color` **(** :ref:`String` keyword **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_folded` **(** :ref:`int` line **)** const | +| :ref:`bool` | :ref:`is_folded` **(** :ref:`int` line **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_line_hidden` **(** :ref:`int` line **)** const | +| :ref:`bool` | :ref:`is_line_hidden` **(** :ref:`int` line **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | +| :ref:`bool` | :ref:`is_selection_active` **(** **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`menu_option` **(** :ref:`int` option **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -153,7 +155,7 @@ Methods +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_breakpoints` **(** **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | +| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** |const| | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -780,6 +782,22 @@ Vertical scroll sensitivity. ---- +.. _class_TextEdit_property_virtual_keyboard_enabled: + +- :ref:`bool` **virtual_keyboard_enabled** + ++-----------+-------------------------------------+ +| *Default* | ``true`` | ++-----------+-------------------------------------+ +| *Setter* | set_virtual_keyboard_enabled(value) | ++-----------+-------------------------------------+ +| *Getter* | is_virtual_keyboard_enabled() | ++-----------+-------------------------------------+ + +If ``true``, the native virtual keyboard is shown when focused on platforms that support it. + +---- + .. _class_TextEdit_property_wrap_enabled: - :ref:`bool` **wrap_enabled** @@ -815,7 +833,7 @@ Adds a ``keyword`` and its :ref:`Color`. .. _class_TextEdit_method_can_fold: -- :ref:`bool` **can_fold** **(** :ref:`int` line **)** const +- :ref:`bool` **can_fold** **(** :ref:`int` line **)** |const| Returns if the given line is foldable, that is, it has indented lines right below it. @@ -855,7 +873,7 @@ Copy's the current text selection. .. _class_TextEdit_method_cursor_get_column: -- :ref:`int` **cursor_get_column** **(** **)** const +- :ref:`int` **cursor_get_column** **(** **)** |const| Returns the column the editing cursor is at. @@ -863,7 +881,7 @@ Returns the column the editing cursor is at. .. _class_TextEdit_method_cursor_get_line: -- :ref:`int` **cursor_get_line** **(** **)** const +- :ref:`int` **cursor_get_line** **(** **)** |const| Returns the line the editing cursor is at. @@ -925,7 +943,7 @@ Folds the given line, if possible (see :ref:`can_fold` **get_breakpoints** **(** **)** const +- :ref:`Array` **get_breakpoints** **(** **)** |const| Returns an array containing the line number of each breakpoint. @@ -933,7 +951,7 @@ Returns an array containing the line number of each breakpoint. .. _class_TextEdit_method_get_keyword_color: -- :ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** const +- :ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** |const| Returns the :ref:`Color` of the specified ``keyword``. @@ -941,7 +959,7 @@ Returns the :ref:`Color` of the specified ``keyword``. .. _class_TextEdit_method_get_line: -- :ref:`String` **get_line** **(** :ref:`int` line **)** const +- :ref:`String` **get_line** **(** :ref:`int` line **)** |const| Returns the text of a specific line. @@ -949,7 +967,7 @@ Returns the text of a specific line. .. _class_TextEdit_method_get_line_count: -- :ref:`int` **get_line_count** **(** **)** const +- :ref:`int` **get_line_count** **(** **)** |const| Returns the amount of total lines in the text. @@ -957,7 +975,7 @@ Returns the amount of total lines in the text. .. _class_TextEdit_method_get_menu: -- :ref:`PopupMenu` **get_menu** **(** **)** const +- :ref:`PopupMenu` **get_menu** **(** **)** |const| Returns the :ref:`PopupMenu` of this ``TextEdit``. By default, this menu is displayed when right-clicking on the ``TextEdit``. @@ -965,7 +983,7 @@ Returns the :ref:`PopupMenu` of this ``TextEdit``. By default, .. _class_TextEdit_method_get_selection_from_column: -- :ref:`int` **get_selection_from_column** **(** **)** const +- :ref:`int` **get_selection_from_column** **(** **)** |const| Returns the selection begin column. @@ -973,7 +991,7 @@ Returns the selection begin column. .. _class_TextEdit_method_get_selection_from_line: -- :ref:`int` **get_selection_from_line** **(** **)** const +- :ref:`int` **get_selection_from_line** **(** **)** |const| Returns the selection begin line. @@ -981,7 +999,7 @@ Returns the selection begin line. .. _class_TextEdit_method_get_selection_text: -- :ref:`String` **get_selection_text** **(** **)** const +- :ref:`String` **get_selection_text** **(** **)** |const| Returns the text inside the selection. @@ -989,7 +1007,7 @@ Returns the text inside the selection. .. _class_TextEdit_method_get_selection_to_column: -- :ref:`int` **get_selection_to_column** **(** **)** const +- :ref:`int` **get_selection_to_column** **(** **)** |const| Returns the selection end column. @@ -997,7 +1015,7 @@ Returns the selection end column. .. _class_TextEdit_method_get_selection_to_line: -- :ref:`int` **get_selection_to_line** **(** **)** const +- :ref:`int` **get_selection_to_line** **(** **)** |const| Returns the selection end line. @@ -1005,7 +1023,7 @@ Returns the selection end line. .. _class_TextEdit_method_get_word_under_cursor: -- :ref:`String` **get_word_under_cursor** **(** **)** const +- :ref:`String` **get_word_under_cursor** **(** **)** |const| Returns a :ref:`String` text with the word under the mouse cursor location. @@ -1013,7 +1031,7 @@ Returns a :ref:`String` text with the word under the mouse cursor .. _class_TextEdit_method_has_keyword_color: -- :ref:`bool` **has_keyword_color** **(** :ref:`String` keyword **)** const +- :ref:`bool` **has_keyword_color** **(** :ref:`String` keyword **)** |const| Returns whether the specified ``keyword`` has a color set to it or not. @@ -1029,7 +1047,7 @@ Insert the specified text at the cursor position. .. _class_TextEdit_method_is_folded: -- :ref:`bool` **is_folded** **(** :ref:`int` line **)** const +- :ref:`bool` **is_folded** **(** :ref:`int` line **)** |const| Returns whether the line at the specified index is folded or not. @@ -1037,7 +1055,7 @@ Returns whether the line at the specified index is folded or not. .. _class_TextEdit_method_is_line_hidden: -- :ref:`bool` **is_line_hidden** **(** :ref:`int` line **)** const +- :ref:`bool` **is_line_hidden** **(** :ref:`int` line **)** |const| Returns whether the line at the specified index is hidden or not. @@ -1045,7 +1063,7 @@ Returns whether the line at the specified index is hidden or not. .. _class_TextEdit_method_is_selection_active: -- :ref:`bool` **is_selection_active** **(** **)** const +- :ref:`bool` **is_selection_active** **(** **)** |const| Returns ``true`` if the selection is active. @@ -1085,7 +1103,7 @@ Removes all the breakpoints. This will not fire the :ref:`breakpoint_toggled` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const +- :ref:`PoolIntArray` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** |const| Perform a search inside the text. Search flags can be specified in the :ref:`SearchFlags` enum. @@ -1167,3 +1185,6 @@ Unfolds the given line, if folded. Unhide all lines that were previously set to hidden by :ref:`set_line_as_hidden`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_textfile.rst b/classes/class_textfile.rst index 311d8680c..08024ef9e 100644 --- a/classes/class_textfile.rst +++ b/classes/class_textfile.rst @@ -13,3 +13,6 @@ TextFile +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_texture.rst b/classes/class_texture.rst index f4d1d172c..da4e338ad 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -34,23 +34,23 @@ Properties Methods ------- -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :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 **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_data` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_alpha` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :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 **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_data` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_alpha` **(** **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -115,7 +115,7 @@ Method Descriptions .. _class_Texture_method_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** |const| Draws the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API at the specified ``position``. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect` with a rect at ``position`` and the size of this ``Texture``. @@ -123,7 +123,7 @@ Draws the texture using a :ref:`CanvasItem` with the :ref:`Vis .. _class_Texture_method_draw_rect: -- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const +- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** |const| Draws the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect`. @@ -131,7 +131,7 @@ Draws the texture using a :ref:`CanvasItem` with the :ref:`Vis .. _class_Texture_method_draw_rect_region: -- void **draw_rect_region** **(** :ref:`RID` canvas_item, :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 **)** const +- void **draw_rect_region** **(** :ref:`RID` canvas_item, :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 **)** |const| Draws a part of the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect_region`. @@ -139,15 +139,15 @@ Draws a part of the texture using a :ref:`CanvasItem` with the .. _class_Texture_method_get_data: -- :ref:`Image` **get_data** **(** **)** const +- :ref:`Image` **get_data** **(** **)** |const| -Returns an :ref:`Image` with the data from this ``Texture``. :ref:`Image`\ s can be accessed and manipulated directly. +Returns an :ref:`Image` that is a copy of data from this ``Texture``. :ref:`Image`\ s can be accessed and manipulated directly. ---- .. _class_Texture_method_get_height: -- :ref:`int` **get_height** **(** **)** const +- :ref:`int` **get_height** **(** **)** |const| Returns the texture height. @@ -155,7 +155,7 @@ Returns the texture height. .. _class_Texture_method_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** |const| Returns the texture size. @@ -163,7 +163,7 @@ Returns the texture size. .. _class_Texture_method_get_width: -- :ref:`int` **get_width** **(** **)** const +- :ref:`int` **get_width** **(** **)** |const| Returns the texture width. @@ -171,7 +171,10 @@ Returns the texture width. .. _class_Texture_method_has_alpha: -- :ref:`bool` **has_alpha** **(** **)** const +- :ref:`bool` **has_alpha** **(** **)** |const| Returns ``true`` if this ``Texture`` has an alpha channel. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index be5dffa3f..4241c977c 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -25,3 +25,6 @@ Properties | :ref:`Dictionary` | data | ``{"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [ ],"width": 0}`` *(parent override)* | +-------------------------------------+------+----------------------------------------------------------------------------------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_texturearray.rst b/classes/class_texturearray.rst index e10a51b2e..fb4febd38 100644 --- a/classes/class_texturearray.rst +++ b/classes/class_texturearray.rst @@ -18,3 +18,6 @@ Description ``TextureArray``\ s store an array of images in a single :ref:`Texture` primitive. Each layer of the texture array has its own mipmap chain. This makes it is a good alternative to texture atlases. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index f3bd06b3a..faed03d61 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -193,3 +193,6 @@ Texture to display by default, when the node is **not** in the disabled, focused Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the Enter key or if the player presses the :ref:`BaseButton.shortcut` key. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 1439e30cc..977e17227 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -35,15 +35,15 @@ Methods +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_depth` **(** **)** const | +| :ref:`int` | :ref:`get_depth` **(** **)** |const| | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | +| :ref:`Format` | :ref:`get_format` **(** **)** |const| | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | +| :ref:`int` | :ref:`get_height` **(** **)** |const| | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** const | +| :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** |const| | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | +| :ref:`int` | :ref:`get_width` **(** **)** |const| | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_data_partial` **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -115,7 +115,7 @@ Creates the :ref:`Texture3D` or :ref:`TextureArray` **get_depth** **(** **)** const +- :ref:`int` **get_depth** **(** **)** |const| Returns the depth of the texture. Depth is the 3rd dimension (typically Z-axis). @@ -123,7 +123,7 @@ Returns the depth of the texture. Depth is the 3rd dimension (typically Z-axis). .. _class_TextureLayered_method_get_format: -- :ref:`Format` **get_format** **(** **)** const +- :ref:`Format` **get_format** **(** **)** |const| Returns the current format being used by this texture. See :ref:`Format` for details. @@ -131,7 +131,7 @@ Returns the current format being used by this texture. See :ref:`Format` **get_height** **(** **)** const +- :ref:`int` **get_height** **(** **)** |const| Returns the height of the texture. Height is typically represented by the Y-axis. @@ -139,7 +139,7 @@ Returns the height of the texture. Height is typically represented by the Y-axis .. _class_TextureLayered_method_get_layer_data: -- :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** const +- :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** |const| Returns an :ref:`Image` resource with the data from specified ``layer``. @@ -147,7 +147,7 @@ Returns an :ref:`Image` resource with the data from specified ``lay .. _class_TextureLayered_method_get_width: -- :ref:`int` **get_width** **(** **)** const +- :ref:`int` **get_width** **(** **)** |const| Returns the width of the texture. Width is typically represented by the X-axis. @@ -167,3 +167,6 @@ Partially sets the data for a specified ``layer`` by overwriting using the data Sets the data for the specified layer. Data takes the form of a 2-dimensional :ref:`Image` resource. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 01cf92daf..0ad5ced49 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -59,7 +59,7 @@ Methods ------- +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_margin` **(** :ref:`Margin` margin **)** const | +| :ref:`int` | :ref:`get_stretch_margin` **(** :ref:`Margin` margin **)** |const| | +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_stretch_margin` **(** :ref:`Margin` margin, :ref:`int` value **)** | +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -351,7 +351,7 @@ Method Descriptions .. _class_TextureProgress_method_get_stretch_margin: -- :ref:`int` **get_stretch_margin** **(** :ref:`Margin` margin **)** const +- :ref:`int` **get_stretch_margin** **(** :ref:`Margin` margin **)** |const| ---- @@ -359,3 +359,6 @@ Method Descriptions - void **set_stretch_margin** **(** :ref:`Margin` margin, :ref:`int` value **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 319271d32..316cd77df 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -155,3 +155,6 @@ Controls the texture's behavior when resizing the node's bounding rectangle. See The node's :ref:`Texture` resource. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 486837c87..e01fa83fa 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -52,39 +52,39 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`copy_theme` **(** :ref:`Theme` other **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type **)** |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -181,7 +181,7 @@ Sets the theme's values to a copy of a given theme. .. _class_Theme_method_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns the :ref:`Color` at ``name`` if the theme has ``type``. @@ -189,7 +189,7 @@ Returns the :ref:`Color` at ``name`` if the theme has ``type``. .. _class_Theme_method_get_color_list: -- :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** |const| Returns all the :ref:`Color`\ s as a :ref:`PoolStringArray` filled with each :ref:`Color`'s name, for use in :ref:`get_color`, if the theme has ``type``. @@ -197,7 +197,7 @@ Returns all the :ref:`Color`\ s as a :ref:`PoolStringArray` **get_constant** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns the constant at ``name`` if the theme has ``type``. @@ -205,7 +205,7 @@ Returns the constant at ``name`` if the theme has ``type``. .. _class_Theme_method_get_constant_list: -- :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** |const| Returns all the constants as a :ref:`PoolStringArray` filled with each constant's name, for use in :ref:`get_constant`, if the theme has ``type``. @@ -213,7 +213,7 @@ Returns all the constants as a :ref:`PoolStringArray` fil .. _class_Theme_method_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns the :ref:`Font` at ``name`` if the theme has ``type``. @@ -221,7 +221,7 @@ Returns the :ref:`Font` at ``name`` if the theme has ``type``. .. _class_Theme_method_get_font_list: -- :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** |const| Returns all the :ref:`Font`\ s as a :ref:`PoolStringArray` filled with each :ref:`Font`'s name, for use in :ref:`get_font`, if the theme has ``type``. @@ -229,7 +229,7 @@ Returns all the :ref:`Font`\ s as a :ref:`PoolStringArray` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns the icon :ref:`Texture` at ``name`` if the theme has ``type``. @@ -237,7 +237,7 @@ Returns the icon :ref:`Texture` at ``name`` if the theme has ``ty .. _class_Theme_method_get_icon_list: -- :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** |const| Returns all the icons as a :ref:`PoolStringArray` filled with each :ref:`Texture`'s name, for use in :ref:`get_icon`, if the theme has ``type``. @@ -245,7 +245,7 @@ Returns all the icons as a :ref:`PoolStringArray` filled .. _class_Theme_method_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns the icon :ref:`StyleBox` at ``name`` if the theme has ``type``. @@ -253,7 +253,7 @@ Returns the icon :ref:`StyleBox` at ``name`` if the theme has `` .. _class_Theme_method_get_stylebox_list: -- :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** |const| Returns all the :ref:`StyleBox`\ s as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s name, for use in :ref:`get_stylebox`, if the theme has ``type``. @@ -261,7 +261,7 @@ Returns all the :ref:`StyleBox`\ s as a :ref:`PoolStringArray` **get_stylebox_types** **(** **)** const +- :ref:`PoolStringArray` **get_stylebox_types** **(** **)** |const| Returns all the :ref:`StyleBox` types as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s type, for use in :ref:`get_stylebox` and/or :ref:`get_stylebox_list`, if the theme has ``type``. @@ -269,7 +269,7 @@ Returns all the :ref:`StyleBox` types as a :ref:`PoolStringArray .. _class_Theme_method_get_type_list: -- :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** |const| Returns all the types in ``type`` as a :ref:`PoolStringArray` for use in any of the ``get_*`` functions, if the theme has ``type``. @@ -277,7 +277,7 @@ Returns all the types in ``type`` as a :ref:`PoolStringArray` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns ``true`` if :ref:`Color` with ``name`` is in ``type``. @@ -287,7 +287,7 @@ Returns ``false`` if the theme does not have ``type``. .. _class_Theme_method_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns ``true`` if constant with ``name`` is in ``type``. @@ -297,7 +297,7 @@ Returns ``false`` if the theme does not have ``type``. .. _class_Theme_method_has_font: -- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns ``true`` if :ref:`Font` with ``name`` is in ``type``. @@ -307,7 +307,7 @@ Returns ``false`` if the theme does not have ``type``. .. _class_Theme_method_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns ``true`` if icon :ref:`Texture` with ``name`` is in ``type``. @@ -317,7 +317,7 @@ Returns ``false`` if the theme does not have ``type``. .. _class_Theme_method_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** |const| Returns ``true`` if :ref:`StyleBox` with ``name`` is in ``type``. @@ -373,3 +373,6 @@ Sets theme's :ref:`StyleBox` to ``stylebox`` at ``name`` in ``ty Does nothing if the theme does not have ``type``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_thread.rst b/classes/class_thread.rst index d06ded14d..d796fdab7 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -18,6 +18,8 @@ Description A unit of execution in a process. Can run methods on :ref:`Object`\ s simultaneously. The use of synchronization via :ref:`Mutex` or :ref:`Semaphore` is advised if working with shared objects. +**Note:** Breakpoints won't break on code if it's running in a thread. This is a current limitation of the GDScript debugger. + Tutorials --------- @@ -29,9 +31,9 @@ Methods ------- +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_id` **(** **)** const | +| :ref:`String` | :ref:`get_id` **(** **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | +| :ref:`bool` | :ref:`is_active` **(** **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`Priority` priority=1 **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -62,15 +64,15 @@ Method Descriptions .. _class_Thread_method_get_id: -- :ref:`String` **get_id** **(** **)** const +- :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. If the ``Thread`` is not running this returns an empty string. ---- .. _class_Thread_method_is_active: -- :ref:`bool` **is_active** **(** **)** const +- :ref:`bool` **is_active** **(** **)** |const| Returns ``true`` if this ``Thread`` is currently active. An active ``Thread`` cannot start work on a new method but can be joined with :ref:`wait_to_finish`. @@ -92,3 +94,6 @@ Returns :ref:`@GlobalScope.OK` on success, or :r Joins the ``Thread`` and waits for it to finish. Returns what the method called returned. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index d0eed9255..f8c356ca3 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -72,29 +72,29 @@ Methods +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fix_invalid_tiles` **(** **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | +| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_cell_autotile_coord` **(** :ref:`int` x, :ref:`int` y **)** const | +| :ref:`Vector2` | :ref:`get_cell_autotile_coord` **(** :ref:`int` x, :ref:`int` y **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | +| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_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` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** 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_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_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_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 | +| :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 ) **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -110,7 +110,7 @@ Methods +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_dirty_quadrants` **(** **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | +| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -369,7 +369,7 @@ Friction value for static body collisions (see ``collision_use_kinematic``). | *Getter* | get_collision_layer() | +-----------+----------------------------+ -The collision layer(s) for all colliders in the TileMap. +The collision layer(s) for all colliders in the TileMap. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -385,7 +385,7 @@ The collision layer(s) for all colliders in the TileMap. | *Getter* | get_collision_mask() | +-----------+---------------------------+ -The collision mask(s) for all colliders in the TileMap. +The collision mask(s) for all colliders in the TileMap. See `Collision layers and masks `_ in the documentation for more information. ---- @@ -506,7 +506,7 @@ Clears cells that do not exist in the tileset. .. _class_TileMap_method_get_cell: -- :ref:`int` **get_cell** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`int` **get_cell** **(** :ref:`int` x, :ref:`int` y **)** |const| Returns the tile index of the given cell. If no tile exists in the cell, returns :ref:`INVALID_CELL`. @@ -514,7 +514,7 @@ Returns the tile index of the given cell. If no tile exists in the cell, returns .. _class_TileMap_method_get_cell_autotile_coord: -- :ref:`Vector2` **get_cell_autotile_coord** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`Vector2` **get_cell_autotile_coord** **(** :ref:`int` x, :ref:`int` y **)** |const| Returns the coordinate (subtile column and row) of the autotile variation in the tileset. Returns a zero vector if the cell doesn't have autotiling. @@ -522,7 +522,7 @@ Returns the coordinate (subtile column and row) of the autotile variation in the .. _class_TileMap_method_get_cellv: -- :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const +- :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** |const| Returns the tile index of the cell given by a Vector2. If no tile exists in the cell, returns :ref:`INVALID_CELL`. @@ -530,7 +530,7 @@ Returns the tile index of the cell given by a Vector2. If no tile exists in the .. _class_TileMap_method_get_collision_layer_bit: -- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns ``true`` if the given collision layer bit is set. @@ -538,7 +538,7 @@ Returns ``true`` if the given collision layer bit is set. .. _class_TileMap_method_get_collision_mask_bit: -- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns ``true`` if the given collision mask bit is set. @@ -546,7 +546,7 @@ Returns ``true`` if the given collision mask bit is set. .. _class_TileMap_method_get_used_cells: -- :ref:`Array` **get_used_cells** **(** **)** const +- :ref:`Array` **get_used_cells** **(** **)** |const| Returns a :ref:`Vector2` array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from ``-1``). @@ -554,7 +554,7 @@ Returns a :ref:`Vector2` array with the positions of all cells co .. _class_TileMap_method_get_used_cells_by_id: -- :ref:`Array` **get_used_cells_by_id** **(** :ref:`int` id **)** const +- :ref:`Array` **get_used_cells_by_id** **(** :ref:`int` id **)** |const| Returns an array of all cells with the given tile index specified in ``id``. @@ -570,7 +570,7 @@ Returns a rectangle enclosing the used (non-empty) tiles of the map. .. _class_TileMap_method_is_cell_transposed: -- :ref:`bool` **is_cell_transposed** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`bool` **is_cell_transposed** **(** :ref:`int` x, :ref:`int` y **)** |const| Returns ``true`` if the given cell is transposed, i.e. the X and Y axes are swapped. @@ -578,7 +578,7 @@ Returns ``true`` if the given cell is transposed, i.e. the X and Y axes are swap .. _class_TileMap_method_is_cell_x_flipped: -- :ref:`bool` **is_cell_x_flipped** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`bool` **is_cell_x_flipped** **(** :ref:`int` x, :ref:`int` y **)** |const| Returns ``true`` if the given cell is flipped in the X axis. @@ -586,7 +586,7 @@ Returns ``true`` if the given cell is flipped in the X axis. .. _class_TileMap_method_is_cell_y_flipped: -- :ref:`bool` **is_cell_y_flipped** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`bool` **is_cell_y_flipped** **(** :ref:`int` x, :ref:`int` y **)** |const| Returns ``true`` if the given cell is flipped in the Y axis. @@ -594,7 +594,7 @@ Returns ``true`` if the given cell is flipped in the Y axis. .. _class_TileMap_method_map_to_world: -- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const +- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** |const| Returns the global position corresponding to the given tilemap (grid-based) coordinates. @@ -620,7 +620,7 @@ Overriding this method also overrides it internally, allowing custom logic to be :: - func set_cell(x, y, tile, flip_x, flip_y, transpose, autotile_coord) + func set_cell(x, y, tile, flip_x=false, flip_y=false, transpose=false, autotile_coord=Vector2()) # Write your custom logic here. # To call the default method: .set_cell(x, y, tile, flip_x, flip_y, transpose, autotile_coord) @@ -687,7 +687,10 @@ Updates the tile map's quadrants, allowing things such as navigation and collisi .. _class_TileMap_method_world_to_map: -- :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const +- :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** |const| Returns the tilemap (grid-based) coordinates corresponding to the given local position. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index a64afa883..a9f691737 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -24,27 +24,27 @@ Methods ------- +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`_forward_atlas_subtile_selection` **(** :ref:`int` atlastile_id, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual | +| :ref:`Vector2` | :ref:`_forward_atlas_subtile_selection` **(** :ref:`int` atlastile_id, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`_forward_subtile_selection` **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual | +| :ref:`Vector2` | :ref:`_forward_subtile_selection` **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_is_tile_bound` **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** virtual | +| :ref:`bool` | :ref:`_is_tile_bound` **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_clear_bitmask_map` **(** :ref:`int` id **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`autotile_get_bitmask` **(** :ref:`int` id, :ref:`Vector2` coord **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BitmaskMode` | :ref:`autotile_get_bitmask_mode` **(** :ref:`int` id **)** const | +| :ref:`BitmaskMode` | :ref:`autotile_get_bitmask_mode` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`autotile_get_icon_coordinate` **(** :ref:`int` id **)** const | +| :ref:`Vector2` | :ref:`autotile_get_icon_coordinate` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`autotile_get_light_occluder` **(** :ref:`int` id, :ref:`Vector2` coord **)** const | +| :ref:`OccluderPolygon2D` | :ref:`autotile_get_light_occluder` **(** :ref:`int` id, :ref:`Vector2` coord **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`autotile_get_navigation_polygon` **(** :ref:`int` id, :ref:`Vector2` coord **)** const | +| :ref:`NavigationPolygon` | :ref:`autotile_get_navigation_polygon` **(** :ref:`int` id, :ref:`Vector2` coord **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`autotile_get_size` **(** :ref:`int` id **)** const | +| :ref:`Vector2` | :ref:`autotile_get_size` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`autotile_get_spacing` **(** :ref:`int` id **)** const | +| :ref:`int` | :ref:`autotile_get_spacing` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`autotile_get_subtile_priority` **(** :ref:`int` id, :ref:`Vector2` coord **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,55 +72,55 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_tile` **(** :ref:`int` id **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | +| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** 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:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | +| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tile_get_modulate` **(** :ref:`int` id **)** const | +| :ref:`Color` | :ref:`tile_get_modulate` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tile_get_name` **(** :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:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :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:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :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:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_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:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_shape_offset` **(** :ref:`int` id, :ref:`int` shape_id **)** const | +| :ref:`Vector2` | :ref:`tile_get_shape_offset` **(** :ref:`int` id, :ref:`int` shape_id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | +| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tile_get_shape_one_way_margin` **(** :ref:`int` id, :ref:`int` shape_id **)** const | +| :ref:`float` | :ref:`tile_get_shape_one_way_margin` **(** :ref:`int` id, :ref:`int` shape_id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :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:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :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 | +| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TileMode` | :ref:`tile_get_tile_mode` **(** :ref:`int` id **)** const | +| :ref:`TileMode` | :ref:`tile_get_tile_mode` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tile_get_z_index` **(** :ref:`int` id **)** const | +| :ref:`int` | :ref:`tile_get_z_index` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -245,19 +245,19 @@ Method Descriptions .. _class_TileSet_method__forward_atlas_subtile_selection: -- :ref:`Vector2` **_forward_atlas_subtile_selection** **(** :ref:`int` atlastile_id, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual +- :ref:`Vector2` **_forward_atlas_subtile_selection** **(** :ref:`int` atlastile_id, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** |virtual| ---- .. _class_TileSet_method__forward_subtile_selection: -- :ref:`Vector2` **_forward_subtile_selection** **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual +- :ref:`Vector2` **_forward_subtile_selection** **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** |virtual| ---- .. _class_TileSet_method__is_tile_bound: -- :ref:`bool` **_is_tile_bound** **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** virtual +- :ref:`bool` **_is_tile_bound** **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** |virtual| Determines when the auto-tiler should consider two different auto-tile IDs to be bound together. @@ -285,7 +285,7 @@ The value is the sum of the values in :ref:`AutotileBindings` **autotile_get_bitmask_mode** **(** :ref:`int` id **)** const +- :ref:`BitmaskMode` **autotile_get_bitmask_mode** **(** :ref:`int` id **)** |const| Returns the :ref:`BitmaskMode` of the autotile. @@ -293,7 +293,7 @@ Returns the :ref:`BitmaskMode` of the autotile. .. _class_TileSet_method_autotile_get_icon_coordinate: -- :ref:`Vector2` **autotile_get_icon_coordinate** **(** :ref:`int` id **)** const +- :ref:`Vector2` **autotile_get_icon_coordinate** **(** :ref:`int` id **)** |const| Returns the subtile that's being used as an icon in an atlas/autotile given its coordinates. @@ -303,7 +303,7 @@ The subtile defined as the icon will be used as a fallback when the atlas/autoti .. _class_TileSet_method_autotile_get_light_occluder: -- :ref:`OccluderPolygon2D` **autotile_get_light_occluder** **(** :ref:`int` id, :ref:`Vector2` coord **)** const +- :ref:`OccluderPolygon2D` **autotile_get_light_occluder** **(** :ref:`int` id, :ref:`Vector2` coord **)** |const| Returns the light occluder of the subtile from an atlas/autotile given its coordinates. @@ -311,7 +311,7 @@ Returns the light occluder of the subtile from an atlas/autotile given its coord .. _class_TileSet_method_autotile_get_navigation_polygon: -- :ref:`NavigationPolygon` **autotile_get_navigation_polygon** **(** :ref:`int` id, :ref:`Vector2` coord **)** const +- :ref:`NavigationPolygon` **autotile_get_navigation_polygon** **(** :ref:`int` id, :ref:`Vector2` coord **)** |const| Returns the navigation polygon of the subtile from an atlas/autotile given its coordinates. @@ -319,7 +319,7 @@ Returns the navigation polygon of the subtile from an atlas/autotile given its c .. _class_TileSet_method_autotile_get_size: -- :ref:`Vector2` **autotile_get_size** **(** :ref:`int` id **)** const +- :ref:`Vector2` **autotile_get_size** **(** :ref:`int` id **)** |const| Returns the size of the subtiles in an atlas/autotile. @@ -327,7 +327,7 @@ Returns the size of the subtiles in an atlas/autotile. .. _class_TileSet_method_autotile_get_spacing: -- :ref:`int` **autotile_get_spacing** **(** :ref:`int` id **)** const +- :ref:`int` **autotile_get_spacing** **(** :ref:`int` id **)** |const| Returns the spacing between subtiles of the atlas/autotile. @@ -447,7 +447,7 @@ Creates a new tile with the given ID. .. _class_TileSet_method_find_tile_by_name: -- :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** const +- :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** |const| Returns the first tile matching the given name. @@ -455,7 +455,7 @@ Returns the first tile matching the given name. .. _class_TileSet_method_get_last_unused_tile_id: -- :ref:`int` **get_last_unused_tile_id** **(** **)** const +- :ref:`int` **get_last_unused_tile_id** **(** **)** |const| Returns the ID following the last currently used ID, useful when creating a new tile. @@ -463,7 +463,7 @@ Returns the ID following the last currently used ID, useful when creating a new .. _class_TileSet_method_get_tiles_ids: -- :ref:`Array` **get_tiles_ids** **(** **)** const +- :ref:`Array` **get_tiles_ids** **(** **)** |const| Returns an array of all currently used tile IDs. @@ -487,7 +487,7 @@ Adds a shape to the tile. .. _class_TileSet_method_tile_get_light_occluder: -- :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const +- :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** |const| Returns the tile's light occluder. @@ -495,7 +495,7 @@ Returns the tile's light occluder. .. _class_TileSet_method_tile_get_material: -- :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const +- :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** |const| Returns the tile's material. @@ -503,7 +503,7 @@ Returns the tile's material. .. _class_TileSet_method_tile_get_modulate: -- :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** const +- :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** |const| Returns the tile's modulation color. @@ -511,7 +511,7 @@ Returns the tile's modulation color. .. _class_TileSet_method_tile_get_name: -- :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const +- :ref:`String` **tile_get_name** **(** :ref:`int` id **)** |const| Returns the tile's name. @@ -519,7 +519,7 @@ Returns the tile's name. .. _class_TileSet_method_tile_get_navigation_polygon: -- :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** const +- :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** |const| Returns the navigation polygon of the tile. @@ -527,7 +527,7 @@ Returns the navigation polygon of the tile. .. _class_TileSet_method_tile_get_navigation_polygon_offset: -- :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** const +- :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** |const| Returns the offset of the tile's navigation polygon. @@ -535,7 +535,7 @@ Returns the offset of the tile's navigation polygon. .. _class_TileSet_method_tile_get_normal_map: -- :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const +- :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** |const| Returns the tile's normal map texture. @@ -543,7 +543,7 @@ Returns the tile's normal map texture. .. _class_TileSet_method_tile_get_occluder_offset: -- :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const +- :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** |const| Returns the offset of the tile's light occluder. @@ -551,7 +551,7 @@ Returns the offset of the tile's light occluder. .. _class_TileSet_method_tile_get_region: -- :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** const +- :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** |const| Returns the tile sub-region in the texture. @@ -559,7 +559,7 @@ Returns the tile sub-region in the texture. .. _class_TileSet_method_tile_get_shape: -- :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| Returns a tile's given shape. @@ -567,7 +567,7 @@ Returns a tile's given shape. .. _class_TileSet_method_tile_get_shape_count: -- :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** const +- :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** |const| Returns the number of shapes assigned to a tile. @@ -575,7 +575,7 @@ Returns the number of shapes assigned to a tile. .. _class_TileSet_method_tile_get_shape_offset: -- :ref:`Vector2` **tile_get_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`Vector2` **tile_get_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| Returns the offset of a tile's shape. @@ -583,7 +583,7 @@ Returns the offset of a tile's shape. .. _class_TileSet_method_tile_get_shape_one_way: -- :ref:`bool` **tile_get_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`bool` **tile_get_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| Returns the one-way collision value of a tile's shape. @@ -591,13 +591,13 @@ Returns the one-way collision value of a tile's shape. .. _class_TileSet_method_tile_get_shape_one_way_margin: -- :ref:`float` **tile_get_shape_one_way_margin** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`float` **tile_get_shape_one_way_margin** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| ---- .. _class_TileSet_method_tile_get_shape_transform: -- :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** |const| Returns the :ref:`Transform2D` of a tile's shape. @@ -605,7 +605,7 @@ Returns the :ref:`Transform2D` of a tile's shape. .. _class_TileSet_method_tile_get_shapes: -- :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const +- :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** |const| Returns an array of dictionaries describing the tile's shapes. @@ -625,7 +625,7 @@ Returns an array of dictionaries describing the tile's shapes. .. _class_TileSet_method_tile_get_texture: -- :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const +- :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** |const| Returns the tile's texture. @@ -633,7 +633,7 @@ Returns the tile's texture. .. _class_TileSet_method_tile_get_texture_offset: -- :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** const +- :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** |const| Returns the texture offset of the tile. @@ -641,7 +641,7 @@ Returns the texture offset of the tile. .. _class_TileSet_method_tile_get_tile_mode: -- :ref:`TileMode` **tile_get_tile_mode** **(** :ref:`int` id **)** const +- :ref:`TileMode` **tile_get_tile_mode** **(** :ref:`int` id **)** |const| Returns the tile's :ref:`TileMode`. @@ -649,7 +649,7 @@ Returns the tile's :ref:`TileMode`. .. _class_TileSet_method_tile_get_z_index: -- :ref:`int` **tile_get_z_index** **(** :ref:`int` id **)** const +- :ref:`int` **tile_get_z_index** **(** :ref:`int` id **)** |const| Returns the tile's Z index (drawing layer). @@ -805,3 +805,6 @@ Sets the tile's :ref:`TileMode`. Sets the tile's drawing index. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 172083773..063b7624a 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -41,7 +41,7 @@ Methods ------- +-------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stopped` **(** **)** const | +| :ref:`bool` | :ref:`is_stopped` **(** **)** |const| | +-------------------------+------------------------------------------------------------------------------------------+ | void | :ref:`start` **(** :ref:`float` time_sec=-1 **)** | +-------------------------+------------------------------------------------------------------------------------------+ @@ -172,7 +172,7 @@ Method Descriptions .. _class_Timer_method_is_stopped: -- :ref:`bool` **is_stopped** **(** **)** const +- :ref:`bool` **is_stopped** **(** **)** |const| Returns ``true`` if the timer is stopped. @@ -194,3 +194,6 @@ Starts the timer. Sets ``wait_time`` to ``time_sec`` if ``time_sec > 0``. This a Stops the timer. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index 37322e704..341cdc099 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -57,3 +57,6 @@ Theme Properties | :ref:`StyleBox` | pressed | | +---------------------------------+---------------------+------------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 1e5c6c5fb..89047f012 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -11,12 +11,16 @@ TouchScreenButton **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -Button for touch screen devices. +Button for touch screen devices for gameplay use. Description ----------- -Button for touch screen devices. You can set it to be visible on all screens, or only on touch devices. +TouchScreenButton allows you to create on-screen buttons for touch devices. It's intended for gameplay use, such as a unit you have to touch to move. + +This node inherits from :ref:`Node2D`. Unlike with :ref:`Control` nodes, you cannot set anchors on it. If you want to create menus or user interfaces, you may want to use :ref:`Button` nodes instead. To make button nodes react to touch events, you can enable the Emulate Mouse option in the Project Settings. + +You can configure TouchScreenButton to be visible only on touch devices, helping you develop your game both for desktop and mobile devices. Properties ---------- @@ -44,9 +48,9 @@ Properties Methods ------- -+-------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+-------------------------+--------------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** |const| | ++-------------------------+----------------------------------------------------------------------------------+ Signals ------- @@ -222,7 +226,10 @@ Method Descriptions .. _class_TouchScreenButton_method_is_pressed: -- :ref:`bool` **is_pressed** **(** **)** const +- :ref:`bool` **is_pressed** **(** **)** |const| Returns ``true`` if this button is currently pressed. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_transform.rst b/classes/class_transform.rst index cc5c71ad6..70067e143 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -244,3 +244,6 @@ Transforms the given :ref:`Vector3`, :ref:`Plane`, : Inverse-transforms the given :ref:`Vector3`, :ref:`Plane`, :ref:`AABB`, or :ref:`PoolVector3Array` by this transform. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 2103efd7d..47c0e49c8 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -274,3 +274,6 @@ Transforms the given :ref:`Vector2`, :ref:`Rect2`, o Inverse-transforms the given :ref:`Vector2`, :ref:`Rect2`, or :ref:`PoolVector2Array` by this transform. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 839c98d9e..896303b9c 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -42,11 +42,11 @@ Methods +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_message` **(** :ref:`String` src_message **)** | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | +| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_message_count` **(** **)** const | +| :ref:`int` | :ref:`get_message_count` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** |const| | +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions @@ -87,7 +87,7 @@ Erases a message. .. _class_Translation_method_get_message: -- :ref:`String` **get_message** **(** :ref:`String` src_message **)** const +- :ref:`String` **get_message** **(** :ref:`String` src_message **)** |const| Returns a message's translation. @@ -95,7 +95,7 @@ Returns a message's translation. .. _class_Translation_method_get_message_count: -- :ref:`int` **get_message_count** **(** **)** const +- :ref:`int` **get_message_count** **(** **)** |const| Returns the number of existing messages. @@ -103,7 +103,10 @@ Returns the number of existing messages. .. _class_Translation_method_get_message_list: -- :ref:`PoolStringArray` **get_message_list** **(** **)** const +- :ref:`PoolStringArray` **get_message_list** **(** **)** |const| Returns all the messages (keys). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index ed61311b6..176d260a0 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -33,17 +33,17 @@ Methods +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_loaded_locales` **(** **)** const | +| :ref:`Array` | :ref:`get_loaded_locales` **(** **)** |const| | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | +| :ref:`String` | :ref:`get_locale` **(** **)** |const| | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale_name` **(** :ref:`String` locale **)** const | +| :ref:`String` | :ref:`get_locale_name` **(** :ref:`String` locale **)** |const| | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_translation` **(** :ref:`Translation` translation **)** | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_locale` **(** :ref:`String` locale **)** | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`translate` **(** :ref:`String` message **)** const | +| :ref:`String` | :ref:`translate` **(** :ref:`String` message **)** |const| | +-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions @@ -67,7 +67,7 @@ Clears the server from all translations. .. _class_TranslationServer_method_get_loaded_locales: -- :ref:`Array` **get_loaded_locales** **(** **)** const +- :ref:`Array` **get_loaded_locales** **(** **)** |const| Returns an Array of all loaded locales of the game. @@ -75,7 +75,7 @@ Returns an Array of all loaded locales of the game. .. _class_TranslationServer_method_get_locale: -- :ref:`String` **get_locale** **(** **)** const +- :ref:`String` **get_locale** **(** **)** |const| Returns the current locale of the game. @@ -83,7 +83,7 @@ Returns the current locale of the game. .. _class_TranslationServer_method_get_locale_name: -- :ref:`String` **get_locale_name** **(** :ref:`String` locale **)** const +- :ref:`String` **get_locale_name** **(** :ref:`String` locale **)** |const| Returns a locale's language and its variant (e.g. ``"en_US"`` would return ``"English (United States)"``). @@ -107,7 +107,10 @@ Sets the locale of the game. .. _class_TranslationServer_method_translate: -- :ref:`String` **translate** **(** :ref:`String` message **)** const +- :ref:`String` **translate** **(** :ref:`String` message **)** |const| Returns the current locale's translation for the given message (key). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 8811b7eb4..d88d04db0 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -59,53 +59,53 @@ Properties Methods ------- -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_column_titles_visible` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`create_item` **(** :ref:`Object` parent=null, :ref:`int` idx=-1 **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_cursor_is_visible` **(** **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edited_column` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=-1 **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pressed_button` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_root` **(** **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_selected` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected_column` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_min_width` **(** :ref:`int` column, :ref:`int` min_width **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_titles_visible` **(** :ref:`bool` visible **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_column_titles_visible` **(** **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`create_item` **(** :ref:`Object` parent=null, :ref:`int` idx=-1 **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_cursor_is_visible` **(** **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_edited` **(** **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edited_column` **(** **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=-1 **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pressed_button` **(** **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_root` **(** **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scroll` **(** **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_selected` **(** **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selected_column` **(** **)** |const| | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_min_width` **(** :ref:`int` column, :ref:`int` min_width **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_titles_visible` **(** :ref:`bool` visible **)** | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- @@ -482,7 +482,7 @@ Method Descriptions .. _class_Tree_method_are_column_titles_visible: -- :ref:`bool` **are_column_titles_visible** **(** **)** const +- :ref:`bool` **are_column_titles_visible** **(** **)** |const| Returns ``true`` if the column titles are being shown. @@ -522,7 +522,7 @@ This will scroll the tree if necessary. In :ref:`SELECT_ROW` **get_column_at_position** **(** :ref:`Vector2` position **)** const +- :ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** |const| Returns the column index at ``position``, or -1 if no item is there. @@ -530,7 +530,7 @@ Returns the column index at ``position``, or -1 if no item is there. .. _class_Tree_method_get_column_title: -- :ref:`String` **get_column_title** **(** :ref:`int` column **)** const +- :ref:`String` **get_column_title** **(** :ref:`int` column **)** |const| Returns the column's title. @@ -538,7 +538,7 @@ Returns the column's title. .. _class_Tree_method_get_column_width: -- :ref:`int` **get_column_width** **(** :ref:`int` column **)** const +- :ref:`int` **get_column_width** **(** :ref:`int` column **)** |const| Returns the column's width in pixels. @@ -546,7 +546,7 @@ Returns the column's width in pixels. .. _class_Tree_method_get_custom_popup_rect: -- :ref:`Rect2` **get_custom_popup_rect** **(** **)** const +- :ref:`Rect2` **get_custom_popup_rect** **(** **)** |const| Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See :ref:`TreeItem.set_cell_mode`. @@ -554,7 +554,7 @@ Returns the rectangle for custom popups. Helper to create custom cell controls t .. _class_Tree_method_get_drop_section_at_position: -- :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const +- :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** |const| Returns the drop section at ``position``, or -100 if no item is there. @@ -566,7 +566,7 @@ To get the item which the returned drop section is relative to, use :ref:`get_it .. _class_Tree_method_get_edited: -- :ref:`TreeItem` **get_edited** **(** **)** const +- :ref:`TreeItem` **get_edited** **(** **)** |const| Returns the currently edited item. This is only available for custom cell mode. @@ -574,7 +574,7 @@ Returns the currently edited item. This is only available for custom cell mode. .. _class_Tree_method_get_edited_column: -- :ref:`int` **get_edited_column** **(** **)** const +- :ref:`int` **get_edited_column** **(** **)** |const| Returns the column for the currently edited item. This is only available for custom cell mode. @@ -582,7 +582,7 @@ Returns the column for the currently edited item. This is only available for cus .. _class_Tree_method_get_item_area_rect: -- :ref:`Rect2` **get_item_area_rect** **(** :ref:`Object` item, :ref:`int` column=-1 **)** const +- :ref:`Rect2` **get_item_area_rect** **(** :ref:`Object` item, :ref:`int` column=-1 **)** |const| Returns the rectangle area for the specified item. If ``column`` is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. @@ -590,7 +590,7 @@ Returns the rectangle area for the specified item. If ``column`` is specified, o .. _class_Tree_method_get_item_at_position: -- :ref:`TreeItem` **get_item_at_position** **(** :ref:`Vector2` position **)** const +- :ref:`TreeItem` **get_item_at_position** **(** :ref:`Vector2` position **)** |const| Returns the tree item at the specified position (relative to the tree origin position). @@ -608,7 +608,7 @@ If ``from`` is ``null``, this returns the first selected item. .. _class_Tree_method_get_pressed_button: -- :ref:`int` **get_pressed_button** **(** **)** const +- :ref:`int` **get_pressed_button** **(** **)** |const| Returns the last pressed button's index. @@ -624,7 +624,7 @@ Returns the tree's root item, or ``null`` if the tree is empty. .. _class_Tree_method_get_scroll: -- :ref:`Vector2` **get_scroll** **(** **)** const +- :ref:`Vector2` **get_scroll** **(** **)** |const| Returns the current scrolling position. @@ -632,7 +632,7 @@ Returns the current scrolling position. .. _class_Tree_method_get_selected: -- :ref:`TreeItem` **get_selected** **(** **)** const +- :ref:`TreeItem` **get_selected** **(** **)** |const| Returns the currently focused item, or ``null`` if no item is focused. @@ -644,7 +644,7 @@ To get the currently selected item(s), use :ref:`get_next_selected` **get_selected_column** **(** **)** const +- :ref:`int` **get_selected_column** **(** **)** |const| Returns the currently focused column, or -1 if no column is focused. @@ -684,3 +684,6 @@ Sets the title of a column. If ``true``, column titles are visible. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 801c8fd11..e1887ea75 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -37,7 +37,7 @@ Methods +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_recursive` **(** :ref:`String` method, ... **)** vararg | +| :ref:`Variant` | :ref:`call_recursive` **(** :ref:`String` method, ... **)** |vararg| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,31 +47,31 @@ Methods +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | +| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | +| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_button_tooltip` **(** :ref:`int` column, :ref:`int` button_idx **)** const | +| :ref:`String` | :ref:`get_button_tooltip` **(** :ref:`int` column, :ref:`int` button_idx **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeCellMode` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | +| :ref:`TreeCellMode` | :ref:`get_cell_mode` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_children` **(** **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | +| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_color` **(** :ref:`int` column **)** const | +| :ref:`Color` | :ref:`get_custom_color` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | +| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | +| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_icon_modulate` **(** :ref:`int` column **)** const | +| :ref:`Color` | :ref:`get_icon_modulate` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | +| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | +| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_next` **(** **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -83,27 +83,27 @@ Methods +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_prev_visible` **(** :ref:`bool` wrap=false **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | +| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_suffix` **(** :ref:`int` column **)** const | +| :ref:`String` | :ref:`get_suffix` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | +| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TextAlign` | :ref:`get_text_align` **(** :ref:`int` column **)** const | +| :ref:`TextAlign` | :ref:`get_text_align` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | +| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | +| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | +| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | +| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -261,7 +261,7 @@ Adds a button with :ref:`Texture` ``button`` at column ``column`` .. _class_TreeItem_method_call_recursive: -- :ref:`Variant` **call_recursive** **(** :ref:`String` method, ... **)** vararg +- :ref:`Variant` **call_recursive** **(** :ref:`String` method, ... **)** |vararg| Calls the ``method`` on the actual TreeItem and its children recursively. Pass parameters as a comma separated list. @@ -301,7 +301,7 @@ Removes the button at index ``button_idx`` in column ``column``. .. _class_TreeItem_method_get_button: -- :ref:`Texture` **get_button** **(** :ref:`int` column, :ref:`int` button_idx **)** const +- :ref:`Texture` **get_button** **(** :ref:`int` column, :ref:`int` button_idx **)** |const| Returns the :ref:`Texture` of the button at index ``button_idx`` in column ``column``. @@ -309,7 +309,7 @@ Returns the :ref:`Texture` of the button at index ``button_idx`` .. _class_TreeItem_method_get_button_count: -- :ref:`int` **get_button_count** **(** :ref:`int` column **)** const +- :ref:`int` **get_button_count** **(** :ref:`int` column **)** |const| Returns the number of buttons in column ``column``. May be used to get the most recently added button's index, if no index was specified. @@ -317,7 +317,7 @@ Returns the number of buttons in column ``column``. May be used to get the most .. _class_TreeItem_method_get_button_tooltip: -- :ref:`String` **get_button_tooltip** **(** :ref:`int` column, :ref:`int` button_idx **)** const +- :ref:`String` **get_button_tooltip** **(** :ref:`int` column, :ref:`int` button_idx **)** |const| Returns the tooltip string for the button at index ``button_idx`` in column ``column``. @@ -325,7 +325,7 @@ Returns the tooltip string for the button at index ``button_idx`` in column ``co .. _class_TreeItem_method_get_cell_mode: -- :ref:`TreeCellMode` **get_cell_mode** **(** :ref:`int` column **)** const +- :ref:`TreeCellMode` **get_cell_mode** **(** :ref:`int` column **)** |const| Returns the column's cell mode. @@ -335,13 +335,13 @@ Returns the column's cell mode. - :ref:`TreeItem` **get_children** **(** **)** -Returns the TreeItem's child items. +Returns the TreeItem's first child item or a null object if there is none. ---- .. _class_TreeItem_method_get_custom_bg_color: -- :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const +- :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** |const| Returns the custom background color of column ``column``. @@ -349,7 +349,7 @@ Returns the custom background color of column ``column``. .. _class_TreeItem_method_get_custom_color: -- :ref:`Color` **get_custom_color** **(** :ref:`int` column **)** const +- :ref:`Color` **get_custom_color** **(** :ref:`int` column **)** |const| Returns the custom color of column ``column``. @@ -357,7 +357,7 @@ Returns the custom color of column ``column``. .. _class_TreeItem_method_get_expand_right: -- :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** const +- :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** |const| Returns ``true`` if ``expand_right`` is set. @@ -365,7 +365,7 @@ Returns ``true`` if ``expand_right`` is set. .. _class_TreeItem_method_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const +- :ref:`Texture` **get_icon** **(** :ref:`int` column **)** |const| Returns the given column's icon :ref:`Texture`. Error if no icon is set. @@ -373,7 +373,7 @@ Returns the given column's icon :ref:`Texture`. Error if no icon .. _class_TreeItem_method_get_icon_max_width: -- :ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** const +- :ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** |const| Returns the column's icon's maximum width. @@ -381,7 +381,7 @@ Returns the column's icon's maximum width. .. _class_TreeItem_method_get_icon_modulate: -- :ref:`Color` **get_icon_modulate** **(** :ref:`int` column **)** const +- :ref:`Color` **get_icon_modulate** **(** :ref:`int` column **)** |const| Returns the :ref:`Color` modulating the column's icon. @@ -389,7 +389,7 @@ Returns the :ref:`Color` modulating the column's icon. .. _class_TreeItem_method_get_icon_region: -- :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const +- :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** |const| Returns the icon :ref:`Texture` region as :ref:`Rect2`. @@ -397,7 +397,7 @@ Returns the icon :ref:`Texture` region as :ref:`Rect2` **get_metadata** **(** :ref:`int` column **)** const +- :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** |const| ---- @@ -405,7 +405,7 @@ Returns the icon :ref:`Texture` region as :ref:`Rect2` **get_next** **(** **)** -Returns the next TreeItem in the tree. +Returns the next TreeItem in the tree or a null object if there is none. ---- @@ -413,7 +413,7 @@ Returns the next TreeItem in the tree. - :ref:`TreeItem` **get_next_visible** **(** :ref:`bool` wrap=false **)** -Returns the next visible TreeItem in the tree. +Returns the next visible TreeItem in the tree or a null object if there is none. If ``wrap`` is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns ``null``. @@ -423,7 +423,7 @@ If ``wrap`` is enabled, the method will wrap around to the first visible element - :ref:`TreeItem` **get_parent** **(** **)** -Returns the parent TreeItem. +Returns the parent TreeItem or a null object if there is none. ---- @@ -431,7 +431,7 @@ Returns the parent TreeItem. - :ref:`TreeItem` **get_prev** **(** **)** -Returns the previous TreeItem in the tree. +Returns the previous TreeItem in the tree or a null object if there is none. ---- @@ -439,7 +439,7 @@ Returns the previous TreeItem in the tree. - :ref:`TreeItem` **get_prev_visible** **(** :ref:`bool` wrap=false **)** -Returns the previous visible TreeItem in the tree. +Returns the previous visible TreeItem in the tree or a null object if there is none. If ``wrap`` is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns ``null``. @@ -447,7 +447,7 @@ If ``wrap`` is enabled, the method will wrap around to the last visible element .. _class_TreeItem_method_get_range: -- :ref:`float` **get_range** **(** :ref:`int` column **)** const +- :ref:`float` **get_range** **(** :ref:`int` column **)** |const| ---- @@ -459,13 +459,13 @@ If ``wrap`` is enabled, the method will wrap around to the last visible element .. _class_TreeItem_method_get_suffix: -- :ref:`String` **get_suffix** **(** :ref:`int` column **)** const +- :ref:`String` **get_suffix** **(** :ref:`int` column **)** |const| ---- .. _class_TreeItem_method_get_text: -- :ref:`String` **get_text** **(** :ref:`int` column **)** const +- :ref:`String` **get_text** **(** :ref:`int` column **)** |const| Returns the given column's text. @@ -473,7 +473,7 @@ Returns the given column's text. .. _class_TreeItem_method_get_text_align: -- :ref:`TextAlign` **get_text_align** **(** :ref:`int` column **)** const +- :ref:`TextAlign` **get_text_align** **(** :ref:`int` column **)** |const| Returns the given column's text alignment. @@ -481,7 +481,7 @@ Returns the given column's text alignment. .. _class_TreeItem_method_get_tooltip: -- :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const +- :ref:`String` **get_tooltip** **(** :ref:`int` column **)** |const| Returns the given column's tooltip. @@ -489,7 +489,7 @@ Returns the given column's tooltip. .. _class_TreeItem_method_is_button_disabled: -- :ref:`bool` **is_button_disabled** **(** :ref:`int` column, :ref:`int` button_idx **)** const +- :ref:`bool` **is_button_disabled** **(** :ref:`int` column, :ref:`int` button_idx **)** |const| Returns ``true`` if the button at index ``button_idx`` for the given column is disabled. @@ -497,7 +497,7 @@ Returns ``true`` if the button at index ``button_idx`` for the given column is d .. _class_TreeItem_method_is_checked: -- :ref:`bool` **is_checked** **(** :ref:`int` column **)** const +- :ref:`bool` **is_checked** **(** :ref:`int` column **)** |const| Returns ``true`` if the given column is checked. @@ -505,7 +505,7 @@ Returns ``true`` if the given column is checked. .. _class_TreeItem_method_is_custom_set_as_button: -- :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** const +- :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** |const| ---- @@ -519,7 +519,7 @@ Returns ``true`` if column ``column`` is editable. .. _class_TreeItem_method_is_selectable: -- :ref:`bool` **is_selectable** **(** :ref:`int` column **)** const +- :ref:`bool` **is_selectable** **(** :ref:`int` column **)** |const| Returns ``true`` if column ``column`` is selectable. @@ -729,3 +729,6 @@ Sets the given column's text alignment. See :ref:`TextAlign` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_runtime` **(** **)** const | +| :ref:`float` | :ref:`get_runtime` **(** **)** |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 **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -65,7 +65,7 @@ Methods +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | +| :ref:`bool` | :ref:`is_active` **(** **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -93,7 +93,7 @@ Methods +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tell` **(** **)** const | +| :ref:`float` | :ref:`tell` **(** **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -290,7 +290,7 @@ Use :ref:`TransitionType` for ``trans_type`` and :ref .. _class_Tween_method_get_runtime: -- :ref:`float` **get_runtime** **(** **)** const +- :ref:`float` **get_runtime** **(** **)** |const| Returns the total time needed for all tweens to end. If you have two tweens, one lasting 10 seconds and the other 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. @@ -334,7 +334,7 @@ Use :ref:`TransitionType` for ``trans_type`` and :ref .. _class_Tween_method_is_active: -- :ref:`bool` **is_active** **(** **)** const +- :ref:`bool` **is_active** **(** **)** |const| Returns ``true`` if any tweens are currently running. @@ -452,7 +452,10 @@ Use :ref:`TransitionType` for ``trans_type`` and :ref .. _class_Tween_method_tell: -- :ref:`float` **tell** **(** **)** const +- :ref:`float` **tell** **(** **)** |const| Returns the current time of the tween. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_udpserver.rst b/classes/class_udpserver.rst index b165706dd..97498c98f 100644 --- a/classes/class_udpserver.rst +++ b/classes/class_udpserver.rst @@ -79,9 +79,9 @@ Methods ------- +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | +| :ref:`bool` | :ref:`is_connection_available` **(** **)** |const| | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | +| :ref:`bool` | :ref:`is_listening` **(** **)** |const| | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -114,7 +114,7 @@ Method Descriptions .. _class_UDPServer_method_is_connection_available: -- :ref:`bool` **is_connection_available** **(** **)** const +- :ref:`bool` **is_connection_available** **(** **)** |const| Returns ``true`` if a packet with a new address/port combination was received on the socket. @@ -122,7 +122,7 @@ Returns ``true`` if a packet with a new address/port combination was received on .. _class_UDPServer_method_is_listening: -- :ref:`bool` **is_listening** **(** **)** const +- :ref:`bool` **is_listening** **(** **)** |const| Returns ``true`` if the socket is open and listening on a port. @@ -158,3 +158,6 @@ Stops the server, closing the UDP socket if open. Will close all connected :ref: Returns the first pending connection (connected to the appropriate address/port). Will return ``null`` if no new connection is available. See also :ref:`is_connection_available`, :ref:`PacketPeerUDP.connect_to_host`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index e1af2e1ed..f4774fb37 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -49,13 +49,13 @@ Methods ------- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method, ... **)** vararg | +| void | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method, ... **)** |vararg| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method, ... **)** vararg | +| void | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method, ... **)** |vararg| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -67,15 +67,15 @@ Methods +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | +| :ref:`String` | :ref:`get_current_action_name` **(** **)** |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_version` **(** **)** const | +| :ref:`int` | :ref:`get_version` **(** **)** |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_redo` **(** **)** | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_undo` **(** **)** | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_commiting_action` **(** **)** const | +| :ref:`bool` | :ref:`is_commiting_action` **(** **)** |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`redo` **(** **)** | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -115,7 +115,7 @@ Method Descriptions .. _class_UndoRedo_method_add_do_method: -- void **add_do_method** **(** :ref:`Object` object, :ref:`String` method, ... **)** vararg +- void **add_do_method** **(** :ref:`Object` object, :ref:`String` method, ... **)** |vararg| Register a method that will be called when the action is committed. @@ -139,7 +139,7 @@ Register a reference for "do" that will be erased if the "do" history is lost. T .. _class_UndoRedo_method_add_undo_method: -- void **add_undo_method** **(** :ref:`Object` object, :ref:`String` method, ... **)** vararg +- void **add_undo_method** **(** :ref:`Object` object, :ref:`String` method, ... **)** |vararg| Register a method that will be called when the action is undone. @@ -191,7 +191,7 @@ The way actions are merged is dictated by the ``merge_mode`` argument. See :ref: .. _class_UndoRedo_method_get_current_action_name: -- :ref:`String` **get_current_action_name** **(** **)** const +- :ref:`String` **get_current_action_name** **(** **)** |const| Gets the name of the current action. @@ -199,7 +199,7 @@ Gets the name of the current action. .. _class_UndoRedo_method_get_version: -- :ref:`int` **get_version** **(** **)** const +- :ref:`int` **get_version** **(** **)** |const| Gets the version. Every time a new action is committed, the ``UndoRedo``'s version number is increased automatically. @@ -225,7 +225,7 @@ Returns ``true`` if an "undo" action is available. .. _class_UndoRedo_method_is_commiting_action: -- :ref:`bool` **is_commiting_action** **(** **)** const +- :ref:`bool` **is_commiting_action** **(** **)** |const| Returns ``true`` if the ``UndoRedo`` is currently committing the action, i.e. running its "do" method or property change (see :ref:`commit_action`). @@ -245,3 +245,6 @@ Redo the last action. Undo the last action. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index 7153c97a6..f9d306cbd 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -47,29 +47,29 @@ Properties Methods ------- -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_device` **(** :ref:`UPNPDevice` device **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_devices` **(** **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`discover` **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UPNPDevice` | :ref:`get_device` **(** :ref:`int` index **)** const | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_device_count` **(** **)** const | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UPNPDevice` | :ref:`get_gateway` **(** **)** const | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`query_external_address` **(** **)** const | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_device` **(** :ref:`int` index **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`int` index, :ref:`UPNPDevice` device **)** | -+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_device` **(** :ref:`UPNPDevice` device **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_devices` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`discover` **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UPNPDevice` | :ref:`get_device` **(** :ref:`int` index **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_device_count` **(** **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UPNPDevice` | :ref:`get_gateway` **(** **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`query_external_address` **(** **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_device` **(** :ref:`int` index **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_device` **(** :ref:`int` index, :ref:`UPNPDevice` device **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -256,7 +256,7 @@ Adds the given :ref:`UPNPDevice` to the list of discovered dev .. _class_UPNP_method_add_port_mapping: -- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const +- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| Adds a mapping to forward the external ``port`` (between 1 and 65535) on the default gateway (see :ref:`get_gateway`) to the ``internal_port`` on the local machine for the given protocol ``proto`` (either ``TCP`` or ``UDP``, with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with :ref:`get_gateway` and call :ref:`add_port_mapping` on it, if any. @@ -278,7 +278,7 @@ Clears the list of discovered devices. .. _class_UPNP_method_delete_port_mapping: -- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const +- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| Deletes the port mapping for the given port and protocol combination on the default gateway (see :ref:`get_gateway`) if one exists. ``port`` must be a valid port between 1 and 65535, ``proto`` can be either ``TCP`` or ``UDP``. See :ref:`UPNPResult` for possible return values. @@ -298,7 +298,7 @@ See :ref:`UPNPResult` for possible return values. .. _class_UPNP_method_get_device: -- :ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** const +- :ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** |const| Returns the :ref:`UPNPDevice` at the given ``index``. @@ -306,7 +306,7 @@ Returns the :ref:`UPNPDevice` at the given ``index``. .. _class_UPNP_method_get_device_count: -- :ref:`int` **get_device_count** **(** **)** const +- :ref:`int` **get_device_count** **(** **)** |const| Returns the number of discovered :ref:`UPNPDevice`\ s. @@ -314,7 +314,7 @@ Returns the number of discovered :ref:`UPNPDevice`\ s. .. _class_UPNP_method_get_gateway: -- :ref:`UPNPDevice` **get_gateway** **(** **)** const +- :ref:`UPNPDevice` **get_gateway** **(** **)** |const| Returns the default gateway. That is the first discovered :ref:`UPNPDevice` that is also a valid IGD (InternetGatewayDevice). @@ -322,7 +322,7 @@ Returns the default gateway. That is the first discovered :ref:`UPNPDevice` **query_external_address** **(** **)** const +- :ref:`String` **query_external_address** **(** **)** |const| Returns the external :ref:`IP` address of the default gateway (see :ref:`get_gateway`) as string. Returns an empty string on error. @@ -342,3 +342,6 @@ Removes the device at ``index`` from the list of discovered devices. Sets the device at ``index`` from the list of discovered devices to ``device``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index e637ad28a..456b51637 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -38,15 +38,15 @@ Properties Methods ------- -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_gateway` **(** **)** const | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`query_external_address` **(** **)** const | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_gateway` **(** **)** |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`query_external_address` **(** **)** |const| | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -197,7 +197,7 @@ Method Descriptions .. _class_UPNPDevice_method_add_port_mapping: -- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const +- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** |const| Adds a port mapping to forward the given external port on this ``UPNPDevice`` for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. @@ -205,7 +205,7 @@ Adds a port mapping to forward the given external port on this ``UPNPDevice`` fo .. _class_UPNPDevice_method_delete_port_mapping: -- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const +- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** |const| Deletes the port mapping identified by the given port and protocol combination on this device. See :ref:`UPNP.delete_port_mapping`. @@ -213,7 +213,7 @@ Deletes the port mapping identified by the given port and protocol combination o .. _class_UPNPDevice_method_is_valid_gateway: -- :ref:`bool` **is_valid_gateway** **(** **)** const +- :ref:`bool` **is_valid_gateway** **(** **)** |const| Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding. @@ -221,7 +221,10 @@ Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentiall .. _class_UPNPDevice_method_query_external_address: -- :ref:`String` **query_external_address** **(** **)** const +- :ref:`String` **query_external_address** **(** **)** |const| Returns the external IP address of this ``UPNPDevice`` or an empty string. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_variant.rst b/classes/class_variant.rst index 4f215a87f..ba8031f2c 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -87,3 +87,6 @@ Tutorials - :doc:`../development/cpp/variant_class` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index 451793a15..05256a822 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -27,3 +27,6 @@ Theme Properties | :ref:`int` | separation | 4 | +-----------------------+------------+---+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 899556f3e..10395902b 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -192,7 +192,9 @@ Returns a new vector with all components in absolute values (i.e. positive). - :ref:`float` **angle** **(** **)** -Returns this vector's angle with respect to the X axis, or ``(1, 0)`` vector, in radians. +Returns this vector's angle with respect to the positive X axis, or ``(1, 0)`` vector, in radians. + +For example, ``Vector2.RIGHT.angle()`` will return zero, ``Vector2.DOWN.angle()`` will return ``PI / 2`` (a quarter turn, or 90 degrees), and ``Vector2(1, -1).angle()`` will return ``-PI / 4`` (a negative eighth turn, or -45 degrees). Equivalent to the result of :ref:`@GDScript.atan2` when called with the vector's :ref:`y` and :ref:`x` as parameters: ``atan2(y, x)``. @@ -456,3 +458,6 @@ Returns this vector with each component snapped to the nearest multiple of ``ste Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index f55438225..89b1f4709 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -482,3 +482,6 @@ Returns a diagonal matrix with the vector as main diagonal. This is equivalent to a Basis with no rotation or shearing and this vector's components set as the scale. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 5dac22765..b66776582 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -90,3 +90,6 @@ A negative value will result in the vehicle reversing. The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have :ref:`VehicleWheel.use_as_steering` set to ``true`` will automatically be rotated. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 02ad0d827..6a959b1ed 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -56,13 +56,13 @@ Properties Methods ------- -+---------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rpm` **(** **)** const | -+---------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_skidinfo` **(** **)** const | -+---------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_contact` **(** **)** const | -+---------------------------+---------------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rpm` **(** **)** |const| | ++---------------------------+-----------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_skidinfo` **(** **)** |const| | ++---------------------------+-----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_contact` **(** **)** |const| | ++---------------------------+-----------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -300,7 +300,7 @@ Method Descriptions .. _class_VehicleWheel_method_get_rpm: -- :ref:`float` **get_rpm** **(** **)** const +- :ref:`float` **get_rpm** **(** **)** |const| Returns the rotational speed of the wheel in revolutions per minute. @@ -308,7 +308,7 @@ Returns the rotational speed of the wheel in revolutions per minute. .. _class_VehicleWheel_method_get_skidinfo: -- :ref:`float` **get_skidinfo** **(** **)** const +- :ref:`float` **get_skidinfo** **(** **)** |const| Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is skidding (the wheel has lost grip, e.g. icy terrain), 1.0 means not skidding (the wheel has full grip, e.g. dry asphalt road). @@ -316,7 +316,10 @@ Returns a value between 0.0 and 1.0 that indicates whether this wheel is skiddin .. _class_VehicleWheel_method_is_in_contact: -- :ref:`bool` **is_in_contact** **(** **)** const +- :ref:`bool` **is_in_contact** **(** **)** |const| Returns ``true`` if this wheel is in contact with a surface. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 7370c2b49..d621245df 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -48,17 +48,17 @@ Properties Methods ------- -+-------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_stream_name` **(** **)** const | -+-------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_video_texture` **(** **)** const | -+-------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+-------------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** **)** | -+-------------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+-------------------------------+----------------------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_stream_name` **(** **)** |const| | ++-------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_video_texture` **(** **)** |const| | ++-------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** |const| | ++-------------------------------+------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------+ Signals ------- @@ -229,7 +229,7 @@ Method Descriptions .. _class_VideoPlayer_method_get_stream_name: -- :ref:`String` **get_stream_name** **(** **)** const +- :ref:`String` **get_stream_name** **(** **)** |const| Returns the video stream's name, or ``""`` if no video stream is assigned. @@ -237,7 +237,7 @@ Returns the video stream's name, or ``""`` if no video stream is assi .. _class_VideoPlayer_method_get_video_texture: -- :ref:`Texture` **get_video_texture** **(** **)** const +- :ref:`Texture` **get_video_texture** **(** **)** |const| Returns the current frame as a :ref:`Texture`. @@ -245,7 +245,7 @@ Returns the current frame as a :ref:`Texture`. .. _class_VideoPlayer_method_is_playing: -- :ref:`bool` **is_playing** **(** **)** const +- :ref:`bool` **is_playing** **(** **)** |const| Returns ``true`` if the video is playing. @@ -269,3 +269,6 @@ Stops the video playback and sets the stream position to 0. **Note:** Although the stream position will be set to 0, the first frame of the video stream won't become the current frame. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index 93f50f5b9..599c1a613 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -20,3 +20,6 @@ Description Base resource type for all video streams. Classes that derive from ``VideoStream`` can all be used as resource types to play back videos in :ref:`VideoPlayer`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_videostreamgdnative.rst b/classes/class_videostreamgdnative.rst index f6fa3f3ed..632b59841 100644 --- a/classes/class_videostreamgdnative.rst +++ b/classes/class_videostreamgdnative.rst @@ -46,3 +46,6 @@ Returns the video file handled by this ``VideoStreamGDNative``. Sets the video file that this ``VideoStreamGDNative`` resource handles. The supported extensions depend on the GDNative plugins used to expose video formats. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index ee05f8415..1531b5b4a 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -44,3 +44,6 @@ Returns the Ogg Theora video file handled by this ``VideoStreamTheora``. Sets the Ogg Theora video file that this ``VideoStreamTheora`` resource handles. The ``file`` name should have the ``.o`` extension. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst index 90288fdf9..12d7966b4 100644 --- a/classes/class_videostreamwebm.rst +++ b/classes/class_videostreamwebm.rst @@ -44,3 +44,6 @@ Returns the WebM video file handled by this ``VideoStreamWebm``. Sets the WebM video file that this ``VideoStreamWebm`` resource handles. The ``file`` name should have the ``.webm`` extension. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 21aeba6f5..c1d8ebccb 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -104,41 +104,41 @@ Methods ------- +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`find_world` **(** **)** const | +| :ref:`World` | :ref:`find_world` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | +| :ref:`World2D` | :ref:`find_world_2d` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Camera` | :ref:`get_camera` **(** **)** const | +| :ref:`Camera` | :ref:`get_camera` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_modal_stack_top` **(** **)** const | +| :ref:`Control` | :ref:`get_modal_stack_top` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | +| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | +| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | +| :ref:`Vector2` | :ref:`get_size_override` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | +| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | +| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | +| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | +| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_is_dragging` **(** **)** const | +| :ref:`bool` | :ref:`gui_is_dragging` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_handled` **(** **)** const | +| :ref:`bool` | :ref:`is_input_handled` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | +| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** |const| | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -337,9 +337,9 @@ enum **MSAA**: enum **Usage**: -- **USAGE_2D** = **0** --- Allocates all buffers needed for drawing 2D scenes. This takes less VRAM than the 3D usage modes. +- **USAGE_2D** = **0** --- Allocates all buffers needed for drawing 2D scenes. This takes less VRAM than the 3D usage modes. Note that 3D rendering effects such as glow and HDR are not available when using this mode. -- **USAGE_2D_NO_SAMPLING** = **1** --- Allocates buffers needed for 2D scenes without allocating a buffer for screen copy. Accordingly, you cannot read from the screen. Of the :ref:`Usage` types, this requires the least VRAM. +- **USAGE_2D_NO_SAMPLING** = **1** --- Allocates buffers needed for 2D scenes without allocating a buffer for screen copy. Accordingly, you cannot read from the screen. Of the :ref:`Usage` types, this requires the least VRAM. Note that 3D rendering effects such as glow and HDR are not available when using this mode. - **USAGE_3D** = **2** --- Allocates full buffers for drawing 3D scenes and all 3D effects including buffers needed for 2D scenes and effects. @@ -632,6 +632,8 @@ If ``true``, renders the Viewport directly to the screen instead of to the root The clear mode when viewport used as a render target. +**Note:** This property is intended for 2D usage. + ---- .. _class_Viewport_property_render_target_update_mode: @@ -843,7 +845,7 @@ Method Descriptions .. _class_Viewport_method_find_world: -- :ref:`World` **find_world** **(** **)** const +- :ref:`World` **find_world** **(** **)** |const| Returns the 3D world of the viewport, or if none the world of the parent viewport. @@ -851,7 +853,7 @@ Returns the 3D world of the viewport, or if none the world of the parent viewpor .. _class_Viewport_method_find_world_2d: -- :ref:`World2D` **find_world_2d** **(** **)** const +- :ref:`World2D` **find_world_2d** **(** **)** |const| Returns the 2D world of the viewport. @@ -859,7 +861,7 @@ Returns the 2D world of the viewport. .. _class_Viewport_method_get_camera: -- :ref:`Camera` **get_camera** **(** **)** const +- :ref:`Camera` **get_camera** **(** **)** |const| Returns the active 3D camera. @@ -867,7 +869,7 @@ Returns the active 3D camera. .. _class_Viewport_method_get_final_transform: -- :ref:`Transform2D` **get_final_transform** **(** **)** const +- :ref:`Transform2D` **get_final_transform** **(** **)** |const| Returns the total transform of the viewport. @@ -875,7 +877,7 @@ Returns the total transform of the viewport. .. _class_Viewport_method_get_modal_stack_top: -- :ref:`Control` **get_modal_stack_top** **(** **)** const +- :ref:`Control` **get_modal_stack_top** **(** **)** |const| Returns the topmost modal in the stack. @@ -883,7 +885,7 @@ Returns the topmost modal in the stack. .. _class_Viewport_method_get_mouse_position: -- :ref:`Vector2` **get_mouse_position** **(** **)** const +- :ref:`Vector2` **get_mouse_position** **(** **)** |const| Returns the mouse position relative to the viewport. @@ -899,7 +901,7 @@ Returns information about the viewport from the rendering pipeline. .. _class_Viewport_method_get_shadow_atlas_quadrant_subdiv: -- :ref:`ShadowAtlasQuadrantSubdiv` **get_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** const +- :ref:`ShadowAtlasQuadrantSubdiv` **get_shadow_atlas_quadrant_subdiv** **(** :ref:`int` quadrant **)** |const| Returns the :ref:`ShadowAtlasQuadrantSubdiv` of the specified quadrant. @@ -907,7 +909,7 @@ Returns the :ref:`ShadowAtlasQuadrantSubdiv` **get_size_override** **(** **)** const +- :ref:`Vector2` **get_size_override** **(** **)** |const| Returns the size override set with :ref:`set_size_override`. @@ -915,7 +917,7 @@ Returns the size override set with :ref:`set_size_override` **get_texture** **(** **)** const +- :ref:`ViewportTexture` **get_texture** **(** **)** |const| Returns the viewport's texture. @@ -930,7 +932,7 @@ Returns the viewport's texture. .. _class_Viewport_method_get_viewport_rid: -- :ref:`RID` **get_viewport_rid** **(** **)** const +- :ref:`RID` **get_viewport_rid** **(** **)** |const| Returns the viewport's RID from the :ref:`VisualServer`. @@ -938,7 +940,7 @@ Returns the viewport's RID from the :ref:`VisualServer`. .. _class_Viewport_method_get_visible_rect: -- :ref:`Rect2` **get_visible_rect** **(** **)** const +- :ref:`Rect2` **get_visible_rect** **(** **)** |const| Returns the visible rectangle in global screen coordinates. @@ -946,7 +948,7 @@ Returns the visible rectangle in global screen coordinates. .. _class_Viewport_method_gui_get_drag_data: -- :ref:`Variant` **gui_get_drag_data** **(** **)** const +- :ref:`Variant` **gui_get_drag_data** **(** **)** |const| Returns the drag data from the GUI, that was previously returned by :ref:`Control.get_drag_data`. @@ -954,7 +956,7 @@ Returns the drag data from the GUI, that was previously returned by :ref:`Contro .. _class_Viewport_method_gui_has_modal_stack: -- :ref:`bool` **gui_has_modal_stack** **(** **)** const +- :ref:`bool` **gui_has_modal_stack** **(** **)** |const| Returns ``true`` if there are visible modals on-screen. @@ -962,7 +964,7 @@ Returns ``true`` if there are visible modals on-screen. .. _class_Viewport_method_gui_is_dragging: -- :ref:`bool` **gui_is_dragging** **(** **)** const +- :ref:`bool` **gui_is_dragging** **(** **)** |const| Returns ``true`` if the viewport is currently performing a drag operation. @@ -976,13 +978,13 @@ Returns ``true`` if the viewport is currently performing a drag operation. .. _class_Viewport_method_is_input_handled: -- :ref:`bool` **is_input_handled** **(** **)** const +- :ref:`bool` **is_input_handled** **(** **)** |const| ---- .. _class_Viewport_method_is_size_override_enabled: -- :ref:`bool` **is_size_override_enabled** **(** **)** const +- :ref:`bool` **is_size_override_enabled** **(** **)** |const| Returns ``true`` if the size override is enabled. See :ref:`set_size_override`. @@ -1040,3 +1042,6 @@ Forces update of the 2D and 3D worlds. Warps the mouse to a position relative to the viewport. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index 60731b821..b5412663c 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -66,3 +66,6 @@ For example, a 1280×720 viewport with :ref:`stretch_shrink` must be ``true`` for this property to work. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index ee3ca098a..510893fce 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -48,3 +48,6 @@ Property Descriptions The path to the :ref:`Viewport` node to display. This is relative to the scene root, not to the node which uses the texture. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index e6bee8da3..26b001968 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -37,7 +37,7 @@ Methods ------- +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`Enabler` enabler **)** const | +| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`Enabler` enabler **)** |const| | +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_enabler` **(** :ref:`Enabler` enabler, :ref:`bool` enabled **)** | +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -99,7 +99,7 @@ Method Descriptions .. _class_VisibilityEnabler_method_is_enabler_enabled: -- :ref:`bool` **is_enabler_enabled** **(** :ref:`Enabler` enabler **)** const +- :ref:`bool` **is_enabler_enabled** **(** :ref:`Enabler` enabler **)** |const| Returns whether the enabler identified by given :ref:`Enabler` constant is active. @@ -111,3 +111,6 @@ Returns whether the enabler identified by given :ref:`Enabler` constant. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index e3d0e2fcc..cb613de6e 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -45,7 +45,7 @@ Methods ------- +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`Enabler` enabler **)** const | +| :ref:`bool` | :ref:`is_enabler_enabled` **(** :ref:`Enabler` enabler **)** |const| | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_enabler` **(** :ref:`Enabler` enabler, :ref:`bool` enabled **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -187,7 +187,7 @@ Method Descriptions .. _class_VisibilityEnabler2D_method_is_enabler_enabled: -- :ref:`bool` **is_enabler_enabled** **(** :ref:`Enabler` enabler **)** const +- :ref:`bool` **is_enabler_enabled** **(** :ref:`Enabler` enabler **)** |const| Returns whether the enabler identified by given :ref:`Enabler` constant is active. @@ -199,3 +199,6 @@ Returns whether the enabler identified by given :ref:`Enabler` constant. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 4c9329ac1..05bd1203e 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -34,9 +34,9 @@ Properties Methods ------- -+-------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | -+-------------------------+-------------------------------------------------------------------------------------+ ++-------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_screen` **(** **)** |const| | ++-------------------------+---------------------------------------------------------------------------------------+ Signals ------- @@ -93,9 +93,12 @@ Method Descriptions .. _class_VisibilityNotifier_method_is_on_screen: -- :ref:`bool` **is_on_screen** **(** **)** const +- :ref:`bool` **is_on_screen** **(** **)** |const| If ``true``, the bounding box is on the screen. **Note:** It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return ``false`` right after it is instantiated, even if it will be on screen in the draw pass. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 182d023ce..083d947a0 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -34,9 +34,9 @@ Properties Methods ------- -+-------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | -+-------------------------+---------------------------------------------------------------------------------------+ ++-------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_screen` **(** **)** |const| | ++-------------------------+-----------------------------------------------------------------------------------------+ Signals ------- @@ -93,9 +93,12 @@ Method Descriptions .. _class_VisibilityNotifier2D_method_is_on_screen: -- :ref:`bool` **is_on_screen** **(** **)** const +- :ref:`bool` **is_on_screen** **(** **)** |const| If ``true``, the bounding rectangle is on the screen. **Note:** It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return ``false`` right after it is instantiated, even if it will be on screen in the draw pass. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index bbedd763c..34fd69534 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -31,15 +31,15 @@ Methods ------- +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`get_aabb` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_base` **(** **)** const | +| :ref:`RID` | :ref:`get_base` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_instance` **(** **)** const | +| :ref:`RID` | :ref:`get_instance` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` layer **)** const | +| :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` layer **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_base` **(** :ref:`RID` base **)** | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -70,7 +70,7 @@ Method Descriptions .. _class_VisualInstance_method_get_aabb: -- :ref:`AABB` **get_aabb** **(** **)** const +- :ref:`AABB` **get_aabb** **(** **)** |const| Returns the :ref:`AABB` (also known as the bounding box) for this ``VisualInstance``. @@ -78,7 +78,7 @@ Returns the :ref:`AABB` (also known as the bounding box) for this `` .. _class_VisualInstance_method_get_base: -- :ref:`RID` **get_base** **(** **)** const +- :ref:`RID` **get_base** **(** **)** |const| Returns the RID of the resource associated with this ``VisualInstance``. For example, if the Node is a :ref:`MeshInstance`, this will return the RID of the associated :ref:`Mesh`. @@ -86,7 +86,7 @@ Returns the RID of the resource associated with this ``VisualInstance``. For exa .. _class_VisualInstance_method_get_instance: -- :ref:`RID` **get_instance** **(** **)** const +- :ref:`RID` **get_instance** **(** **)** |const| Returns the RID of this instance. This RID is the same as the RID returned by :ref:`VisualServer.instance_create`. This RID is needed if you want to call :ref:`VisualServer` functions directly on this ``VisualInstance``. @@ -94,7 +94,7 @@ Returns the RID of this instance. This RID is the same as the RID returned by :r .. _class_VisualInstance_method_get_layer_mask_bit: -- :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` layer **)** const +- :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` layer **)** |const| Returns ``true`` when the specified layer is enabled in :ref:`layers` and ``false`` otherwise. @@ -102,7 +102,7 @@ Returns ``true`` when the specified layer is enabled in :ref:`layers` **get_transformed_aabb** **(** **)** const +- :ref:`AABB` **get_transformed_aabb** **(** **)** |const| Returns the transformed :ref:`AABB` (also known as the bounding box) for this ``VisualInstance``. @@ -124,3 +124,6 @@ Sets the resource that is instantiated by this ``VisualInstance``, which changes Enables a particular layer in :ref:`layers`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index f3d4622f8..d5d53d046 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -41,11 +41,11 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | +| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | +| :ref:`Variant.Type` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -59,31 +59,31 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** const | +| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | +| :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` func, :ref:`int` id **)** const | +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` func, :ref:`int` id **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | +| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | +| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | +| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -170,7 +170,7 @@ Add an argument to a custom signal added with :ref:`add_custom_signal` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const +- :ref:`int` **custom_signal_get_argument_count** **(** :ref:`String` name **)** |const| Get the count of a custom signal's arguments. @@ -178,7 +178,7 @@ Get the count of a custom signal's arguments. .. _class_VisualScript_method_custom_signal_get_argument_name: -- :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** const +- :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** |const| Get the name of a custom signal's argument. @@ -186,7 +186,7 @@ Get the name of a custom signal's argument. .. _class_VisualScript_method_custom_signal_get_argument_type: -- :ref:`Variant.Type` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const +- :ref:`Variant.Type` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** |const| Get the type of a custom signal's argument. @@ -242,7 +242,7 @@ Disconnect two data ports previously connected with :ref:`data_connect` **get_function_node_id** **(** :ref:`String` name **)** const +- :ref:`int` **get_function_node_id** **(** :ref:`String` name **)** |const| Returns the id of a function's entry point node. @@ -250,7 +250,7 @@ Returns the id of a function's entry point node. .. _class_VisualScript_method_get_function_scroll: -- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** |const| Returns the position of the center of the screen for a given function. @@ -258,7 +258,7 @@ Returns the position of the center of the screen for a given function. .. _class_VisualScript_method_get_node: -- :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** |const| Returns a node given its id and its function. @@ -266,7 +266,7 @@ Returns a node given its id and its function. .. _class_VisualScript_method_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** |const| Returns a node's position in pixels. @@ -274,7 +274,7 @@ Returns a node's position in pixels. .. _class_VisualScript_method_get_variable_default_value: -- :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** |const| Returns the default (initial) value of a variable. @@ -282,7 +282,7 @@ Returns the default (initial) value of a variable. .. _class_VisualScript_method_get_variable_export: -- :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const +- :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** |const| Returns whether a variable is exported. @@ -290,7 +290,7 @@ Returns whether a variable is exported. .. _class_VisualScript_method_get_variable_info: -- :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** const +- :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** |const| Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage. @@ -298,7 +298,7 @@ Returns the information for a given variable as a dictionary. The information in .. _class_VisualScript_method_has_custom_signal: -- :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const +- :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** |const| Returns whether a signal exists with the specified name. @@ -306,7 +306,7 @@ Returns whether a signal exists with the specified name. .. _class_VisualScript_method_has_data_connection: -- :ref:`bool` **has_data_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +- :ref:`bool` **has_data_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| Returns whether the specified data ports are connected. @@ -314,7 +314,7 @@ Returns whether the specified data ports are connected. .. _class_VisualScript_method_has_function: -- :ref:`bool` **has_function** **(** :ref:`String` name **)** const +- :ref:`bool` **has_function** **(** :ref:`String` name **)** |const| Returns whether a function exists with the specified name. @@ -322,7 +322,7 @@ Returns whether a function exists with the specified name. .. _class_VisualScript_method_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** |const| Returns whether a node exists with the given id. @@ -330,7 +330,7 @@ Returns whether a node exists with the given id. .. _class_VisualScript_method_has_sequence_connection: -- :ref:`bool` **has_sequence_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const +- :ref:`bool` **has_sequence_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** |const| Returns whether the specified sequence ports are connected. @@ -338,7 +338,7 @@ Returns whether the specified sequence ports are connected. .. _class_VisualScript_method_has_variable: -- :ref:`bool` **has_variable** **(** :ref:`String` name **)** const +- :ref:`bool` **has_variable** **(** :ref:`String` name **)** |const| Returns whether a variable exists with the specified name. @@ -464,3 +464,6 @@ Change whether a variable is exported. Set a variable's info, using the same format as :ref:`get_variable_info`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index ee75b6dd3..c61ee7b89 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -58,3 +58,6 @@ The type to get the constant from. The name of the constant to return. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 6f295d75b..840734088 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -334,3 +334,6 @@ Property Descriptions The function to be executed. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index b30b6c61f..93d56993a 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -68,3 +68,6 @@ The constant's parent class. The constant to return. See the given class for its available constants. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index da216df60..d49f61607 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -80,3 +80,6 @@ The comment node's size (in pixels). The comment node's title. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptcomposearray.rst b/classes/class_visualscriptcomposearray.rst index 5658dd76c..088bc180b 100644 --- a/classes/class_visualscriptcomposearray.rst +++ b/classes/class_visualscriptcomposearray.rst @@ -18,3 +18,6 @@ Description A Visual Script Node used to compose array from the list of elements provided with custom in-graph UI hard coded in the VisualScript Editor. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptcondition.rst b/classes/class_visualscriptcondition.rst index ee4945919..22c7a31c6 100644 --- a/classes/class_visualscriptcondition.rst +++ b/classes/class_visualscriptcondition.rst @@ -32,3 +32,6 @@ A Visual Script node that checks a :ref:`bool` input port. If ``true - Sequence: ``done`` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index b4528f792..f74f76854 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -66,3 +66,6 @@ The constant's type. The constant's value. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index dfe9ff430..5f361dc3e 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -22,9 +22,9 @@ Methods ------- +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | +| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`get_constructor_type` **(** **)** const | +| :ref:`Variant.Type` | :ref:`get_constructor_type` **(** **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -36,13 +36,13 @@ Method Descriptions .. _class_VisualScriptConstructor_method_get_constructor: -- :ref:`Dictionary` **get_constructor** **(** **)** const +- :ref:`Dictionary` **get_constructor** **(** **)** |const| ---- .. _class_VisualScriptConstructor_method_get_constructor_type: -- :ref:`Variant.Type` **get_constructor_type** **(** **)** const +- :ref:`Variant.Type` **get_constructor_type** **(** **)** |const| ---- @@ -56,3 +56,6 @@ Method Descriptions - void **set_constructor_type** **(** :ref:`Variant.Type` type **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index b603e17af..90acf9fff 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -21,35 +21,35 @@ A custom Visual Script node which can be scripted in powerful ways. Methods ------- -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_caption` **(** **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_category` **(** **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_input_value_port_count` **(** **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_input_value_port_name` **(** :ref:`int` idx **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_input_value_port_type` **(** :ref:`int` idx **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_sequence_port_count` **(** **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_output_sequence_port_text` **(** :ref:`int` idx **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_value_port_count` **(** **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_output_value_port_name` **(** :ref:`int` idx **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_value_port_type` **(** :ref:`int` idx **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_text` **(** **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_working_memory_size` **(** **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_has_input_sequence_port` **(** **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_step` **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_caption` **(** **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_category` **(** **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_value_port_count` **(** **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_input_value_port_name` **(** :ref:`int` idx **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_value_port_type` **(** :ref:`int` idx **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_sequence_port_count` **(** **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_output_sequence_port_text` **(** :ref:`int` idx **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_value_port_count` **(** **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_output_value_port_name` **(** :ref:`int` idx **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_value_port_type` **(** :ref:`int` idx **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_text` **(** **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_working_memory_size` **(** **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_has_input_sequence_port` **(** **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_step` **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** |virtual| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -102,7 +102,7 @@ Method Descriptions .. _class_VisualScriptCustomNode_method__get_caption: -- :ref:`String` **_get_caption** **(** **)** virtual +- :ref:`String` **_get_caption** **(** **)** |virtual| Return the node's title. @@ -110,7 +110,7 @@ Return the node's title. .. _class_VisualScriptCustomNode_method__get_category: -- :ref:`String` **_get_category** **(** **)** virtual +- :ref:`String` **_get_category** **(** **)** |virtual| Return the node's category. @@ -118,7 +118,7 @@ Return the node's category. .. _class_VisualScriptCustomNode_method__get_input_value_port_count: -- :ref:`int` **_get_input_value_port_count** **(** **)** virtual +- :ref:`int` **_get_input_value_port_count** **(** **)** |virtual| Return the count of input value ports. @@ -126,7 +126,7 @@ Return the count of input value ports. .. _class_VisualScriptCustomNode_method__get_input_value_port_name: -- :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** virtual +- :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** |virtual| Return the specified input port's name. @@ -134,7 +134,7 @@ Return the specified input port's name. .. _class_VisualScriptCustomNode_method__get_input_value_port_type: -- :ref:`int` **_get_input_value_port_type** **(** :ref:`int` idx **)** virtual +- :ref:`int` **_get_input_value_port_type** **(** :ref:`int` idx **)** |virtual| Return the specified input port's type. See the :ref:`Variant.Type` values. @@ -142,7 +142,7 @@ Return the specified input port's type. See the :ref:`Variant.Type` **_get_output_sequence_port_count** **(** **)** virtual +- :ref:`int` **_get_output_sequence_port_count** **(** **)** |virtual| Return the amount of output **sequence** ports. @@ -150,7 +150,7 @@ Return the amount of output **sequence** ports. .. _class_VisualScriptCustomNode_method__get_output_sequence_port_text: -- :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** virtual +- :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** |virtual| Return the specified **sequence** output's name. @@ -158,7 +158,7 @@ Return the specified **sequence** output's name. .. _class_VisualScriptCustomNode_method__get_output_value_port_count: -- :ref:`int` **_get_output_value_port_count** **(** **)** virtual +- :ref:`int` **_get_output_value_port_count** **(** **)** |virtual| Return the amount of output value ports. @@ -166,7 +166,7 @@ Return the amount of output value ports. .. _class_VisualScriptCustomNode_method__get_output_value_port_name: -- :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** virtual +- :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** |virtual| Return the specified output's name. @@ -174,7 +174,7 @@ Return the specified output's name. .. _class_VisualScriptCustomNode_method__get_output_value_port_type: -- :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** virtual +- :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** |virtual| Return the specified output's type. See the :ref:`Variant.Type` values. @@ -182,7 +182,7 @@ Return the specified output's type. See the :ref:`Variant.Type` **_get_text** **(** **)** virtual +- :ref:`String` **_get_text** **(** **)** |virtual| Return the custom node's text, which is shown right next to the input **sequence** port (if there is none, on the place that is usually taken by it). @@ -190,7 +190,7 @@ Return the custom node's text, which is shown right next to the input **sequence .. _class_VisualScriptCustomNode_method__get_working_memory_size: -- :ref:`int` **_get_working_memory_size** **(** **)** virtual +- :ref:`int` **_get_working_memory_size** **(** **)** |virtual| Return the size of the custom node's working memory. See :ref:`_step` for more details. @@ -198,7 +198,7 @@ Return the size of the custom node's working memory. See :ref:`_step` **_has_input_sequence_port** **(** **)** virtual +- :ref:`bool` **_has_input_sequence_port** **(** **)** |virtual| Return whether the custom node has an input **sequence** port. @@ -206,7 +206,7 @@ Return whether the custom node has an input **sequence** port. .. _class_VisualScriptCustomNode_method__step: -- :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual +- :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** |virtual| Execute the custom node's logic, returning the index of the output sequence port to use or a :ref:`String` when there is an error. @@ -220,3 +220,6 @@ The ``start_mode`` is usually :ref:`START_MODE_BEGIN_SEQUENCE` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | +| :ref:`bool` | :ref:`is_valid` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`resume` **(** :ref:`Array` args=null **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -35,7 +35,7 @@ Method Descriptions .. _class_VisualScriptFunctionState_method_is_valid: -- :ref:`bool` **is_valid** **(** **)** const +- :ref:`bool` **is_valid** **(** **)** |const| ---- @@ -43,3 +43,6 @@ Method Descriptions - :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 915b7f32e..e8a53f863 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -35,3 +35,6 @@ Property Descriptions | *Getter* | get_global_constant() | +-----------+----------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptindexget.rst b/classes/class_visualscriptindexget.rst index 9aad19591..fe3f20fd3 100644 --- a/classes/class_visualscriptindexget.rst +++ b/classes/class_visualscriptindexget.rst @@ -13,3 +13,6 @@ VisualScriptIndexGet +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptindexset.rst b/classes/class_visualscriptindexset.rst index 2ec4d1123..b70088118 100644 --- a/classes/class_visualscriptindexset.rst +++ b/classes/class_visualscriptindexset.rst @@ -13,3 +13,6 @@ VisualScriptIndexSet +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index f75e9ef17..bdf5ad135 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -74,3 +74,6 @@ Property Descriptions | *Getter* | get_action_mode() | +-----------+------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptiterator.rst b/classes/class_visualscriptiterator.rst index e7bd12dd6..71d6abc76 100644 --- a/classes/class_visualscriptiterator.rst +++ b/classes/class_visualscriptiterator.rst @@ -32,3 +32,6 @@ This node steps through each item in a given input. Input can be any sequence da - Data (variant): ``elem`` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptlists.rst b/classes/class_visualscriptlists.rst index ccd984c99..86de05adb 100644 --- a/classes/class_visualscriptlists.rst +++ b/classes/class_visualscriptlists.rst @@ -90,3 +90,6 @@ Method Descriptions - void **set_output_data_port_type** **(** :ref:`int` index, :ref:`Variant.Type` type **)** +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 641e807b0..9c78cc421 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -68,3 +68,6 @@ The local variable's type. The local variable's name. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 4d38325b5..8b321f9b7 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -72,3 +72,6 @@ The local variable's type. The local variable's name. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index bc9201853..00a5c8310 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -93,3 +93,6 @@ Property Descriptions The math constant. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 505628b2b..d05674922 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -24,9 +24,9 @@ Methods ------- +-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_default_input_value` **(** :ref:`int` port_idx **)** const | +| :ref:`Variant` | :ref:`get_default_input_value` **(** :ref:`int` port_idx **)** |const| | +-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualScript` | :ref:`get_visual_script` **(** **)** const | +| :ref:`VisualScript` | :ref:`get_visual_script` **(** **)** |const| | +-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ports_changed_notify` **(** **)** | +-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,7 +47,7 @@ Method Descriptions .. _class_VisualScriptNode_method_get_default_input_value: -- :ref:`Variant` **get_default_input_value** **(** :ref:`int` port_idx **)** const +- :ref:`Variant` **get_default_input_value** **(** :ref:`int` port_idx **)** |const| Returns the default value of a given port. The default value is used when nothing is connected to the port. @@ -55,7 +55,7 @@ Returns the default value of a given port. The default value is used when nothin .. _class_VisualScriptNode_method_get_visual_script: -- :ref:`VisualScript` **get_visual_script** **(** **)** const +- :ref:`VisualScript` **get_visual_script** **(** **)** |const| Returns the :ref:`VisualScript` instance the node is bound to. @@ -75,3 +75,6 @@ Notify that the node's ports have changed. Usually used in conjunction with :ref Change the default value of a given port. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 474fc4b49..9c0c135d0 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -64,3 +64,6 @@ Property Descriptions | *Getter* | get_typed() | +-----------+------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index 29b9411ad..d6bad1da9 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -48,3 +48,6 @@ Property Descriptions The :ref:`Resource` to load. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 1e7931b6c..ab912147d 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -142,3 +142,6 @@ Property Descriptions | *Getter* | get_call_mode() | +-----------+----------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 92ab29cbd..07463705d 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -212,3 +212,6 @@ Property Descriptions | *Getter* | get_call_mode() | +-----------+----------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index ec95fc3d8..3fb04fe72 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -35,3 +35,6 @@ Property Descriptions | *Getter* | get_resource_path() | +-----------+--------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 83749038c..fa80c5ddc 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -70,3 +70,6 @@ If ``true``, the ``return`` input port is available. The return value's data type. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index e821457b4..e33592cf6 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -50,3 +50,6 @@ Property Descriptions The node's path in the scene tree. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptscenetree.rst b/classes/class_visualscriptscenetree.rst index 40e3c1060..030689c1c 100644 --- a/classes/class_visualscriptscenetree.rst +++ b/classes/class_visualscriptscenetree.rst @@ -13,3 +13,6 @@ VisualScriptSceneTree +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index 64cf5f7bf..2a2487610 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -54,3 +54,6 @@ Property Descriptions The input variables' type. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptself.rst b/classes/class_visualscriptself.rst index 59f2d1129..9069ae52f 100644 --- a/classes/class_visualscriptself.rst +++ b/classes/class_visualscriptself.rst @@ -26,3 +26,6 @@ none - Data (object): ``instance`` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index 7816c1ea2..23ca9dc75 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -54,3 +54,6 @@ Property Descriptions The number of steps in the sequence. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index ad64f1664..c6908c80c 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -16,14 +16,17 @@ VisualScriptSubCall Methods ------- -+-------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_subcall` **(** :ref:`Variant` arguments **)** |virtual| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_VisualScriptSubCall_method__subcall: -- :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** virtual +- :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** |virtual| +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptswitch.rst b/classes/class_visualscriptswitch.rst index d84c9334c..4e646c135 100644 --- a/classes/class_visualscriptswitch.rst +++ b/classes/class_visualscriptswitch.rst @@ -36,3 +36,6 @@ Branches the flow based on an input's value. Use **Case Count** in the Inspector - Sequence: ``done`` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 8f74b7060..788359bcf 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -51,3 +51,6 @@ Property Descriptions | *Getter* | get_base_type() | +-----------+----------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 32a308daf..5ea8c2c19 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -50,3 +50,6 @@ Property Descriptions The variable's name. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 219d6ca08..1d6cce8fe 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -52,3 +52,6 @@ Property Descriptions The variable's name. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptwhile.rst b/classes/class_visualscriptwhile.rst index 4fefd5673..6795c78c6 100644 --- a/classes/class_visualscriptwhile.rst +++ b/classes/class_visualscriptwhile.rst @@ -30,3 +30,6 @@ Loops while a condition is ``true``. Execution continues out the ``exit`` Sequen - Sequence: ``exit`` +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 789b8a360..c94af2707 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -68,3 +68,6 @@ Property Descriptions | *Getter* | get_wait_time() | +----------+----------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index b9a006d8c..bd3be2047 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -100,3 +100,6 @@ Property Descriptions | *Getter* | get_signal() | +-----------+-------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index f6bb1f0b0..1f4015f94 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -262,35 +262,35 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_test_texture` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_adapter_name` **(** **)** const | +| :ref:`String` | :ref:`get_video_adapter_name` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** const | +| :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_white_texture` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`gi_probe_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_bias` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_bias` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`gi_probe_get_bounds` **(** :ref:`RID` probe **)** const | +| :ref:`AABB` | :ref:`gi_probe_get_bounds` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_cell_size` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_cell_size` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :ref:`RID` probe **)** const | +| :ref:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gi_probe_get_dynamic_range` **(** :ref:`RID` probe **)** const | +| :ref:`int` | :ref:`gi_probe_get_dynamic_range` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_energy` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_energy` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_normal_bias` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_normal_bias` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_propagation` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_propagation` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`gi_probe_get_to_cell_xform` **(** :ref:`RID` probe **)** const | +| :ref:`Transform` | :ref:`gi_probe_get_to_cell_xform` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gi_probe_is_compressed` **(** :ref:`RID` probe **)** const | +| :ref:`bool` | :ref:`gi_probe_is_compressed` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gi_probe_is_interior` **(** :ref:`RID` probe **)** const | +| :ref:`bool` | :ref:`gi_probe_is_interior` **(** :ref:`RID` probe **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`gi_probe_set_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -314,11 +314,11 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`gi_probe_set_to_cell_xform` **(** :ref:`RID` probe, :ref:`Transform` xform **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_changed` **(** **)** const | +| :ref:`bool` | :ref:`has_changed` **(** **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** const | +| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | +| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`immediate_begin` **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -330,7 +330,7 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | +| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -388,11 +388,11 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const | +| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** const | +| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const | +| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -424,15 +424,15 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :ref:`RID` capture **)** const | +| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :ref:`RID` capture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lightmap_capture_get_energy` **(** :ref:`RID` capture **)** const | +| :ref:`float` | :ref:`lightmap_capture_get_energy` **(** :ref:`RID` capture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`lightmap_capture_get_octree` **(** :ref:`RID` capture **)** const | +| :ref:`PoolByteArray` | :ref:`lightmap_capture_get_octree` **(** :ref:`RID` capture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`lightmap_capture_get_octree_cell_subdiv` **(** :ref:`RID` capture **)** const | +| :ref:`int` | :ref:`lightmap_capture_get_octree_cell_subdiv` **(** :ref:`RID` capture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`lightmap_capture_get_octree_cell_transform` **(** :ref:`RID` capture **)** const | +| :ref:`Transform` | :ref:`lightmap_capture_get_octree_cell_transform` **(** :ref:`RID` capture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -448,11 +448,11 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`material_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`String` parameter **)** const | +| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`String` parameter **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`material_get_param_default` **(** :ref:`RID` material, :ref:`String` parameter **)** const | +| :ref:`Variant` | :ref:`material_get_param_default` **(** :ref:`RID` material, :ref:`String` parameter **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | +| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -470,13 +470,13 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`mesh_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** const | +| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | +| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :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 | +| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_remove_surface` **(** :ref:`RID` mesh, :ref:`int` index **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -486,31 +486,31 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :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 | +| :ref:`PoolByteArray` | :ref:`mesh_surface_get_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const | +| :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_stride` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** const | +| :ref:`int` | :ref:`mesh_surface_get_format_stride` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`mesh_surface_get_index_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`PoolByteArray` | :ref:`mesh_surface_get_index_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PrimitiveType` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`PrimitiveType` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_skeleton_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`Array` | :ref:`mesh_surface_get_skeleton_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -520,21 +520,21 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`multimesh_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** const | +| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** const | +| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** const | +| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** const | +| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +| :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -646,11 +646,11 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shader_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** const | +| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name **)** const | +| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | +| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -658,9 +658,9 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skeleton_allocate` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | +| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | +| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -668,7 +668,7 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`skeleton_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | +| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`sky_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -688,23 +688,23 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const | +| :ref:`Image` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_depth` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_depth` **(** :ref:`RID` texture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** const | +| :ref:`Format` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** const | +| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_texid` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_texid` **(** :ref:`RID` texture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TextureType` | :ref:`texture_get_type` **(** :ref:`RID` texture **)** const | +| :ref:`TextureType` | :ref:`texture_get_type` **(** :ref:`RID` texture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -732,7 +732,7 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | +| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** |const| | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -2818,7 +2818,7 @@ Returns the id of the test texture. Creates one if none exists. .. _class_VisualServer_method_get_video_adapter_name: -- :ref:`String` **get_video_adapter_name** **(** **)** const +- :ref:`String` **get_video_adapter_name** **(** **)** |const| Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). @@ -2828,7 +2828,7 @@ Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). .. _class_VisualServer_method_get_video_adapter_vendor: -- :ref:`String` **get_video_adapter_vendor** **(** **)** const +- :ref:`String` **get_video_adapter_vendor** **(** **)** |const| Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). @@ -2858,7 +2858,7 @@ To place in a scene, attach this GI probe to an instance using :ref:`instance_se .. _class_VisualServer_method_gi_probe_get_bias: -- :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** |const| Returns the bias value for the GI probe. Bias is used to avoid self occlusion. Equivalent to :ref:`GIProbeData.bias`. @@ -2866,7 +2866,7 @@ Returns the bias value for the GI probe. Bias is used to avoid self occlusion. E .. _class_VisualServer_method_gi_probe_get_bounds: -- :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** const +- :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** |const| Returns the axis-aligned bounding box that covers the full extent of the GI probe. @@ -2874,7 +2874,7 @@ Returns the axis-aligned bounding box that covers the full extent of the GI prob .. _class_VisualServer_method_gi_probe_get_cell_size: -- :ref:`float` **gi_probe_get_cell_size** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_cell_size** **(** :ref:`RID` probe **)** |const| Returns the cell size set by :ref:`gi_probe_set_cell_size`. @@ -2882,7 +2882,7 @@ Returns the cell size set by :ref:`gi_probe_set_cell_size` **gi_probe_get_dynamic_data** **(** :ref:`RID` probe **)** const +- :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` probe **)** |const| Returns the data used by the GI probe. @@ -2890,7 +2890,7 @@ Returns the data used by the GI probe. .. _class_VisualServer_method_gi_probe_get_dynamic_range: -- :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** const +- :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** |const| Returns the dynamic range set for this GI probe. Equivalent to :ref:`GIProbe.dynamic_range`. @@ -2898,7 +2898,7 @@ Returns the dynamic range set for this GI probe. Equivalent to :ref:`GIProbe.dyn .. _class_VisualServer_method_gi_probe_get_energy: -- :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** |const| Returns the energy multiplier for this GI probe. Equivalent to :ref:`GIProbe.energy`. @@ -2906,7 +2906,7 @@ Returns the energy multiplier for this GI probe. Equivalent to :ref:`GIProbe.ene .. _class_VisualServer_method_gi_probe_get_normal_bias: -- :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** |const| Returns the normal bias for this GI probe. Equivalent to :ref:`GIProbe.normal_bias`. @@ -2914,7 +2914,7 @@ Returns the normal bias for this GI probe. Equivalent to :ref:`GIProbe.normal_bi .. _class_VisualServer_method_gi_probe_get_propagation: -- :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** |const| Returns the propagation value for this GI probe. Equivalent to :ref:`GIProbe.propagation`. @@ -2922,7 +2922,7 @@ Returns the propagation value for this GI probe. Equivalent to :ref:`GIProbe.pro .. _class_VisualServer_method_gi_probe_get_to_cell_xform: -- :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` probe **)** const +- :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` probe **)** |const| Returns the Transform set by :ref:`gi_probe_set_to_cell_xform`. @@ -2930,7 +2930,7 @@ Returns the Transform set by :ref:`gi_probe_set_to_cell_xform` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** const +- :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** |const| Returns ``true`` if the GI probe data associated with this GI probe is compressed. Equivalent to :ref:`GIProbe.compress`. @@ -2938,7 +2938,7 @@ Returns ``true`` if the GI probe data associated with this GI probe is compresse .. _class_VisualServer_method_gi_probe_is_interior: -- :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** const +- :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** |const| Returns ``true`` if the GI probe is set to interior, meaning it does not account for sky light. Equivalent to :ref:`GIProbe.interior`. @@ -3034,7 +3034,7 @@ Sets the to cell :ref:`Transform` for this GI probe. .. _class_VisualServer_method_has_changed: -- :ref:`bool` **has_changed** **(** **)** const +- :ref:`bool` **has_changed** **(** **)** |const| Returns ``true`` if changes have been made to the VisualServer's data. :ref:`draw` is usually called if this happens. @@ -3042,7 +3042,7 @@ Returns ``true`` if changes have been made to the VisualServer's data. :ref:`dra .. _class_VisualServer_method_has_feature: -- :ref:`bool` **has_feature** **(** :ref:`Features` feature **)** const +- :ref:`bool` **has_feature** **(** :ref:`Features` feature **)** |const| Not yet implemented. Always returns ``false``. @@ -3050,7 +3050,7 @@ Not yet implemented. Always returns ``false``. .. _class_VisualServer_method_has_os_feature: -- :ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** const +- :ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** |const| Returns ``true`` if the OS supports a certain feature. Features might be ``s3tc``, ``etc``, ``etc2`` and ``pvrtc``. @@ -3102,7 +3102,7 @@ Ends drawing the :ref:`ImmediateGeometry` and displays .. _class_VisualServer_method_immediate_get_material: -- :ref:`RID` **immediate_get_material** **(** :ref:`RID` immediate **)** const +- :ref:`RID` **immediate_get_material** **(** :ref:`RID` immediate **)** |const| Returns the material assigned to the :ref:`ImmediateGeometry`. @@ -3340,7 +3340,7 @@ Sets whether an instance is drawn or not. Equivalent to :ref:`Spatial.visible` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const +- :ref:`Array` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** |const| Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as :ref:`MeshInstance` or :ref:`DirectionalLight`. Use :ref:`@GDScript.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World` you want to query. This forces an update for all resources queued to update. @@ -3350,7 +3350,7 @@ Returns an array of object IDs intersecting with the provided AABB. Only visual .. _class_VisualServer_method_instances_cull_convex: -- :ref:`Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** const +- :ref:`Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** |const| Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as :ref:`MeshInstance` or :ref:`DirectionalLight`. Use :ref:`@GDScript.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World` you want to query. This forces an update for all resources queued to update. @@ -3360,7 +3360,7 @@ Returns an array of object IDs intersecting with the provided convex shape. Only .. _class_VisualServer_method_instances_cull_ray: -- :ref:`Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const +- :ref:`Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** |const| Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as :ref:`MeshInstance` or :ref:`DirectionalLight`. Use :ref:`@GDScript.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World` you want to query. This forces an update for all resources queued to update. @@ -3494,7 +3494,7 @@ To place in a scene, attach this lightmap capture to an instance using :ref:`ins .. _class_VisualServer_method_lightmap_capture_get_bounds: -- :ref:`AABB` **lightmap_capture_get_bounds** **(** :ref:`RID` capture **)** const +- :ref:`AABB` **lightmap_capture_get_bounds** **(** :ref:`RID` capture **)** |const| Returns the size of the lightmap capture area. @@ -3502,7 +3502,7 @@ Returns the size of the lightmap capture area. .. _class_VisualServer_method_lightmap_capture_get_energy: -- :ref:`float` **lightmap_capture_get_energy** **(** :ref:`RID` capture **)** const +- :ref:`float` **lightmap_capture_get_energy** **(** :ref:`RID` capture **)** |const| Returns the energy multiplier used by the lightmap capture. @@ -3510,7 +3510,7 @@ Returns the energy multiplier used by the lightmap capture. .. _class_VisualServer_method_lightmap_capture_get_octree: -- :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const +- :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** |const| Returns the octree used by the lightmap capture. @@ -3518,7 +3518,7 @@ Returns the octree used by the lightmap capture. .. _class_VisualServer_method_lightmap_capture_get_octree_cell_subdiv: -- :ref:`int` **lightmap_capture_get_octree_cell_subdiv** **(** :ref:`RID` capture **)** const +- :ref:`int` **lightmap_capture_get_octree_cell_subdiv** **(** :ref:`RID` capture **)** |const| Returns the cell subdivision amount used by this lightmap capture's octree. @@ -3526,7 +3526,7 @@ Returns the cell subdivision amount used by this lightmap capture's octree. .. _class_VisualServer_method_lightmap_capture_get_octree_cell_transform: -- :ref:`Transform` **lightmap_capture_get_octree_cell_transform** **(** :ref:`RID` capture **)** const +- :ref:`Transform` **lightmap_capture_get_octree_cell_transform** **(** :ref:`RID` capture **)** |const| Returns the cell transform for this lightmap capture's octree. @@ -3592,7 +3592,7 @@ Once finished with your RID, you will want to free the RID using the VisualServe .. _class_VisualServer_method_material_get_param: -- :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** const +- :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** |const| Returns the value of a certain material's parameter. @@ -3600,7 +3600,7 @@ Returns the value of a certain material's parameter. .. _class_VisualServer_method_material_get_param_default: -- :ref:`Variant` **material_get_param_default** **(** :ref:`RID` material, :ref:`String` parameter **)** const +- :ref:`Variant` **material_get_param_default** **(** :ref:`RID` material, :ref:`String` parameter **)** |const| Returns the default value for the param if available. Otherwise returns an empty :ref:`Variant`. @@ -3608,7 +3608,7 @@ Returns the default value for the param if available. Otherwise returns an empty .. _class_VisualServer_method_material_get_shader: -- :ref:`RID` **material_get_shader** **(** :ref:`RID` shader_material **)** const +- :ref:`RID` **material_get_shader** **(** :ref:`RID` shader_material **)** |const| Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader. @@ -3684,7 +3684,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. _class_VisualServer_method_mesh_get_blend_shape_count: -- :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** const +- :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** |const| Returns a mesh's blend shape count. @@ -3692,7 +3692,7 @@ Returns a mesh's blend shape count. .. _class_VisualServer_method_mesh_get_blend_shape_mode: -- :ref:`BlendShapeMode` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** const +- :ref:`BlendShapeMode` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** |const| Returns a mesh's blend shape mode. @@ -3700,7 +3700,7 @@ Returns a mesh's blend shape mode. .. _class_VisualServer_method_mesh_get_custom_aabb: -- :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const +- :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** |const| Returns a mesh's custom aabb. @@ -3708,7 +3708,7 @@ Returns a mesh's custom aabb. .. _class_VisualServer_method_mesh_get_surface_count: -- :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** const +- :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** |const| Returns a mesh's number of surfaces. @@ -3748,7 +3748,7 @@ Sets a mesh's custom aabb. .. _class_VisualServer_method_mesh_surface_get_aabb: -- :ref:`AABB` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`AABB` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's aabb. @@ -3756,7 +3756,7 @@ Returns a mesh's surface's aabb. .. _class_VisualServer_method_mesh_surface_get_array: -- :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's vertex buffer. @@ -3764,7 +3764,7 @@ Returns a mesh's surface's vertex buffer. .. _class_VisualServer_method_mesh_surface_get_array_index_len: -- :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's amount of indices. @@ -3772,7 +3772,7 @@ Returns a mesh's surface's amount of indices. .. _class_VisualServer_method_mesh_surface_get_array_len: -- :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's amount of vertices. @@ -3780,7 +3780,7 @@ Returns a mesh's surface's amount of vertices. .. _class_VisualServer_method_mesh_surface_get_arrays: -- :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's buffer arrays. @@ -3788,7 +3788,7 @@ Returns a mesh's surface's buffer arrays. .. _class_VisualServer_method_mesh_surface_get_blend_shape_arrays: -- :ref:`Array` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Array` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's arrays for blend shapes. @@ -3796,7 +3796,7 @@ Returns a mesh's surface's arrays for blend shapes. .. _class_VisualServer_method_mesh_surface_get_format: -- :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns the format of a mesh's surface. @@ -3804,7 +3804,7 @@ Returns the format of a mesh's surface. .. _class_VisualServer_method_mesh_surface_get_format_offset: -- :ref:`int` **mesh_surface_get_format_offset** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const +- :ref:`int` **mesh_surface_get_format_offset** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** |const| Function is unused in Godot 3.x. @@ -3812,7 +3812,7 @@ Function is unused in Godot 3.x. .. _class_VisualServer_method_mesh_surface_get_format_stride: -- :ref:`int` **mesh_surface_get_format_stride** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** const +- :ref:`int` **mesh_surface_get_format_stride** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** |const| Function is unused in Godot 3.x. @@ -3820,7 +3820,7 @@ Function is unused in Godot 3.x. .. _class_VisualServer_method_mesh_surface_get_index_array: -- :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's index buffer. @@ -3828,7 +3828,7 @@ Returns a mesh's surface's index buffer. .. _class_VisualServer_method_mesh_surface_get_material: -- :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's material. @@ -3836,7 +3836,7 @@ Returns a mesh's surface's material. .. _class_VisualServer_method_mesh_surface_get_primitive_type: -- :ref:`PrimitiveType` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`PrimitiveType` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns the primitive type of a mesh's surface. @@ -3844,7 +3844,7 @@ Returns the primitive type of a mesh's surface. .. _class_VisualServer_method_mesh_surface_get_skeleton_aabb: -- :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns the aabb of a mesh's surface's skeleton. @@ -3888,7 +3888,7 @@ To place in a scene, attach this multimesh to an instance using :ref:`instance_s .. _class_VisualServer_method_multimesh_get_aabb: -- :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** const +- :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** |const| Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh. @@ -3896,7 +3896,7 @@ Calculates and returns the axis-aligned bounding box that encloses all instances .. _class_VisualServer_method_multimesh_get_instance_count: -- :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** const +- :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** |const| Returns the number of instances allocated for this multimesh. @@ -3904,7 +3904,7 @@ Returns the number of instances allocated for this multimesh. .. _class_VisualServer_method_multimesh_get_mesh: -- :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** const +- :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** |const| Returns the RID of the mesh that will be used in drawing this multimesh. @@ -3912,7 +3912,7 @@ Returns the RID of the mesh that will be used in drawing this multimesh. .. _class_VisualServer_method_multimesh_get_visible_instances: -- :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** const +- :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** |const| Returns the number of visible instances for this multimesh. @@ -3920,7 +3920,7 @@ Returns the number of visible instances for this multimesh. .. _class_VisualServer_method_multimesh_instance_get_color: -- :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +- :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| Returns the color by which the specified instance will be modulated. @@ -3928,7 +3928,7 @@ Returns the color by which the specified instance will be modulated. .. _class_VisualServer_method_multimesh_instance_get_custom_data: -- :ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +- :ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| Returns the custom data associated with the specified instance. @@ -3936,7 +3936,7 @@ Returns the custom data associated with the specified instance. .. _class_VisualServer_method_multimesh_instance_get_transform: -- :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +- :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| Returns the :ref:`Transform` of the specified instance. @@ -3944,7 +3944,7 @@ Returns the :ref:`Transform` of the specified instance. .. _class_VisualServer_method_multimesh_instance_get_transform_2d: -- :ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +- :ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| Returns the :ref:`Transform2D` of the specified instance. For use when the multimesh is set to use 2D transforms. @@ -4422,7 +4422,7 @@ Once finished with your RID, you will want to free the RID using the VisualServe .. _class_VisualServer_method_shader_get_code: -- :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** const +- :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** |const| Returns a shader's code. @@ -4430,7 +4430,7 @@ Returns a shader's code. .. _class_VisualServer_method_shader_get_default_texture_param: -- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** const +- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** |const| Returns a default texture from a shader searched by name. @@ -4438,7 +4438,7 @@ Returns a default texture from a shader searched by name. .. _class_VisualServer_method_shader_get_param_list: -- :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const +- :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** |const| Returns the parameters of a shader. @@ -4470,7 +4470,7 @@ Allocates the GPU buffers for this skeleton. .. _class_VisualServer_method_skeleton_bone_get_transform: -- :ref:`Transform` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const +- :ref:`Transform` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| Returns the :ref:`Transform` set for a specific bone of this skeleton. @@ -4478,7 +4478,7 @@ Returns the :ref:`Transform` set for a specific bone of this sk .. _class_VisualServer_method_skeleton_bone_get_transform_2d: -- :ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const +- :ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| Returns the :ref:`Transform2D` set for a specific bone of this skeleton. @@ -4512,7 +4512,7 @@ Once finished with your RID, you will want to free the RID using the VisualServe .. _class_VisualServer_method_skeleton_get_bone_count: -- :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** const +- :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** |const| Returns the number of bones allocated for this skeleton. @@ -4600,7 +4600,7 @@ Returns a list of all the textures and their information. .. _class_VisualServer_method_texture_get_data: -- :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const +- :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** |const| Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the :ref:`RID` of the image at one of the cubes sides. @@ -4608,7 +4608,7 @@ Returns a copy of a texture's image unless it's a CubeMap, in which case it retu .. _class_VisualServer_method_texture_get_depth: -- :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** |const| Returns the depth of the texture. @@ -4616,7 +4616,7 @@ Returns the depth of the texture. .. _class_VisualServer_method_texture_get_flags: -- :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** |const| Returns the flags of a texture. @@ -4624,7 +4624,7 @@ Returns the flags of a texture. .. _class_VisualServer_method_texture_get_format: -- :ref:`Format` **texture_get_format** **(** :ref:`RID` texture **)** const +- :ref:`Format` **texture_get_format** **(** :ref:`RID` texture **)** |const| Returns the format of the texture's image. @@ -4632,7 +4632,7 @@ Returns the format of the texture's image. .. _class_VisualServer_method_texture_get_height: -- :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** |const| Returns the texture's height. @@ -4640,7 +4640,7 @@ Returns the texture's height. .. _class_VisualServer_method_texture_get_path: -- :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const +- :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** |const| Returns the texture's path. @@ -4648,7 +4648,7 @@ Returns the texture's path. .. _class_VisualServer_method_texture_get_texid: -- :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** |const| Returns the opengl id of the texture's image. @@ -4656,7 +4656,7 @@ Returns the opengl id of the texture's image. .. _class_VisualServer_method_texture_get_type: -- :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** const +- :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** |const| Returns the type of the texture, can be any of the :ref:`TextureType`. @@ -4664,7 +4664,7 @@ Returns the type of the texture, can be any of the :ref:`TextureType` **texture_get_width** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** |const| Returns the texture's width. @@ -4788,7 +4788,7 @@ Returns a viewport's render information. For options, see the :ref:`ViewportRend .. _class_VisualServer_method_viewport_get_texture: -- :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** const +- :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** |const| Returns the viewport's last rendered frame. @@ -4988,3 +4988,6 @@ If ``true``, the viewport uses augmented or virtual reality technologies. See :r If ``true``, the viewport's rendering is flipped vertically. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index f0fd2a718..ae918ecd6 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -23,44 +23,42 @@ The visual shader editor creates the shader. Properties ---------- -+-------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | code | ``"shader_type spatial;void vertex() {// Output:0}void fragment() {// Output:0}void light() {// Output:0}"`` *(parent override)* | -+-------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`graph_offset` | ``Vector2( 0, 0 )`` | -+-------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`graph_offset` | ``Vector2( 0, 0 )`` | ++-------------------------------+---------------------------------------------------------------+---------------------+ Methods ------- -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_nodes_forced` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualShaderNode` | :ref:`get_node` **(** :ref:`Type` type, :ref:`int` id **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_connections` **(** :ref:`Type` type **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_node_list` **(** :ref:`Type` type **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`Type` type, :ref:`int` id **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_valid_node_id` **(** :ref:`Type` type **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_connection` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`Type` type, :ref:`int` id **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`Mode` mode **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_nodes_forced` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VisualShaderNode` | :ref:`get_node` **(** :ref:`Type` type, :ref:`int` id **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_node_connections` **(** :ref:`Type` type **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_node_list` **(** :ref:`Type` type **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`Type` type, :ref:`int` id **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_valid_node_id` **(** :ref:`Type` type **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_node_connection` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`Type` type, :ref:`int` id **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`Mode` mode **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -126,7 +124,7 @@ Adds the specified node to the shader. .. _class_VisualShader_method_can_connect_nodes: -- :ref:`bool` **can_connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +- :ref:`bool` **can_connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| Returns ``true`` if the specified nodes and ports can be connected together. @@ -158,7 +156,7 @@ Connects the specified nodes and ports. .. _class_VisualShader_method_get_node: -- :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** const +- :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** |const| Returns the shader node instance with specified ``type`` and ``id``. @@ -166,7 +164,7 @@ Returns the shader node instance with specified ``type`` and ``id``. .. _class_VisualShader_method_get_node_connections: -- :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** const +- :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** |const| Returns the list of connected nodes with the specified type. @@ -174,7 +172,7 @@ Returns the list of connected nodes with the specified type. .. _class_VisualShader_method_get_node_list: -- :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** const +- :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** |const| Returns the list of all nodes in the shader with the specified type. @@ -182,7 +180,7 @@ Returns the list of all nodes in the shader with the specified type. .. _class_VisualShader_method_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** |const| Returns the position of the specified node within the shader graph. @@ -190,13 +188,13 @@ Returns the position of the specified node within the shader graph. .. _class_VisualShader_method_get_valid_node_id: -- :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** const +- :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** |const| ---- .. _class_VisualShader_method_is_node_connection: -- :ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +- :ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| Returns ``true`` if the specified node and port connection exist. @@ -224,3 +222,6 @@ Sets the mode of this shader. Sets the position of the specified node. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index d1ff8c1fa..e29a10851 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -31,9 +31,9 @@ Methods ------- +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_default_input_values` **(** **)** const | +| :ref:`Array` | :ref:`get_default_input_values` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_input_port_default_value` **(** :ref:`int` port **)** const | +| :ref:`Variant` | :ref:`get_input_port_default_value` **(** :ref:`int` port **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_input_values` **(** :ref:`Array` values **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -102,7 +102,7 @@ Method Descriptions .. _class_VisualShaderNode_method_get_default_input_values: -- :ref:`Array` **get_default_input_values** **(** **)** const +- :ref:`Array` **get_default_input_values** **(** **)** |const| Returns an :ref:`Array` containing default values for all of the input ports of the node in the form ``[index0, value0, index1, value1, ...]``. @@ -110,7 +110,7 @@ Returns an :ref:`Array` containing default values for all of the in .. _class_VisualShaderNode_method_get_input_port_default_value: -- :ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** const +- :ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** |const| Returns the default value of the input ``port``. @@ -130,3 +130,6 @@ Sets the default input ports values using an :ref:`Array` of the fo Sets the default value for the selected input ``port``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodebooleanconstant.rst b/classes/class_visualshadernodebooleanconstant.rst index 105909924..a1bd3ea2f 100644 --- a/classes/class_visualshadernodebooleanconstant.rst +++ b/classes/class_visualshadernodebooleanconstant.rst @@ -44,3 +44,6 @@ Property Descriptions A boolean constant which represents a state of this node. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodebooleanuniform.rst b/classes/class_visualshadernodebooleanuniform.rst index 9b36161f7..eb7e48837 100644 --- a/classes/class_visualshadernodebooleanuniform.rst +++ b/classes/class_visualshadernodebooleanuniform.rst @@ -18,3 +18,6 @@ Description Translated to ``uniform bool`` in the shader language. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index cbc53def5..c448e58ad 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -44,3 +44,6 @@ Property Descriptions A :ref:`Color` constant which represents a state of this node. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodecolorfunc.rst b/classes/class_visualshadernodecolorfunc.rst index 2f7ec7376..632966885 100644 --- a/classes/class_visualshadernodecolorfunc.rst +++ b/classes/class_visualshadernodecolorfunc.rst @@ -73,3 +73,6 @@ Property Descriptions A function to be applied to the input color. See :ref:`Function` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index 84ec65d5a..2262effea 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -145,3 +145,6 @@ Property Descriptions An operator to be applied to the inputs. See :ref:`Operator` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodecoloruniform.rst b/classes/class_visualshadernodecoloruniform.rst index aa08b5c09..6ce706f55 100644 --- a/classes/class_visualshadernodecoloruniform.rst +++ b/classes/class_visualshadernodecoloruniform.rst @@ -18,3 +18,6 @@ Description Translated to ``uniform vec4`` in the shader language. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodecompare.rst b/classes/class_visualshadernodecompare.rst index eaf88aebd..d78fc0917 100644 --- a/classes/class_visualshadernodecompare.rst +++ b/classes/class_visualshadernodecompare.rst @@ -145,3 +145,6 @@ A comparison function. See :ref:`Function The type to be used in the comparison. See :ref:`ComparisonType` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 52a7d5cfd..97615b72b 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -109,3 +109,6 @@ Defines which source should be used for the sampling. See :ref:`Source` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodecubemapuniform.rst b/classes/class_visualshadernodecubemapuniform.rst index 2cfb0bd6e..d983a539d 100644 --- a/classes/class_visualshadernodecubemapuniform.rst +++ b/classes/class_visualshadernodecubemapuniform.rst @@ -18,3 +18,6 @@ Description Translated to ``uniform samplerCube`` in the shader language. The output value can be used as port for :ref:`VisualShaderNodeCubeMap`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodecustom.rst b/classes/class_visualshadernodecustom.rst index b3b65887d..30c974bf2 100644 --- a/classes/class_visualshadernodecustom.rst +++ b/classes/class_visualshadernodecustom.rst @@ -34,40 +34,40 @@ Tutorials Methods ------- -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_category` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_code` **(** :ref:`Array` input_vars, :ref:`Array` output_vars, :ref:`int` mode, :ref:`int` type **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_description` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_global_code` **(** :ref:`int` mode **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_input_port_count` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_input_port_name` **(** :ref:`int` port **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_input_port_type` **(** :ref:`int` port **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_name` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_port_count` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_output_port_name` **(** :ref:`int` port **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_port_type` **(** :ref:`int` port **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_return_icon_type` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_subcategory` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_category` **(** **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_code` **(** :ref:`Array` input_vars, :ref:`Array` output_vars, :ref:`int` mode, :ref:`int` type **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_description` **(** **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_global_code` **(** :ref:`int` mode **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_port_count` **(** **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_input_port_name` **(** :ref:`int` port **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_port_type` **(** :ref:`int` port **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_name` **(** **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_port_count` **(** **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_output_port_name` **(** :ref:`int` port **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_port_type` **(** :ref:`int` port **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_return_icon_type` **(** **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_subcategory` **(** **)** |virtual| | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_VisualShaderNodeCustom_method__get_category: -- :ref:`String` **_get_category** **(** **)** virtual +- :ref:`String` **_get_category** **(** **)** |virtual| Override this method to define the category of the associated custom node in the Visual Shader Editor's members dialog. @@ -77,7 +77,7 @@ Defining this method is **optional**. If not overridden, the node will be filed .. _class_VisualShaderNodeCustom_method__get_code: -- :ref:`String` **_get_code** **(** :ref:`Array` input_vars, :ref:`Array` output_vars, :ref:`int` mode, :ref:`int` type **)** virtual +- :ref:`String` **_get_code** **(** :ref:`Array` input_vars, :ref:`Array` output_vars, :ref:`int` mode, :ref:`int` type **)** |virtual| Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the ``"""`` multiline string construct can be used for convenience). @@ -93,7 +93,7 @@ Defining this method is **required**. .. _class_VisualShaderNodeCustom_method__get_description: -- :ref:`String` **_get_description** **(** **)** virtual +- :ref:`String` **_get_description** **(** **)** |virtual| Override this method to define the description of the associated custom node in the Visual Shader Editor's members dialog. @@ -103,7 +103,7 @@ Defining this method is **optional**. .. _class_VisualShaderNodeCustom_method__get_global_code: -- :ref:`String` **_get_global_code** **(** :ref:`int` mode **)** virtual +- :ref:`String` **_get_global_code** **(** :ref:`int` mode **)** |virtual| Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the ``"""`` multiline string construct can be used for convenience). @@ -117,7 +117,7 @@ Defining this method is **optional**. .. _class_VisualShaderNodeCustom_method__get_input_port_count: -- :ref:`int` **_get_input_port_count** **(** **)** virtual +- :ref:`int` **_get_input_port_count** **(** **)** |virtual| Override this method to define the amount of input ports of the associated custom node. @@ -127,7 +127,7 @@ Defining this method is **required**. If not overridden, the node has no input p .. _class_VisualShaderNodeCustom_method__get_input_port_name: -- :ref:`String` **_get_input_port_name** **(** :ref:`int` port **)** virtual +- :ref:`String` **_get_input_port_name** **(** :ref:`int` port **)** |virtual| Override this method to define the names of input ports of the associated custom node. The names are used both for the input slots in the editor and as identifiers in the shader code, and are passed in the ``input_vars`` array in :ref:`_get_code`. @@ -137,7 +137,7 @@ Defining this method is **optional**, but recommended. If not overridden, input .. _class_VisualShaderNodeCustom_method__get_input_port_type: -- :ref:`int` **_get_input_port_type** **(** :ref:`int` port **)** virtual +- :ref:`int` **_get_input_port_type** **(** :ref:`int` port **)** |virtual| Override this method to define the returned type of each input port of the associated custom node (see :ref:`PortType` for possible types). @@ -147,7 +147,7 @@ Defining this method is **optional**, but recommended. If not overridden, input .. _class_VisualShaderNodeCustom_method__get_name: -- :ref:`String` **_get_name** **(** **)** virtual +- :ref:`String` **_get_name** **(** **)** |virtual| Override this method to define the name of the associated custom node in the Visual Shader Editor's members dialog and graph. @@ -157,7 +157,7 @@ Defining this method is **optional**, but recommended. If not overridden, the no .. _class_VisualShaderNodeCustom_method__get_output_port_count: -- :ref:`int` **_get_output_port_count** **(** **)** virtual +- :ref:`int` **_get_output_port_count** **(** **)** |virtual| Override this method to define the amount of output ports of the associated custom node. @@ -167,7 +167,7 @@ Defining this method is **required**. If not overridden, the node has no output .. _class_VisualShaderNodeCustom_method__get_output_port_name: -- :ref:`String` **_get_output_port_name** **(** :ref:`int` port **)** virtual +- :ref:`String` **_get_output_port_name** **(** :ref:`int` port **)** |virtual| Override this method to define the names of output ports of the associated custom node. The names are used both for the output slots in the editor and as identifiers in the shader code, and are passed in the ``output_vars`` array in :ref:`_get_code`. @@ -177,7 +177,7 @@ Defining this method is **optional**, but recommended. If not overridden, output .. _class_VisualShaderNodeCustom_method__get_output_port_type: -- :ref:`int` **_get_output_port_type** **(** :ref:`int` port **)** virtual +- :ref:`int` **_get_output_port_type** **(** :ref:`int` port **)** |virtual| Override this method to define the returned type of each output port of the associated custom node (see :ref:`PortType` for possible types). @@ -187,7 +187,7 @@ Defining this method is **optional**, but recommended. If not overridden, output .. _class_VisualShaderNodeCustom_method__get_return_icon_type: -- :ref:`int` **_get_return_icon_type** **(** **)** virtual +- :ref:`int` **_get_return_icon_type** **(** **)** |virtual| Override this method to define the return icon of the associated custom node in the Visual Shader Editor's members dialog. @@ -197,9 +197,12 @@ Defining this method is **optional**. If not overridden, no return icon is shown .. _class_VisualShaderNodeCustom_method__get_subcategory: -- :ref:`String` **_get_subcategory** **(** **)** virtual +- :ref:`String` **_get_subcategory** **(** **)** |virtual| Override this method to define the subcategory of the associated custom node in the Visual Shader Editor's members dialog. Defining this method is **optional**. If not overridden, the node will be filed under the root of the main category (see :ref:`_get_category`). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodedeterminant.rst b/classes/class_visualshadernodedeterminant.rst index b788a9257..2f30c5f03 100644 --- a/classes/class_visualshadernodedeterminant.rst +++ b/classes/class_visualshadernodedeterminant.rst @@ -18,3 +18,6 @@ Description Translates to ``deteminant(x)`` in the shader language. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodedotproduct.rst b/classes/class_visualshadernodedotproduct.rst index d87a8929d..d6d842652 100644 --- a/classes/class_visualshadernodedotproduct.rst +++ b/classes/class_visualshadernodedotproduct.rst @@ -18,3 +18,6 @@ Description Translates to ``dot(a, b)`` in the shader language. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodeexpression.rst b/classes/class_visualshadernodeexpression.rst index 9411d5be8..cccbff374 100644 --- a/classes/class_visualshadernodeexpression.rst +++ b/classes/class_visualshadernodeexpression.rst @@ -46,3 +46,6 @@ Property Descriptions An expression in Godot Shading Language, which will be injected at the start of the graph's matching shader function (``vertex``, ``fragment``, or ``light``), and thus cannot be used to declare functions, varyings, uniforms, or global constants. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodefaceforward.rst b/classes/class_visualshadernodefaceforward.rst index a78f98c32..9fdaa900e 100644 --- a/classes/class_visualshadernodefaceforward.rst +++ b/classes/class_visualshadernodefaceforward.rst @@ -18,3 +18,6 @@ Description Translates to ``faceforward(N, I, Nref)`` in the shader language. The function has three vector parameters: ``N``, the vector to orient, ``I``, the incident vector, and ``Nref``, the reference vector. If the dot product of ``I`` and ``Nref`` is smaller than zero the return value is ``N``. Otherwise ``-N`` is returned. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodefresnel.rst b/classes/class_visualshadernodefresnel.rst index 595ec302f..372c0a342 100644 --- a/classes/class_visualshadernodefresnel.rst +++ b/classes/class_visualshadernodefresnel.rst @@ -18,3 +18,6 @@ Description Returns falloff based on the dot product of surface normal and view direction of camera (pass associated inputs to it). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodeglobalexpression.rst b/classes/class_visualshadernodeglobalexpression.rst index dcdb854db..d47b26e50 100644 --- a/classes/class_visualshadernodeglobalexpression.rst +++ b/classes/class_visualshadernodeglobalexpression.rst @@ -18,3 +18,6 @@ Description Custom Godot Shader Language expression, which is placed on top of the generated shader. You can place various function definitions inside to call later in :ref:`VisualShaderNodeExpression`\ s (which are injected in the main shader functions). You can also declare varyings, uniforms and global constants. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodegroupbase.rst b/classes/class_visualshadernodegroupbase.rst index 7b054884c..bec112a37 100644 --- a/classes/class_visualshadernodegroupbase.rst +++ b/classes/class_visualshadernodegroupbase.rst @@ -39,23 +39,23 @@ Methods +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_output_ports` **(** **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_free_input_port_id` **(** **)** const | +| :ref:`int` | :ref:`get_free_input_port_id` **(** **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_free_output_port_id` **(** **)** const | +| :ref:`int` | :ref:`get_free_output_port_id` **(** **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_input_port_count` **(** **)** const | +| :ref:`int` | :ref:`get_input_port_count` **(** **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_inputs` **(** **)** const | +| :ref:`String` | :ref:`get_inputs` **(** **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_output_port_count` **(** **)** const | +| :ref:`int` | :ref:`get_output_port_count` **(** **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_outputs` **(** **)** const | +| :ref:`String` | :ref:`get_outputs` **(** **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_input_port` **(** :ref:`int` id **)** const | +| :ref:`bool` | :ref:`has_input_port` **(** :ref:`int` id **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_output_port` **(** :ref:`int` id **)** const | +| :ref:`bool` | :ref:`has_output_port` **(** :ref:`int` id **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_port_name` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`is_valid_port_name` **(** :ref:`String` name **)** |const| | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_input_port` **(** :ref:`int` id **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -128,7 +128,7 @@ Removes all previously specified output ports. .. _class_VisualShaderNodeGroupBase_method_get_free_input_port_id: -- :ref:`int` **get_free_input_port_id** **(** **)** const +- :ref:`int` **get_free_input_port_id** **(** **)** |const| Returns a free input port ID which can be used in :ref:`add_input_port`. @@ -136,7 +136,7 @@ Returns a free input port ID which can be used in :ref:`add_input_port` **get_free_output_port_id** **(** **)** const +- :ref:`int` **get_free_output_port_id** **(** **)** |const| Returns a free output port ID which can be used in :ref:`add_output_port`. @@ -144,7 +144,7 @@ Returns a free output port ID which can be used in :ref:`add_output_port` **get_input_port_count** **(** **)** const +- :ref:`int` **get_input_port_count** **(** **)** |const| Returns the number of input ports in use. Alternative for :ref:`get_free_input_port_id`. @@ -152,7 +152,7 @@ Returns the number of input ports in use. Alternative for :ref:`get_free_input_p .. _class_VisualShaderNodeGroupBase_method_get_inputs: -- :ref:`String` **get_inputs** **(** **)** const +- :ref:`String` **get_inputs** **(** **)** |const| Returns a :ref:`String` description of the input ports as as colon-separated list using the format ``id,type,name;`` (see :ref:`add_input_port`). @@ -160,7 +160,7 @@ Returns a :ref:`String` description of the input ports as as colon .. _class_VisualShaderNodeGroupBase_method_get_output_port_count: -- :ref:`int` **get_output_port_count** **(** **)** const +- :ref:`int` **get_output_port_count** **(** **)** |const| Returns the number of output ports in use. Alternative for :ref:`get_free_output_port_id`. @@ -168,7 +168,7 @@ Returns the number of output ports in use. Alternative for :ref:`get_free_output .. _class_VisualShaderNodeGroupBase_method_get_outputs: -- :ref:`String` **get_outputs** **(** **)** const +- :ref:`String` **get_outputs** **(** **)** |const| Returns a :ref:`String` description of the output ports as as colon-separated list using the format ``id,type,name;`` (see :ref:`add_output_port`). @@ -176,7 +176,7 @@ Returns a :ref:`String` description of the output ports as as colo .. _class_VisualShaderNodeGroupBase_method_has_input_port: -- :ref:`bool` **has_input_port** **(** :ref:`int` id **)** const +- :ref:`bool` **has_input_port** **(** :ref:`int` id **)** |const| Returns ``true`` if the specified input port exists. @@ -184,7 +184,7 @@ Returns ``true`` if the specified input port exists. .. _class_VisualShaderNodeGroupBase_method_has_output_port: -- :ref:`bool` **has_output_port** **(** :ref:`int` id **)** const +- :ref:`bool` **has_output_port** **(** :ref:`int` id **)** |const| Returns ``true`` if the specified output port exists. @@ -192,7 +192,7 @@ Returns ``true`` if the specified output port exists. .. _class_VisualShaderNodeGroupBase_method_is_valid_port_name: -- :ref:`bool` **is_valid_port_name** **(** :ref:`String` name **)** const +- :ref:`bool` **is_valid_port_name** **(** :ref:`String` name **)** |const| Returns ``true`` if the specified port name does not override an existed port name and is valid within the shader. @@ -260,3 +260,6 @@ Sets the specified output port's type (see :ref:`PortType` formatted as a colon-separated list: ``id,type,name;`` (see :ref:`add_output_port`). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodeif.rst b/classes/class_visualshadernodeif.rst index 3073dfb43..2d9ca3f5e 100644 --- a/classes/class_visualshadernodeif.rst +++ b/classes/class_visualshadernodeif.rst @@ -13,3 +13,6 @@ VisualShaderNodeIf +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 53e3afa88..234298bb4 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -33,9 +33,9 @@ Properties Methods ------- -+-----------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_input_real_name` **(** **)** const | -+-----------------------------+------------------------------------------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_input_real_name` **(** **)** |const| | ++-----------------------------+--------------------------------------------------------------------------------------------------------+ Signals ------- @@ -66,5 +66,8 @@ Method Descriptions .. _class_VisualShaderNodeInput_method_get_input_real_name: -- :ref:`String` **get_input_real_name** **(** **)** const +- :ref:`String` **get_input_real_name** **(** **)** |const| +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodeis.rst b/classes/class_visualshadernodeis.rst index f7c0fcb18..085a7325c 100644 --- a/classes/class_visualshadernodeis.rst +++ b/classes/class_visualshadernodeis.rst @@ -57,3 +57,6 @@ Property Descriptions The comparison function. See :ref:`Function` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodeouterproduct.rst b/classes/class_visualshadernodeouterproduct.rst index 1c3ece654..a801bc469 100644 --- a/classes/class_visualshadernodeouterproduct.rst +++ b/classes/class_visualshadernodeouterproduct.rst @@ -18,3 +18,6 @@ Description ``OuterProduct`` treats the first parameter ``c`` as a column vector (matrix with one column) and the second parameter ``r`` as a row vector (matrix with one row) and does a linear algebraic matrix multiply ``c * r``, yielding a matrix whose number of rows is the number of components in ``c`` and whose number of columns is the number of components in ``r``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodeoutput.rst b/classes/class_visualshadernodeoutput.rst index 92cdc33a5..10f2d193e 100644 --- a/classes/class_visualshadernodeoutput.rst +++ b/classes/class_visualshadernodeoutput.rst @@ -18,3 +18,6 @@ Description This visual shader node is present in all shader graphs in form of "Output" block with mutliple output value ports. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodescalarclamp.rst b/classes/class_visualshadernodescalarclamp.rst index c7ae41cb9..013a7eea1 100644 --- a/classes/class_visualshadernodescalarclamp.rst +++ b/classes/class_visualshadernodescalarclamp.rst @@ -18,3 +18,6 @@ Description Constrains a value to lie between ``min`` and ``max`` values. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodescalarconstant.rst index f3658c43e..f9a9f2743 100644 --- a/classes/class_visualshadernodescalarconstant.rst +++ b/classes/class_visualshadernodescalarconstant.rst @@ -35,3 +35,6 @@ Property Descriptions | *Getter* | get_constant() | +-----------+---------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodescalarderivativefunc.rst b/classes/class_visualshadernodescalarderivativefunc.rst index e7edee8b9..e09b9061a 100644 --- a/classes/class_visualshadernodescalarderivativefunc.rst +++ b/classes/class_visualshadernodescalarderivativefunc.rst @@ -61,3 +61,6 @@ Property Descriptions The derivative type. See :ref:`Function` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst index 7021b8b38..32416c003 100644 --- a/classes/class_visualshadernodescalarfunc.rst +++ b/classes/class_visualshadernodescalarfunc.rst @@ -170,3 +170,6 @@ Property Descriptions | *Getter* | get_function() | +-----------+---------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodescalarinterp.rst b/classes/class_visualshadernodescalarinterp.rst index 30f75151a..cbc93650d 100644 --- a/classes/class_visualshadernodescalarinterp.rst +++ b/classes/class_visualshadernodescalarinterp.rst @@ -18,3 +18,6 @@ Description Translates to ``mix(a, b, weight)`` in the shader language. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst index b4833a20b..3fe29a263 100644 --- a/classes/class_visualshadernodescalarop.rst +++ b/classes/class_visualshadernodescalarop.rst @@ -82,3 +82,6 @@ Property Descriptions | *Getter* | get_operator() | +-----------+---------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodescalarsmoothstep.rst b/classes/class_visualshadernodescalarsmoothstep.rst index 7ea18247a..b7b474a40 100644 --- a/classes/class_visualshadernodescalarsmoothstep.rst +++ b/classes/class_visualshadernodescalarsmoothstep.rst @@ -20,3 +20,6 @@ Translates to ``smoothstep(edge0, edge1, x)`` in the shader language. Returns ``0.0`` if ``x`` is smaller than ``edge0`` and ``1.0`` if ``x`` is larger than ``edge1``. Otherwise the return value is interpolated between ``0.0`` and ``1.0`` using Hermite polynomials. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodescalarswitch.rst b/classes/class_visualshadernodescalarswitch.rst index d469d42df..22a2bcb5f 100644 --- a/classes/class_visualshadernodescalarswitch.rst +++ b/classes/class_visualshadernodescalarswitch.rst @@ -18,3 +18,6 @@ Description Returns an associated scalar if the provided boolean value is ``true`` or ``false``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodescalaruniform.rst b/classes/class_visualshadernodescalaruniform.rst index 5ca6b5dfb..052494e50 100644 --- a/classes/class_visualshadernodescalaruniform.rst +++ b/classes/class_visualshadernodescalaruniform.rst @@ -13,3 +13,6 @@ VisualShaderNodeScalarUniform +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodeswitch.rst b/classes/class_visualshadernodeswitch.rst index 25f9a3ba6..bfa3a234b 100644 --- a/classes/class_visualshadernodeswitch.rst +++ b/classes/class_visualshadernodeswitch.rst @@ -20,3 +20,6 @@ Description Returns an associated vector if the provided boolean value is ``true`` or ``false``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index 7b304a326..04b6cae5e 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -125,3 +125,6 @@ The source texture, if needed for the selected :ref:`source` is set to :ref:`SOURCE_TEXTURE`. See :ref:`TextureType` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index 91dd87f79..b4b1e467b 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -99,3 +99,6 @@ Sets the default color if no texture is assigned to the uniform. Defines the type of data provided by the source texture. See :ref:`TextureType` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetextureuniformtriplanar.rst b/classes/class_visualshadernodetextureuniformtriplanar.rst index 067e45b8f..b205ab7d4 100644 --- a/classes/class_visualshadernodetextureuniformtriplanar.rst +++ b/classes/class_visualshadernodetextureuniformtriplanar.rst @@ -18,3 +18,6 @@ Description Performs a lookup operation on the texture provided as a uniform for the shader, with support for triplanar mapping. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetransformcompose.rst b/classes/class_visualshadernodetransformcompose.rst index 5e71b6ec2..01eb824d5 100644 --- a/classes/class_visualshadernodetransformcompose.rst +++ b/classes/class_visualshadernodetransformcompose.rst @@ -18,3 +18,6 @@ Description Creates a 4x4 transform matrix using four vectors of type ``vec3``. Each vector is one row in the matrix and the last column is a ``vec4(0, 0, 0, 1)``. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index 11122e8fb..7225bf20e 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -42,3 +42,6 @@ Property Descriptions A :ref:`Transform` constant which represents the state of this node. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetransformdecompose.rst b/classes/class_visualshadernodetransformdecompose.rst index c31724d01..3513bb636 100644 --- a/classes/class_visualshadernodetransformdecompose.rst +++ b/classes/class_visualshadernodetransformdecompose.rst @@ -18,3 +18,6 @@ Description Takes a 4x4 transform matrix and decomposes it into four ``vec3`` values, one from each row of the matrix. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetransformfunc.rst b/classes/class_visualshadernodetransformfunc.rst index 1d627349c..db84f787f 100644 --- a/classes/class_visualshadernodetransformfunc.rst +++ b/classes/class_visualshadernodetransformfunc.rst @@ -57,3 +57,6 @@ Property Descriptions The function to be computed. See :ref:`Function` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst index 6799b1038..6426e3759 100644 --- a/classes/class_visualshadernodetransformmult.rst +++ b/classes/class_visualshadernodetransformmult.rst @@ -65,3 +65,6 @@ Property Descriptions The multiplication type to be performed on the transforms. See :ref:`Operator` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetransformuniform.rst b/classes/class_visualshadernodetransformuniform.rst index 10791c69d..3768427a1 100644 --- a/classes/class_visualshadernodetransformuniform.rst +++ b/classes/class_visualshadernodetransformuniform.rst @@ -18,3 +18,6 @@ Description Translated to ``uniform mat4`` in the shader language. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 9dbe07361..1e9ad5325 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -65,3 +65,6 @@ Property Descriptions The multiplication type to be performed. See :ref:`Operator` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index 9a8b7e9ab..c4045374a 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -44,3 +44,6 @@ Property Descriptions Name of the uniform, by which it can be accessed through the :ref:`ShaderMaterial` properties. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index 35befeef1..94ba27bcf 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -42,3 +42,6 @@ Property Descriptions A :ref:`Vector3` constant which represents the state of this node. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevec3uniform.rst b/classes/class_visualshadernodevec3uniform.rst index afb7b39c5..645f60593 100644 --- a/classes/class_visualshadernodevec3uniform.rst +++ b/classes/class_visualshadernodevec3uniform.rst @@ -18,3 +18,6 @@ Description Translated to ``uniform vec3`` in the shader language. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorclamp.rst b/classes/class_visualshadernodevectorclamp.rst index 80e16f329..b84a8c69a 100644 --- a/classes/class_visualshadernodevectorclamp.rst +++ b/classes/class_visualshadernodevectorclamp.rst @@ -18,3 +18,6 @@ Description Constrains a value to lie between ``min`` and ``max`` values. The operation is performed on each component of the vector individually. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorcompose.rst b/classes/class_visualshadernodevectorcompose.rst index 5ae408dbd..39e4f9a65 100644 --- a/classes/class_visualshadernodevectorcompose.rst +++ b/classes/class_visualshadernodevectorcompose.rst @@ -18,3 +18,6 @@ Description Creates a ``vec3`` using three scalar values that can be provided from separate inputs. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectordecompose.rst b/classes/class_visualshadernodevectordecompose.rst index 45651dbcc..524990878 100644 --- a/classes/class_visualshadernodevectordecompose.rst +++ b/classes/class_visualshadernodevectordecompose.rst @@ -18,3 +18,6 @@ Description Takes a ``vec3`` and decomposes it into three scalar values that can be used as separate inputs. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorderivativefunc.rst b/classes/class_visualshadernodevectorderivativefunc.rst index d4e7ef0e3..ceb4f79ea 100644 --- a/classes/class_visualshadernodevectorderivativefunc.rst +++ b/classes/class_visualshadernodevectorderivativefunc.rst @@ -61,3 +61,6 @@ Property Descriptions A derivative type. See :ref:`Function` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectordistance.rst b/classes/class_visualshadernodevectordistance.rst index 06075a283..f01ae9001 100644 --- a/classes/class_visualshadernodevectordistance.rst +++ b/classes/class_visualshadernodevectordistance.rst @@ -20,3 +20,6 @@ Calculates distance from point represented by vector ``p0`` to vector ``p1``. Translated to ``distance(p0, p1)`` in the shader language. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index 1d492809c..daaa2d036 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -189,3 +189,6 @@ Property Descriptions The function to be performed. See :ref:`Function` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorinterp.rst b/classes/class_visualshadernodevectorinterp.rst index e5b809fb2..59f8fcf7e 100644 --- a/classes/class_visualshadernodevectorinterp.rst +++ b/classes/class_visualshadernodevectorinterp.rst @@ -18,3 +18,6 @@ Description Translates to ``mix(a, b, weight)`` in the shader language, where ``weight`` is a :ref:`Vector3` with weights for each component. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorlen.rst b/classes/class_visualshadernodevectorlen.rst index 819f4ef68..0ce6d3523 100644 --- a/classes/class_visualshadernodevectorlen.rst +++ b/classes/class_visualshadernodevectorlen.rst @@ -18,3 +18,6 @@ Description Translated to ``length(p0)`` in the shader language. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index cf6f17a2d..aacfcff74 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -97,3 +97,6 @@ Property Descriptions The operator to be used. See :ref:`Operator` for options. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorrefract.rst b/classes/class_visualshadernodevectorrefract.rst index dfe240ba7..62308f321 100644 --- a/classes/class_visualshadernodevectorrefract.rst +++ b/classes/class_visualshadernodevectorrefract.rst @@ -18,3 +18,6 @@ Description Translated to ``refract(I, N, eta)`` in the shader language, where ``I`` is the incident vector, ``N`` is the normal vector and ``eta`` is the ratio of the indicies of the refraction. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorscalarmix.rst b/classes/class_visualshadernodevectorscalarmix.rst index 5b4621b1e..91795acd8 100644 --- a/classes/class_visualshadernodevectorscalarmix.rst +++ b/classes/class_visualshadernodevectorscalarmix.rst @@ -18,3 +18,6 @@ Description Translates to ``mix(a, b, weight)`` in the shader language, where ``a`` and ``b`` are vectors and ``weight`` is a scalar. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorscalarsmoothstep.rst b/classes/class_visualshadernodevectorscalarsmoothstep.rst index aeae7941e..9b8d3b3fb 100644 --- a/classes/class_visualshadernodevectorscalarsmoothstep.rst +++ b/classes/class_visualshadernodevectorscalarsmoothstep.rst @@ -20,3 +20,6 @@ Translates to ``smoothstep(edge0, edge1, x)`` in the shader language, where ``x` Returns ``0.0`` if ``x`` is smaller than ``edge0`` and ``1.0`` if ``x`` is larger than ``edge1``. Otherwise the return value is interpolated between ``0.0`` and ``1.0`` using Hermite polynomials. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorscalarstep.rst b/classes/class_visualshadernodevectorscalarstep.rst index 09808e41d..bc030e3f2 100644 --- a/classes/class_visualshadernodevectorscalarstep.rst +++ b/classes/class_visualshadernodevectorscalarstep.rst @@ -20,3 +20,6 @@ Translates to ``step(edge, x)`` in the shader language. Returns ``0.0`` if ``x`` is smaller than ``edge`` and ``1.0`` otherwise. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernodevectorsmoothstep.rst b/classes/class_visualshadernodevectorsmoothstep.rst index dcf96e8ae..78d31bcd2 100644 --- a/classes/class_visualshadernodevectorsmoothstep.rst +++ b/classes/class_visualshadernodevectorsmoothstep.rst @@ -20,3 +20,6 @@ Translates to ``smoothstep(edge0, edge1, x)`` in the shader language, where ``x` Returns ``0.0`` if ``x`` is smaller than ``edge0`` and ``1.0`` if ``x`` is larger than ``edge1``. Otherwise the return value is interpolated between ``0.0`` and ``1.0`` using Hermite polynomials. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index 9da3ec007..8aaddf337 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -50,3 +50,6 @@ Theme Properties | :ref:`StyleBox` | scroll_focus | +---------------------------------+---------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index 7dcdfe728..8d644ab4d 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -27,3 +27,6 @@ Theme Properties | :ref:`StyleBox` | separator | | +---------------------------------+------------+---+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 8a3917a6b..a1d0046d1 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -18,6 +18,8 @@ Description Vertical slider. See :ref:`Slider`. This one goes from bottom (min) to top (max). +**Note:** The :ref:`Range.changed` and :ref:`Range.value_changed` signals are part of the :ref:`Range` class which this class inherits from. + Properties ---------- @@ -46,3 +48,6 @@ Theme Properties | :ref:`Texture` | tick | +---------------------------------+------------------------+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index 65f8b5cf3..3a9d4c20b 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -31,3 +31,6 @@ Theme Properties | :ref:`int` | separation | 12 | +---------------------------------+------------+----+ +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 0f62c427c..e6dd3b9ac 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -21,16 +21,19 @@ A weakref can hold a :ref:`Reference`, without contributing to Methods ------- -+-------------------------------+----------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_ref` **(** **)** const | -+-------------------------------+----------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_ref` **(** **)** |const| | ++-------------------------------+------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_WeakRef_method_get_ref: -- :ref:`Variant` **get_ref** **(** **)** const +- :ref:`Variant` **get_ref** **(** **)** |const| Returns the :ref:`Object` this weakref is referring to. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index be47cd68e..7006ad5be 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -25,29 +25,29 @@ Properties Methods ------- -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_id` **(** **)** const | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_label` **(** **)** const | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_packet_life_time` **(** **)** const | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_retransmits` **(** **)** const | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_protocol` **(** **)** const | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`ChannelState` | :ref:`get_ready_state` **(** **)** const | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_negotiated` **(** **)** const | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ordered` **(** **)** const | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`poll` **(** **)** | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`was_string_packet` **(** **)** const | -+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_label` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_packet_life_time` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_retransmits` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_protocol` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`ChannelState` | :ref:`get_ready_state` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_negotiated` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ordered` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`poll` **(** **)** | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`was_string_packet` **(** **)** |const| | ++----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -116,7 +116,7 @@ Closes this data channel, notifying the other peer. .. _class_WebRTCDataChannel_method_get_id: -- :ref:`int` **get_id** **(** **)** const +- :ref:`int` **get_id** **(** **)** |const| Returns the id assigned to this channel during creation (or auto-assigned during negotiation). @@ -126,7 +126,7 @@ If the channel is not negotiated out-of-band the id will only be available after .. _class_WebRTCDataChannel_method_get_label: -- :ref:`String` **get_label** **(** **)** const +- :ref:`String` **get_label** **(** **)** |const| Returns the label assigned to this channel during creation. @@ -134,7 +134,7 @@ Returns the label assigned to this channel during creation. .. _class_WebRTCDataChannel_method_get_max_packet_life_time: -- :ref:`int` **get_max_packet_life_time** **(** **)** const +- :ref:`int` **get_max_packet_life_time** **(** **)** |const| Returns the ``maxPacketLifeTime`` value assigned to this channel during creation. @@ -144,7 +144,7 @@ Will be ``65535`` if not specified. .. _class_WebRTCDataChannel_method_get_max_retransmits: -- :ref:`int` **get_max_retransmits** **(** **)** const +- :ref:`int` **get_max_retransmits** **(** **)** |const| Returns the ``maxRetransmits`` value assigned to this channel during creation. @@ -154,7 +154,7 @@ Will be ``65535`` if not specified. .. _class_WebRTCDataChannel_method_get_protocol: -- :ref:`String` **get_protocol** **(** **)** const +- :ref:`String` **get_protocol** **(** **)** |const| Returns the sub-protocol assigned to this channel during creation. An empty string if not specified. @@ -162,7 +162,7 @@ Returns the sub-protocol assigned to this channel during creation. An empty stri .. _class_WebRTCDataChannel_method_get_ready_state: -- :ref:`ChannelState` **get_ready_state** **(** **)** const +- :ref:`ChannelState` **get_ready_state** **(** **)** |const| Returns the current state of this channel, see :ref:`ChannelState`. @@ -170,7 +170,7 @@ Returns the current state of this channel, see :ref:`ChannelState` **is_negotiated** **(** **)** const +- :ref:`bool` **is_negotiated** **(** **)** |const| Returns ``true`` if this channel was created with out-of-band configuration. @@ -178,7 +178,7 @@ Returns ``true`` if this channel was created with out-of-band configuration. .. _class_WebRTCDataChannel_method_is_ordered: -- :ref:`bool` **is_ordered** **(** **)** const +- :ref:`bool` **is_ordered** **(** **)** |const| Returns ``true`` if this channel was created with ordering enabled (default). @@ -194,7 +194,10 @@ Reserved, but not used for now. .. _class_WebRTCDataChannel_method_was_string_packet: -- :ref:`bool` **was_string_packet** **(** **)** const +- :ref:`bool` **was_string_packet** **(** **)** |const| Returns ``true`` if the last received packet was transferred as text. See :ref:`write_mode`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_webrtcdatachannelgdnative.rst b/classes/class_webrtcdatachannelgdnative.rst index a84d1bde9..cae0490e3 100644 --- a/classes/class_webrtcdatachannelgdnative.rst +++ b/classes/class_webrtcdatachannelgdnative.rst @@ -13,3 +13,6 @@ WebRTCDataChannelGDNative +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_webrtcmultiplayer.rst b/classes/class_webrtcmultiplayer.rst index ce426bee2..ea973908c 100644 --- a/classes/class_webrtcmultiplayer.rst +++ b/classes/class_webrtcmultiplayer.rst @@ -113,3 +113,6 @@ If ``server_compatibilty`` is ``true`` the peer will suppress all :ref:`Networke Remove the peer with given ``peer_id`` from the mesh. If the peer was connected, and :ref:`NetworkedMultiplayerPeer.peer_connected` was emitted for it, then :ref:`NetworkedMultiplayerPeer.peer_disconnected` will be emitted. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_webrtcpeerconnection.rst b/classes/class_webrtcpeerconnection.rst index 5e89cfd4c..9d44f5def 100644 --- a/classes/class_webrtcpeerconnection.rst +++ b/classes/class_webrtcpeerconnection.rst @@ -42,7 +42,7 @@ Methods +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`create_offer` **(** **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ConnectionState` | :ref:`get_connection_state` **(** **)** const | +| :ref:`ConnectionState` | :ref:`get_connection_state` **(** **)** |const| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`initialize` **(** :ref:`Dictionary` configuration={ } **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -170,7 +170,7 @@ If this functions returns :ref:`@GlobalScope.OK` .. _class_WebRTCPeerConnection_method_get_connection_state: -- :ref:`ConnectionState` **get_connection_state** **(** **)** const +- :ref:`ConnectionState` **get_connection_state** **(** **)** |const| Returns the connection state. See :ref:`ConnectionState`. @@ -194,7 +194,7 @@ Valid ``options`` are: { "urls": [ "turn:turn.example.com:3478" ], # One or more TURN servers. "username": "a_username", # Optional username for the TURN server. - "credentials": "a_password", # Optional password for the TURN server. + "credential": "a_password", # Optional password for the TURN server. } ] } @@ -229,3 +229,6 @@ If ``type`` is ``offer`` the peer will emit :ref:`session_description_created`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_webrtcpeerconnectiongdnative.rst b/classes/class_webrtcpeerconnectiongdnative.rst index ad7958276..d6a9dbf07 100644 --- a/classes/class_webrtcpeerconnectiongdnative.rst +++ b/classes/class_webrtcpeerconnectiongdnative.rst @@ -13,3 +13,6 @@ WebRTCPeerConnectionGDNative +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index effbaf6f6..59cc1614a 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -41,9 +41,9 @@ Methods +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_from_host` **(** :ref:`int` code=1000, :ref:`String` reason="" **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | +| :ref:`String` | :ref:`get_connected_host` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connected_port` **(** **)** const | +| :ref:`int` | :ref:`get_connected_port` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -151,7 +151,7 @@ Disconnects this client from the connected host. See :ref:`WebSocketPeer.close` **get_connected_host** **(** **)** const +- :ref:`String` **get_connected_host** **(** **)** |const| Return the IP address of the currently connected host. @@ -159,7 +159,10 @@ Return the IP address of the currently connected host. .. _class_WebSocketClient_method_get_connected_port: -- :ref:`int` **get_connected_port** **(** **)** const +- :ref:`int` **get_connected_port** **(** **)** |const| Return the IP port of the currently connected host. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index e6541b7ad..d08d4a27b 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -33,7 +33,7 @@ Methods ------- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`WebSocketPeer` | :ref:`get_peer` **(** :ref:`int` peer_id **)** const | +| :ref:`WebSocketPeer` | :ref:`get_peer` **(** :ref:`int` peer_id **)** |const| | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`set_buffers` **(** :ref:`int` input_buffer_size_kb, :ref:`int` input_max_packets, :ref:`int` output_buffer_size_kb, :ref:`int` output_max_packets **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,7 +54,7 @@ Method Descriptions .. _class_WebSocketMultiplayerPeer_method_get_peer: -- :ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** const +- :ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** |const| Returns the :ref:`WebSocketPeer` associated to the given ``peer_id``. @@ -72,3 +72,6 @@ Buffer sizes are expressed in KiB, so ``4 = 2^12 = 4096 bytes``. All parameters **Note:** HTML5 exports only use the input buffer since the output one is managed by browsers. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index dcea3305f..993b2bcd2 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -26,19 +26,19 @@ Methods +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** :ref:`int` code=1000, :ref:`String` reason="" **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | +| :ref:`String` | :ref:`get_connected_host` **(** **)** |const| | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connected_port` **(** **)** const | +| :ref:`int` | :ref:`get_connected_port` **(** **)** |const| | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`WriteMode` | :ref:`get_write_mode` **(** **)** const | +| :ref:`WriteMode` | :ref:`get_write_mode` **(** **)** |const| | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | +| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** |const| | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_no_delay` **(** :ref:`bool` enabled **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_write_mode` **(** :ref:`WriteMode` mode **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`was_string_packet` **(** **)** const | +| :ref:`bool` | :ref:`was_string_packet` **(** **)** |const| | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Enumerations @@ -73,7 +73,7 @@ Closes this WebSocket connection. ``code`` is the status code for the closure (s .. _class_WebSocketPeer_method_get_connected_host: -- :ref:`String` **get_connected_host** **(** **)** const +- :ref:`String` **get_connected_host** **(** **)** |const| Returns the IP address of the connected peer. @@ -83,7 +83,7 @@ Returns the IP address of the connected peer. .. _class_WebSocketPeer_method_get_connected_port: -- :ref:`int` **get_connected_port** **(** **)** const +- :ref:`int` **get_connected_port** **(** **)** |const| Returns the remote port of the connected peer. @@ -93,7 +93,7 @@ Returns the remote port of the connected peer. .. _class_WebSocketPeer_method_get_write_mode: -- :ref:`WriteMode` **get_write_mode** **(** **)** const +- :ref:`WriteMode` **get_write_mode** **(** **)** |const| Gets the current selected write mode. See :ref:`WriteMode`. @@ -101,7 +101,7 @@ Gets the current selected write mode. See :ref:`WriteMode` **is_connected_to_host** **(** **)** const +- :ref:`bool` **is_connected_to_host** **(** **)** |const| Returns ``true`` if this peer is currently connected. @@ -127,7 +127,10 @@ Sets the socket to use the given :ref:`WriteMode`. .. _class_WebSocketPeer_method_was_string_packet: -- :ref:`bool` **was_string_packet** **(** **)** const +- :ref:`bool` **was_string_packet** **(** **)** |const| Returns ``true`` if the last received packet was sent as a text payload. See :ref:`WriteMode`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst index c477b1c78..9157fb45c 100644 --- a/classes/class_websocketserver.rst +++ b/classes/class_websocketserver.rst @@ -41,13 +41,13 @@ Methods +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_peer` **(** :ref:`int` id, :ref:`int` code=1000, :ref:`String` reason="" **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | +| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | +| :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_peer` **(** :ref:`int` id **)** const | +| :ref:`bool` | :ref:`has_peer` **(** :ref:`int` id **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | +| :ref:`bool` | :ref:`is_listening` **(** **)** |const| | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | +---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -161,7 +161,7 @@ Disconnects the peer identified by ``id`` from the server. See :ref:`WebSocketPe .. _class_WebSocketServer_method_get_peer_address: -- :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const +- :ref:`String` **get_peer_address** **(** :ref:`int` id **)** |const| Returns the IP address of the given peer. @@ -169,7 +169,7 @@ Returns the IP address of the given peer. .. _class_WebSocketServer_method_get_peer_port: -- :ref:`int` **get_peer_port** **(** :ref:`int` id **)** const +- :ref:`int` **get_peer_port** **(** :ref:`int` id **)** |const| Returns the remote port of the given peer. @@ -177,7 +177,7 @@ Returns the remote port of the given peer. .. _class_WebSocketServer_method_has_peer: -- :ref:`bool` **has_peer** **(** :ref:`int` id **)** const +- :ref:`bool` **has_peer** **(** :ref:`int` id **)** |const| Returns ``true`` if a peer with the given ID is connected. @@ -185,7 +185,7 @@ Returns ``true`` if a peer with the given ID is connected. .. _class_WebSocketServer_method_is_listening: -- :ref:`bool` **is_listening** **(** **)** const +- :ref:`bool` **is_listening** **(** **)** |const| Returns ``true`` if the server is actively listening on a port. @@ -211,3 +211,6 @@ If ``false`` is passed instead (default), you must call :ref:`PacketPeer`. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_world.rst b/classes/class_world.rst index 4c5f090cd..44539d8ef 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -103,3 +103,6 @@ The World's visual scenario. The World's physics space. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 408cd1209..0b7dd0857 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -71,3 +71,6 @@ Direct access to the world's physics 2D space state. Used for querying current a The :ref:`RID` of this world's physics space resource. Used by the :ref:`Physics2DServer` for 2D physics, treating it as both a space and an area. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 6d8b13c83..49d6516b4 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -49,3 +49,6 @@ Property Descriptions The :ref:`Environment` resource used by this ``WorldEnvironment``, defining the default properties. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_x509certificate.rst b/classes/class_x509certificate.rst index 0d5555e45..5bd82a3c5 100644 --- a/classes/class_x509certificate.rst +++ b/classes/class_x509certificate.rst @@ -48,3 +48,6 @@ Loads a certificate from ``path`` ("\*.crt" file). Saves a certificate to the given ``path`` (should be a "\*.crt" file). +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 56e1ef3b0..09849f97b 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -21,41 +21,41 @@ This class can serve as base to make custom XML parsers. Since XML is a very fle Methods ------- -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_attribute_count` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_attribute_name` **(** :ref:`int` idx **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_attribute_value` **(** :ref:`int` idx **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_line` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_named_attribute_value` **(** :ref:`String` name **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_named_attribute_value_safe` **(** :ref:`String` name **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_data` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_offset` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodeType` | :ref:`get_node_type` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_attribute` **(** :ref:`String` name **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open` **(** :ref:`String` file **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`read` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`seek` **(** :ref:`int` position **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skip_section` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_attribute_count` **(** **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_attribute_name` **(** :ref:`int` idx **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_attribute_value` **(** :ref:`int` idx **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_line` **(** **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_named_attribute_value` **(** :ref:`String` name **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_named_attribute_value_safe` **(** :ref:`String` name **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_data` **(** **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_name` **(** **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_offset` **(** **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodeType` | :ref:`get_node_type` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_attribute` **(** :ref:`String` name **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** |const| | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open` **(** :ref:`String` file **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`read` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`seek` **(** :ref:`int` position **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skip_section` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -97,7 +97,7 @@ Method Descriptions .. _class_XMLParser_method_get_attribute_count: -- :ref:`int` **get_attribute_count** **(** **)** const +- :ref:`int` **get_attribute_count** **(** **)** |const| Gets the amount of attributes in the current element. @@ -105,7 +105,7 @@ Gets the amount of attributes in the current element. .. _class_XMLParser_method_get_attribute_name: -- :ref:`String` **get_attribute_name** **(** :ref:`int` idx **)** const +- :ref:`String` **get_attribute_name** **(** :ref:`int` idx **)** |const| Gets the name of the attribute specified by the index in ``idx`` argument. @@ -113,7 +113,7 @@ Gets the name of the attribute specified by the index in ``idx`` argument. .. _class_XMLParser_method_get_attribute_value: -- :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** const +- :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** |const| Gets the value of the attribute specified by the index in ``idx`` argument. @@ -121,7 +121,7 @@ Gets the value of the attribute specified by the index in ``idx`` argument. .. _class_XMLParser_method_get_current_line: -- :ref:`int` **get_current_line** **(** **)** const +- :ref:`int` **get_current_line** **(** **)** |const| Gets the current line in the parsed file (currently not implemented). @@ -129,7 +129,7 @@ Gets the current line in the parsed file (currently not implemented). .. _class_XMLParser_method_get_named_attribute_value: -- :ref:`String` **get_named_attribute_value** **(** :ref:`String` name **)** const +- :ref:`String` **get_named_attribute_value** **(** :ref:`String` name **)** |const| Gets the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. @@ -137,7 +137,7 @@ Gets the value of a certain attribute of the current element by name. This will .. _class_XMLParser_method_get_named_attribute_value_safe: -- :ref:`String` **get_named_attribute_value_safe** **(** :ref:`String` name **)** const +- :ref:`String` **get_named_attribute_value_safe** **(** :ref:`String` name **)** |const| Gets the value of a certain attribute of the current element by name. This will return an empty :ref:`String` if the attribute is not found. @@ -145,7 +145,7 @@ Gets the value of a certain attribute of the current element by name. This will .. _class_XMLParser_method_get_node_data: -- :ref:`String` **get_node_data** **(** **)** const +- :ref:`String` **get_node_data** **(** **)** |const| Gets the contents of a text node. This will raise an error in any other type of node. @@ -153,7 +153,7 @@ Gets the contents of a text node. This will raise an error in any other type of .. _class_XMLParser_method_get_node_name: -- :ref:`String` **get_node_name** **(** **)** const +- :ref:`String` **get_node_name** **(** **)** |const| Gets the name of the current element node. This will raise an error if the current node type is neither :ref:`NODE_ELEMENT` nor :ref:`NODE_ELEMENT_END`. @@ -161,7 +161,7 @@ Gets the name of the current element node. This will raise an error if the curre .. _class_XMLParser_method_get_node_offset: -- :ref:`int` **get_node_offset** **(** **)** const +- :ref:`int` **get_node_offset** **(** **)** |const| Gets the byte offset of the current node since the beginning of the file or buffer. @@ -177,7 +177,7 @@ Gets the type of the current node. Compare with :ref:`NodeType` **has_attribute** **(** :ref:`String` name **)** const +- :ref:`bool` **has_attribute** **(** :ref:`String` name **)** |const| Check whether the current element has a certain attribute. @@ -185,7 +185,7 @@ Check whether the current element has a certain attribute. .. _class_XMLParser_method_is_empty: -- :ref:`bool` **is_empty** **(** **)** const +- :ref:`bool` **is_empty** **(** **)** |const| Check whether the current element is empty (this only works for completely empty tags, e.g. ````). @@ -229,3 +229,6 @@ Moves the buffer cursor to a certain offset (since the beginning) and read the n Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index ae686bb53..eb9a88e1a 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -44,3 +44,6 @@ Property Descriptions If ``true``, child nodes are sorted, otherwise sorting is disabled. +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`