From f70354d01c7154513d1303664a4f0cc4c2e36ec5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 7 Jan 2019 10:14:08 +0100 Subject: [PATCH] Sync classref with changes from godotengine/godot#24640 --- classes/class_@gdscript.rst | 532 ++-- classes/class_@globalscope.rst | 1102 ++++++- classes/class_aabb.rst | 148 +- classes/class_acceptdialog.rst | 56 +- classes/class_animatedsprite.rst | 84 +- classes/class_animatedsprite3d.rst | 52 +- classes/class_animatedtexture.rst | 40 +- classes/class_animation.rst | 386 +-- classes/class_animationnode.rst | 136 +- classes/class_animationnodeadd2.rst | 8 +- classes/class_animationnodeadd3.rst | 8 +- classes/class_animationnodeanimation.rst | 8 +- classes/class_animationnodeblend2.rst | 8 +- classes/class_animationnodeblend3.rst | 8 +- classes/class_animationnodeblendspace1d.rst | 70 +- classes/class_animationnodeblendspace2d.rst | 118 +- classes/class_animationnodeblendtree.rst | 76 +- classes/class_animationnodeoneshot.rst | 56 +- classes/class_animationnodestatemachine.rst | 134 +- ...lass_animationnodestatemachineplayback.rst | 38 +- ...ss_animationnodestatemachinetransition.rst | 46 +- classes/class_animationnodetransition.rst | 398 +-- classes/class_animationplayer.rst | 214 +- classes/class_animationtree.rst | 58 +- classes/class_animationtreeplayer.rst | 400 +-- classes/class_area.rst | 198 +- classes/class_area2d.rst | 174 +- classes/class_array.rst | 220 +- classes/class_arraymesh.rst | 178 +- classes/class_arvranchor.rst | 34 +- classes/class_arvrcontroller.rst | 58 +- classes/class_arvrinterface.rst | 90 +- classes/class_arvrorigin.rst | 8 +- classes/class_arvrpositionaltracker.rst | 70 +- classes/class_arvrserver.rst | 114 +- classes/class_astar.rst | 124 +- classes/class_atlastexture.rst | 26 +- classes/class_audioeffectamplify.rst | 8 +- classes/class_audioeffectbandlimitfilter.rst | 2 +- classes/class_audioeffectbandpassfilter.rst | 2 +- classes/class_audioeffectchorus.rst | 164 +- classes/class_audioeffectcompressor.rst | 44 +- classes/class_audioeffectdelay.rst | 80 +- classes/class_audioeffectdistortion.rst | 42 +- classes/class_audioeffecteq.rst | 20 +- classes/class_audioeffectfilter.rst | 36 +- classes/class_audioeffecthighpassfilter.rst | 2 +- classes/class_audioeffectlimiter.rst | 26 +- classes/class_audioeffectlowpassfilter.rst | 2 +- classes/class_audioeffectnotchfilter.rst | 2 +- classes/class_audioeffectpanner.rst | 8 +- classes/class_audioeffectphaser.rst | 32 +- classes/class_audioeffectpitchshift.rst | 8 +- classes/class_audioeffectrecord.rst | 28 +- classes/class_audioeffectreverb.rst | 50 +- classes/class_audioeffectstereoenhance.rst | 20 +- classes/class_audioserver.rst | 252 +- classes/class_audiostream.rst | 8 +- classes/class_audiostreamoggvorbis.rst | 20 +- classes/class_audiostreamplayer.rst | 84 +- classes/class_audiostreamplayer2d.rst | 90 +- classes/class_audiostreamplayer3d.rst | 160 +- classes/class_audiostreamrandompitch.rst | 14 +- classes/class_audiostreamsample.rst | 66 +- classes/class_backbuffercopy.rst | 20 +- classes/class_bakedlightmap.rst | 102 +- classes/class_bakedlightmapdata.rst | 64 +- classes/class_basebutton.rst | 106 +- classes/class_basis.rst | 136 +- classes/class_bitmap.rst | 56 +- classes/class_bitmapfont.rst | 82 +- classes/class_bone2d.rst | 34 +- classes/class_boneattachment.rst | 8 +- classes/class_bool.rst | 20 +- classes/class_boxcontainer.rst | 22 +- classes/class_boxshape.rst | 8 +- classes/class_button.rst | 84 +- classes/class_buttongroup.rst | 18 +- classes/class_camera.rst | 174 +- classes/class_camera2d.rst | 208 +- classes/class_canvasitem.rst | 360 +-- classes/class_canvasitemmaterial.rst | 54 +- classes/class_canvaslayer.rst | 52 +- classes/class_canvasmodulate.rst | 8 +- classes/class_capsulemesh.rst | 26 +- classes/class_capsuleshape.rst | 14 +- classes/class_capsuleshape2d.rst | 14 +- classes/class_centercontainer.rst | 8 +- classes/class_checkbox.rst | 74 +- classes/class_checkbutton.rst | 66 +- classes/class_circleshape2d.rst | 8 +- classes/class_classdb.rst | 124 +- classes/class_clippedcamera.rst | 80 +- classes/class_collisionobject.rst | 126 +- classes/class_collisionobject2d.rst | 132 +- classes/class_collisionpolygon.rst | 20 +- classes/class_collisionpolygon2d.rst | 30 +- classes/class_collisionshape.rst | 30 +- classes/class_collisionshape2d.rst | 22 +- classes/class_color.rst | 480 ++- classes/class_colorpicker.rst | 94 +- classes/class_colorpickerbutton.rst | 82 +- classes/class_colorrect.rst | 8 +- classes/class_concavepolygonshape.rst | 14 +- classes/class_concavepolygonshape2d.rst | 8 +- classes/class_conetwistjoint.rst | 44 +- classes/class_configfile.rst | 56 +- classes/class_confirmationdialog.rst | 8 +- classes/class_container.rst | 18 +- classes/class_control.rst | 858 +++--- classes/class_convexpolygonshape.rst | 8 +- classes/class_convexpolygonshape2d.rst | 18 +- classes/class_cpuparticles.rst | 416 +-- classes/class_cpuparticles2d.rst | 408 +-- classes/class_csgbox.rst | 26 +- classes/class_csgcylinder.rst | 40 +- classes/class_csgmesh.rst | 8 +- classes/class_csgpolygon.rst | 114 +- classes/class_csgprimitive.rst | 8 +- classes/class_csgshape.rst | 76 +- classes/class_csgsphere.rst | 32 +- classes/class_csgtorus.rst | 38 +- classes/class_csharpscript.rst | 8 +- classes/class_cubemap.rst | 72 +- classes/class_cubemesh.rst | 26 +- classes/class_curve.rst | 146 +- classes/class_curve2d.rst | 126 +- classes/class_curve3d.rst | 164 +- classes/class_curvetexture.rst | 14 +- classes/class_cylindermesh.rst | 32 +- classes/class_cylindershape.rst | 14 +- classes/class_dampedspringjoint2d.rst | 26 +- classes/class_dictionary.rst | 68 +- classes/class_directionallight.rst | 76 +- classes/class_directory.rst | 126 +- classes/class_dynamicfont.rst | 102 +- classes/class_dynamicfontdata.rst | 26 +- classes/class_editorexportplugin.rst | 62 +- classes/class_editorfiledialog.rst | 102 +- classes/class_editorfilesystem.rst | 64 +- classes/class_editorfilesystemdirectory.rst | 86 +- classes/class_editorimportplugin.rst | 80 +- classes/class_editorinspector.rst | 22 +- classes/class_editorinspectorplugin.rst | 50 +- classes/class_editorinterface.rst | 122 +- classes/class_editorplugin.rst | 392 +-- classes/class_editorproperty.rst | 80 +- .../class_editorresourceconversionplugin.rst | 14 +- classes/class_editorresourcepreview.rst | 34 +- .../class_editorresourcepreviewgenerator.rst | 22 +- classes/class_editorsceneimporter.rst | 58 +- classes/class_editorscenepostimport.rst | 22 +- classes/class_editorscript.rst | 26 +- classes/class_editorselection.rst | 34 +- classes/class_editorsettings.rst | 100 +- classes/class_editorspatialgizmo.rst | 106 +- classes/class_editorspatialgizmoplugin.rst | 98 +- classes/class_encodedobjectasid.rst | 14 +- classes/class_engine.rst | 106 +- classes/class_environment.rst | 550 ++-- classes/class_expression.rst | 32 +- classes/class_file.rst | 292 +- classes/class_filedialog.rst | 128 +- classes/class_float.rst | 20 +- classes/class_font.rst | 56 +- classes/class_funcref.rst | 24 +- classes/class_gdnative.rst | 28 +- classes/class_gdnativelibrary.rst | 46 +- classes/class_gdscript.rst | 16 +- classes/class_gdscriptfunctionstate.rst | 22 +- classes/class_gdscriptnativeclass.rst | 8 +- classes/class_generic6dofjoint.rst | 560 ++-- classes/class_geometry.rst | 144 +- classes/class_geometryinstance.rst | 62 +- classes/class_giprobe.rst | 86 +- classes/class_giprobedata.rst | 68 +- classes/class_godotsharp.rst | 50 +- classes/class_gradient.rst | 64 +- classes/class_gradienttexture.rst | 16 +- classes/class_graphedit.rst | 200 +- classes/class_graphnode.rst | 238 +- classes/class_gridcontainer.rst | 20 +- classes/class_gridmap.rst | 182 +- classes/class_groovejoint2d.rst | 18 +- classes/class_hboxcontainer.rst | 6 +- classes/class_hingejoint.rst | 98 +- classes/class_hscrollbar.rst | 38 +- classes/class_hseparator.rst | 10 +- classes/class_hslider.rst | 38 +- classes/class_hsplitcontainer.rst | 18 +- classes/class_httpclient.rst | 276 +- classes/class_httprequest.rst | 90 +- classes/class_image.rst | 416 ++- classes/class_imagetexture.rst | 62 +- classes/class_immediategeometry.rst | 62 +- classes/class_input.rst | 270 +- classes/class_inputevent.rst | 72 +- classes/class_inputeventaction.rst | 16 +- classes/class_inputeventgesture.rst | 8 +- classes/class_inputeventjoypadbutton.rst | 20 +- classes/class_inputeventjoypadmotion.rst | 14 +- classes/class_inputeventkey.rst | 36 +- classes/class_inputeventmagnifygesture.rst | 8 +- classes/class_inputeventmouse.rst | 24 +- classes/class_inputeventmousebutton.rst | 28 +- classes/class_inputeventmousemotion.rst | 16 +- classes/class_inputeventpangesture.rst | 8 +- classes/class_inputeventscreendrag.rst | 28 +- classes/class_inputeventscreentouch.rst | 22 +- classes/class_inputeventwithmodifiers.rst | 34 +- classes/class_inputmap.rst | 80 +- classes/class_instanceplaceholder.rst | 30 +- classes/class_int.rst | 20 +- classes/class_interpolatedcamera.rst | 30 +- classes/class_ip.rst | 66 +- classes/class_itemlist.rst | 392 +-- classes/class_javascript.rst | 8 +- classes/class_joint.rst | 26 +- classes/class_joint2d.rst | 30 +- classes/class_json.rst | 14 +- classes/class_jsonparseresult.rst | 28 +- classes/class_kinematicbody.rst | 110 +- classes/class_kinematicbody2d.rst | 98 +- classes/class_kinematiccollision.rst | 70 +- classes/class_kinematiccollision2d.rst | 70 +- classes/class_label.rst | 144 +- classes/class_largetexture.rst | 50 +- classes/class_light.rst | 122 +- classes/class_light2d.rst | 160 +- classes/class_lightoccluder2d.rst | 14 +- classes/class_line2d.rst | 118 +- classes/class_lineedit.rst | 224 +- classes/class_lineshape2d.rst | 14 +- classes/class_linkbutton.rst | 46 +- classes/class_listener.rst | 26 +- classes/class_mainloop.rst | 104 +- classes/class_margincontainer.rst | 18 +- classes/class_marshalls.rst | 38 +- classes/class_material.rst | 18 +- classes/class_menubutton.rst | 70 +- classes/class_mesh.rst | 148 +- classes/class_meshdatatool.rst | 232 +- classes/class_meshinstance.rst | 52 +- classes/class_meshinstance2d.rst | 20 +- classes/class_meshlibrary.rst | 98 +- classes/class_mobilevrinterface.rst | 38 +- classes/class_multimesh.rst | 92 +- classes/class_multimeshinstance.rst | 8 +- classes/class_multiplayerapi.rst | 138 +- classes/class_mutex.rst | 20 +- classes/class_nativescript.rst | 58 +- classes/class_navigation.rst | 64 +- classes/class_navigation2d.rst | 44 +- classes/class_navigationmesh.rst | 154 +- classes/class_navigationmeshinstance.rst | 14 +- classes/class_navigationpolygon.rst | 104 +- classes/class_navigationpolygoninstance.rst | 14 +- classes/class_networkedmultiplayerenet.rst | 104 +- classes/class_networkedmultiplayerpeer.rst | 76 +- classes/class_nil.rst | 158 +- classes/class_ninepatchrect.rst | 64 +- classes/class_node.rst | 738 ++--- classes/class_node2d.rst | 146 +- classes/class_nodepath.rst | 64 +- classes/class_noisetexture.rst | 32 +- classes/class_object.rst | 286 +- classes/class_occluderpolygon2d.rst | 32 +- classes/class_omnilight.rst | 38 +- classes/class_opensimplexnoise.rst | 78 +- classes/class_optionbutton.rst | 188 +- classes/class_orientedpathfollow.rst | 38 +- classes/class_os.rst | 714 +++-- classes/class_packeddatacontainer.rst | 22 +- classes/class_packeddatacontainerref.rst | 8 +- classes/class_packedscene.rst | 48 +- classes/class_packetpeer.rst | 48 +- classes/class_packetpeerstream.rst | 20 +- classes/class_packetpeerudp.rst | 50 +- classes/class_panel.rst | 14 +- classes/class_panelcontainer.rst | 6 +- classes/class_panoramasky.rst | 8 +- classes/class_parallaxbackground.rst | 44 +- classes/class_parallaxlayer.rst | 24 +- classes/class_particles.rst | 138 +- classes/class_particles2d.rst | 116 +- classes/class_particlesmaterial.rst | 390 +-- classes/class_path.rst | 10 +- classes/class_path2d.rst | 8 +- classes/class_pathfollow.rst | 52 +- classes/class_pathfollow2d.rst | 50 +- classes/class_pckpacker.rst | 20 +- classes/class_performance.rst | 68 +- classes/class_phashtranslation.rst | 8 +- classes/class_physicalbone.rst | 88 +- classes/class_physics2ddirectbodystate.rst | 180 +- classes/class_physics2ddirectspacestate.rst | 54 +- classes/class_physics2dserver.rst | 760 +++-- .../class_physics2dshapequeryparameters.rst | 60 +- classes/class_physics2dshapequeryresult.rst | 32 +- classes/class_physics2dtestmotionresult.rst | 56 +- classes/class_physicsbody.rst | 58 +- classes/class_physicsbody2d.rst | 66 +- classes/class_physicsdirectbodystate.rst | 190 +- classes/class_physicsdirectspacestate.rst | 34 +- classes/class_physicsmaterial.rst | 26 +- classes/class_physicsserver.rst | 940 +++--- classes/class_physicsshapequeryparameters.rst | 52 +- classes/class_physicsshapequeryresult.rst | 32 +- classes/class_pinjoint.rst | 26 +- classes/class_pinjoint2d.rst | 8 +- classes/class_plane.rst | 118 +- classes/class_planemesh.rst | 20 +- classes/class_planeshape.rst | 8 +- classes/class_pluginscript.rst | 8 +- classes/class_polygon2d.rst | 148 +- classes/class_polygonpathfinder.rst | 50 +- classes/class_poolbytearray.rst | 98 +- classes/class_poolcolorarray.rst | 64 +- classes/class_poolintarray.rst | 64 +- classes/class_poolrealarray.rst | 64 +- classes/class_poolstringarray.rst | 70 +- classes/class_poolvector2array.rst | 64 +- classes/class_poolvector3array.rst | 64 +- classes/class_popup.rst | 42 +- classes/class_popupmenu.rst | 410 +-- classes/class_popuppanel.rst | 6 +- classes/class_primitivemesh.rst | 28 +- classes/class_prismmesh.rst | 32 +- classes/class_proceduralsky.rst | 116 +- classes/class_progressbar.rst | 30 +- classes/class_projectsettings.rst | 1650 +++++------ classes/class_proximitygroup.rst | 34 +- classes/class_proxytexture.rst | 8 +- classes/class_quadmesh.rst | 8 +- classes/class_quat.rst | 132 +- classes/class_randomnumbergenerator.rst | 40 +- classes/class_range.rst | 88 +- classes/class_raycast.rst | 126 +- classes/class_raycast2d.rst | 126 +- classes/class_rayshape.rst | 14 +- classes/class_rayshape2d.rst | 14 +- classes/class_rect2.rst | 106 +- classes/class_rectangleshape2d.rst | 8 +- classes/class_reference.rst | 20 +- classes/class_referencerect.rst | 8 +- classes/class_reflectionprobe.rst | 78 +- classes/class_regex.rst | 62 +- classes/class_regexmatch.rst | 48 +- classes/class_remotetransform.rst | 32 +- classes/class_remotetransform2d.rst | 32 +- classes/class_resource.rst | 60 +- classes/class_resourceformatloader.rst | 38 +- classes/class_resourceformatsaver.rst | 22 +- classes/class_resourceinteractiveloader.rst | 38 +- classes/class_resourceloader.rst | 50 +- classes/class_resourcepreloader.rst | 38 +- classes/class_resourcesaver.rst | 28 +- classes/class_richtextlabel.rst | 352 ++- classes/class_rid.rst | 14 +- classes/class_rigidbody.rst | 228 +- classes/class_rigidbody2d.rst | 240 +- classes/class_rootmotionview.rst | 32 +- classes/class_scenestate.rst | 134 +- classes/class_scenetree.rst | 320 +- classes/class_scenetreetimer.rst | 10 +- classes/class_script.rst | 60 +- classes/class_scriptcreatedialog.rst | 12 +- classes/class_scripteditor.rst | 42 +- classes/class_scrollbar.rst | 10 +- classes/class_scrollcontainer.rst | 56 +- classes/class_segmentshape2d.rst | 14 +- classes/class_semaphore.rst | 14 +- classes/class_shader.rst | 40 +- classes/class_shadermaterial.rst | 34 +- classes/class_shape.rst | 8 +- classes/class_shape2d.rst | 34 +- classes/class_shortcut.rst | 28 +- classes/class_skeleton.rst | 168 +- classes/class_skeleton2d.rst | 20 +- classes/class_skeletonik.rst | 88 +- classes/class_sky.rst | 24 +- classes/class_slider.rst | 32 +- classes/class_sliderjoint.rst | 182 +- classes/class_softbody.rst | 130 +- classes/class_spatial.rst | 268 +- classes/class_spatialmaterial.rst | 814 ++++-- classes/class_spatialvelocitytracker.rst | 28 +- classes/class_spheremesh.rst | 32 +- classes/class_sphereshape.rst | 8 +- classes/class_spinbox.rst | 40 +- classes/class_splitcontainer.rst | 36 +- classes/class_spotlight.rst | 26 +- classes/class_springarm.rst | 52 +- classes/class_sprite.rst | 100 +- classes/class_sprite3d.rst | 48 +- classes/class_spritebase3d.rst | 104 +- classes/class_spriteframes.rst | 106 +- classes/class_staticbody.rst | 32 +- classes/class_staticbody2d.rst | 32 +- classes/class_streampeer.rst | 200 +- classes/class_streampeerbuffer.rst | 46 +- classes/class_streampeerssl.rst | 50 +- classes/class_streampeertcp.rst | 52 +- classes/class_streamtexture.rst | 8 +- classes/class_string.rst | 574 ++-- classes/class_stylebox.rst | 64 +- classes/class_styleboxflat.rst | 168 +- classes/class_styleboxline.rst | 32 +- classes/class_styleboxtexture.rst | 114 +- classes/class_surfacetool.rst | 140 +- classes/class_tabcontainer.rst | 210 +- classes/class_tabs.rst | 248 +- classes/class_tcp_server.rst | 26 +- classes/class_textedit.rst | 524 ++-- classes/class_texture.rst | 76 +- classes/class_texturebutton.rst | 72 +- classes/class_texturelayered.rst | 72 +- classes/class_textureprogress.rst | 146 +- classes/class_texturerect.rst | 40 +- classes/class_theme.rst | 196 +- classes/class_thread.rst | 34 +- classes/class_tilemap.rst | 252 +- classes/class_tileset.rst | 420 +-- classes/class_timer.rst | 72 +- classes/class_toolbutton.rst | 48 +- classes/class_touchscreenbutton.rst | 72 +- classes/class_transform.rst | 114 +- classes/class_transform2d.rst | 130 +- classes/class_translation.rst | 40 +- classes/class_translationserver.rst | 44 +- classes/class_tree.rst | 392 +-- classes/class_treeitem.rst | 364 +-- classes/class_tween.rst | 216 +- classes/class_undoredo.rst | 92 +- classes/class_upnp.rst | 160 +- classes/class_upnpdevice.rst | 90 +- classes/class_vboxcontainer.rst | 6 +- classes/class_vector2.rst | 202 +- classes/class_vector3.rst | 220 +- classes/class_vehiclebody.rst | 28 +- classes/class_vehiclewheel.rst | 86 +- classes/class_videoplayer.rst | 96 +- classes/class_videostreamtheora.rst | 14 +- classes/class_videostreamwebm.rst | 14 +- classes/class_viewport.rst | 404 +-- classes/class_viewportcontainer.rst | 14 +- classes/class_viewporttexture.rst | 10 +- classes/class_visibilityenabler.rst | 20 +- classes/class_visibilityenabler2d.rst | 56 +- classes/class_visibilitynotifier.rst | 24 +- classes/class_visibilitynotifier2d.rst | 24 +- classes/class_visualinstance.rst | 40 +- classes/class_visualscript.rst | 268 +- .../class_visualscriptbasictypeconstant.rst | 16 +- classes/class_visualscriptbuiltinfunc.rst | 138 +- classes/class_visualscriptclassconstant.rst | 16 +- classes/class_visualscriptcomment.rst | 20 +- classes/class_visualscriptconstant.rst | 14 +- classes/class_visualscriptconstructor.rst | 26 +- classes/class_visualscriptcustomnode.rst | 118 +- classes/class_visualscriptdeconstruct.rst | 8 +- classes/class_visualscripteditor.rst | 16 +- classes/class_visualscriptemitsignal.rst | 8 +- classes/class_visualscriptenginesingleton.rst | 8 +- classes/class_visualscriptfunctioncall.rst | 82 +- classes/class_visualscriptfunctionstate.rst | 20 +- classes/class_visualscriptglobalconstant.rst | 8 +- classes/class_visualscriptinputaction.rst | 22 +- classes/class_visualscriptlocalvar.rst | 14 +- classes/class_visualscriptlocalvarset.rst | 14 +- classes/class_visualscriptmathconstant.rst | 26 +- classes/class_visualscriptnode.rst | 28 +- classes/class_visualscriptoperator.rst | 14 +- classes/class_visualscriptpreload.rst | 8 +- classes/class_visualscriptpropertyget.rst | 50 +- classes/class_visualscriptpropertyset.rst | 80 +- classes/class_visualscriptresourcepath.rst | 8 +- classes/class_visualscriptreturn.rst | 14 +- classes/class_visualscriptscenenode.rst | 8 +- classes/class_visualscriptselect.rst | 8 +- classes/class_visualscriptsequence.rst | 8 +- classes/class_visualscriptsubcall.rst | 8 +- classes/class_visualscripttypecast.rst | 14 +- classes/class_visualscriptvariableget.rst | 8 +- classes/class_visualscriptvariableset.rst | 8 +- classes/class_visualscriptyield.rst | 20 +- classes/class_visualscriptyieldsignal.rst | 32 +- classes/class_visualserver.rst | 2578 ++++++++++------- classes/class_visualshader.rst | 100 +- classes/class_visualshadernode.rst | 30 +- .../class_visualshadernodecolorconstant.rst | 8 +- classes/class_visualshadernodecolorop.rst | 26 +- classes/class_visualshadernodecubemap.rst | 20 +- classes/class_visualshadernodeinput.rst | 10 +- .../class_visualshadernodescalarconstant.rst | 8 +- classes/class_visualshadernodescalarfunc.rst | 48 +- classes/class_visualshadernodescalarop.rst | 26 +- classes/class_visualshadernodetexture.rst | 34 +- .../class_visualshadernodetextureuniform.rst | 26 +- ...lass_visualshadernodetransformconstant.rst | 8 +- .../class_visualshadernodetransformmult.rst | 12 +- ...class_visualshadernodetransformvecmult.rst | 16 +- classes/class_visualshadernodeuniform.rst | 8 +- .../class_visualshadernodevec3constant.rst | 8 +- classes/class_visualshadernodevectorfunc.rst | 20 +- classes/class_visualshadernodevectorop.rst | 26 +- classes/class_vscrollbar.rst | 38 +- classes/class_vseparator.rst | 10 +- classes/class_vslider.rst | 38 +- classes/class_vsplitcontainer.rst | 18 +- classes/class_weakref.rst | 10 +- classes/class_websocketclient.rst | 40 +- classes/class_websocketmultiplayerpeer.rst | 10 +- classes/class_websocketpeer.rst | 56 +- classes/class_websocketserver.rst | 60 +- classes/class_windowdialog.rst | 60 +- classes/class_world.rst | 32 +- classes/class_world2d.rst | 20 +- classes/class_worldenvironment.rst | 8 +- classes/class_xmlparser.rst | 118 +- classes/class_ysort.rst | 8 +- 521 files changed, 27321 insertions(+), 22169 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 1c817b9ae..2529d9b08 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -17,181 +17,189 @@ Built-in GDScript functions. Methods ------- -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`asin` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`assert` **(** :ref:`bool` condition **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`atan` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`atan2` **(** :ref:`float` y, :ref:`float` x **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`cartesian2polar` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`clamp` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cosh` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`db2linear` **(** :ref:`float` db **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`decimals` **(** :ref:`float` step **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dectime` **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ease` **(** :ref:`float` s, :ref:`float` curve **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`exp` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`floor` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fmod` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`FuncRef` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_stack` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inf` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_instance_valid` **(** :ref:`Object` instance **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_nan` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lerp` **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max` **(** :ref:`float` a, :ref:`float` b **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`min` **(** :ref:`float` a, :ref:`float` b **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` value **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`polar2cartesian` **(** :ref:`float` r, :ref:`float` th **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print` **(** **)** vararg | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_debug` **(** **)** vararg | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stack` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printerr` **(** **)** vararg | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printraw` **(** **)** vararg | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`prints` **(** **)** vararg | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`printt` **(** **)** vararg | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_error` **(** :ref:`String` message **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_warning` **(** :ref:`String` message **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rad2deg` **(** :ref:`float` rad **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randf` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`randi` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`randomize` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`range` **(** **)** vararg | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`range_lerp` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`round` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seed` **(** :ref:`int` seed **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sign` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sin` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sinh` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sqrt` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`str` **(** **)** vararg | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tan` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`WeakRef` | :ref:`weakref` **(** :ref:`Object` obj **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`wrapf` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`wrapi` **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDScriptFunctionState` | :ref:`yield` **(** :ref:`Object` object=null, :ref:`String` signal="" **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`asin` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`assert` **(** :ref:`bool` condition **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`atan` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`atan2` **(** :ref:`float` y, :ref:`float` x **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`cartesian2polar` **(** :ref:`float` x, :ref:`float` y **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`clamp` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cosh` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`db2linear` **(** :ref:`float` db **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`decimals` **(** :ref:`float` step **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dectime` **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ease` **(** :ref:`float` s, :ref:`float` curve **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`exp` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`floor` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fmod` **(** :ref:`float` x, :ref:`float` y **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`FuncRef` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_stack` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_inf` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_instance_valid` **(** :ref:`Object` instance **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_nan` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lerp` **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max` **(** :ref:`float` a, :ref:`float` b **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`min` **(** :ref:`float` a, :ref:`float` b **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` value **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`polar2cartesian` **(** :ref:`float` r, :ref:`float` th **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print` **(** **)** vararg | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_debug` **(** **)** vararg | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stack` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printerr` **(** **)** vararg | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printraw` **(** **)** vararg | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`prints` **(** **)** vararg | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printt` **(** **)** vararg | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_error` **(** :ref:`String` message **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_warning` **(** :ref:`String` message **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rad2deg` **(** :ref:`float` rad **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randf` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`randi` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`randomize` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`range` **(** **)** vararg | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`range_lerp` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`round` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seed` **(** :ref:`int` seed **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sign` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sin` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sinh` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sqrt` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`str` **(** **)** vararg | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tan` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`WeakRef` | :ref:`weakref` **(** :ref:`Object` obj **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`wrapf` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`wrapi` **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GDScriptFunctionState` | :ref:`yield` **(** :ref:`Object` object=null, :ref:`String` signal="" **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_@GDScript_constant_PI: + +.. _class_@GDScript_constant_TAU: + +.. _class_@GDScript_constant_INF: + +.. _class_@GDScript_constant_NAN: + - **PI** = **3.141593** --- Constant that represents how many times the diameter of a circle fits around its perimeter. - **TAU** = **6.283185** --- The circle constant, the circumference of the unit circle. @@ -210,7 +218,7 @@ List of core built-in GDScript functions. Math functions and other utilities. Ev Method Descriptions ------------------- -.. _class_@GDScript_Color8: +.. _class_@GDScript_method_Color8: - :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** @@ -228,7 +236,7 @@ Returns a 32 bit color with red, green, blue and alpha channels. Each channel ha red = Color8(255, 0, 0) -.. _class_@GDScript_ColorN: +.. _class_@GDScript_method_ColorN: - :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** @@ -242,7 +250,7 @@ Supported color names: "aliceblue", "antiquewhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedalmond", "blue", "blueviolet", "brown", "burlywood", "cadetblue", "chartreuse", "chocolate", "coral", "cornflower", "cornsilk", "crimson", "cyan", "darkblue", "darkcyan", "darkgoldenrod", "darkgray", "darkgreen", "darkkhaki", "darkmagenta", "darkolivegreen", "darkorange", "darkorchid", "darkred", "darksalmon", "darkseagreen", "darkslateblue", "darkslategray", "darkturquoise", "darkviolet", "deeppink", "deepskyblue", "dimgray", "dodgerblue", "firebrick", "floralwhite", "forestgreen", "fuchsia", "gainsboro", "ghostwhite", "gold", "goldenrod", "gray", "webgray", "green", "webgreen", "greenyellow", "honeydew", "hotpink", "indianred", "indigo", "ivory", "khaki", "lavender", "lavenderblush", "lawngreen", "lemonchiffon", "lightblue", "lightcoral", "lightcyan", "lightgoldenrod", "lightgray", "lightgreen", "lightpink", "lightsalmon", "lightseagreen", "lightskyblue", "lightslategray", "lightsteelblue", "lightyellow", "lime", "limegreen", "linen", "magenta", "maroon", "webmaroon", "mediumaquamarine", "mediumblue", "mediumorchid", "mediumpurple", "mediumseagreen", "mediumslateblue", "mediumspringgreen", "mediumturquoise", "mediumvioletred", "midnightblue", "mintcream", "mistyrose", "moccasin", "navajowhite", "navyblue", "oldlace", "olive", "olivedrab", "orange", "orangered", "orchid", "palegoldenrod", "palegreen", "paleturquoise", "palevioletred", "papayawhip", "peachpuff", "peru", "pink", "plum", "powderblue", "purple", "webpurple", "rebeccapurple", "red", "rosybrown", "royalblue", "saddlebrown", "salmon", "sandybrown", "seagreen", "seashell", "sienna", "silver", "skyblue", "slateblue", "slategray", "snow", "springgreen", "steelblue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whitesmoke", "yellow", "yellowgreen". -.. _class_@GDScript_abs: +.. _class_@GDScript_method_abs: - :ref:`float` **abs** **(** :ref:`float` s **)** @@ -253,7 +261,7 @@ Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for in # a is 1 a = abs(-1) -.. _class_@GDScript_acos: +.. _class_@GDScript_method_acos: - :ref:`float` **acos** **(** :ref:`float` s **)** @@ -264,7 +272,7 @@ Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s`` # c is 0.523599 or 30 degrees if converted with rad2deg(s) c = acos(0.866025) -.. _class_@GDScript_asin: +.. _class_@GDScript_method_asin: - :ref:`float` **asin** **(** :ref:`float` s **)** @@ -275,7 +283,7 @@ Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``. # s is 0.523599 or 30 degrees if converted with rad2deg(s) s = asin(0.5) -.. _class_@GDScript_assert: +.. _class_@GDScript_method_assert: - void **assert** **(** :ref:`bool` condition **)** @@ -289,19 +297,19 @@ Assert that the ``condition`` is true. If the ``condition`` is false a fatal err assert(speed >= 0) # Is false and program stops assert(speed >= 0 && speed < 20) # Or combined -.. _class_@GDScript_atan: +.. _class_@GDScript_method_atan: - :ref:`float` **atan** **(** :ref:`float` s **)** Returns the arc tangent of ``s`` in radians. Use it to get the angle from an angle's tangent in trigonometry: ``atan(tan(angle)) == angle``. -The method cannot know in which quadrant the angle should fall. See :ref:`atan2` if you always want an exact angle. +The method cannot know in which quadrant the angle should fall. See :ref:`atan2` if you always want an exact angle. :: a = atan(0.5) # a is 0.463648 -.. _class_@GDScript_atan2: +.. _class_@GDScript_method_atan2: - :ref:`float` **atan2** **(** :ref:`float` y, :ref:`float` x **)** @@ -311,19 +319,19 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ` a = atan(0, -1) # a is 3.141593 -.. _class_@GDScript_bytes2var: +.. _class_@GDScript_method_bytes2var: - :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes **)** Decodes a byte array back to a value. -.. _class_@GDScript_cartesian2polar: +.. _class_@GDScript_method_cartesian2polar: - :ref:`Vector2` **cartesian2polar** **(** :ref:`float` x, :ref:`float` y **)** Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). -.. _class_@GDScript_ceil: +.. _class_@GDScript_method_ceil: - :ref:`float` **ceil** **(** :ref:`float` s **)** @@ -334,7 +342,7 @@ Rounds ``s`` upward, returning the smallest integral value that is not less than i = ceil(1.45) # i is 2 i = ceil(1.001) # i is 2 -.. _class_@GDScript_char: +.. _class_@GDScript_method_char: - :ref:`String` **char** **(** :ref:`int` ascii **)** @@ -347,7 +355,7 @@ Returns a character as a String of the given ASCII code. # a is 'a' a = char(65 + 32) -.. _class_@GDScript_clamp: +.. _class_@GDScript_method_clamp: - :ref:`float` **clamp** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** @@ -363,7 +371,7 @@ Clamps ``value`` and returns a value not less than ``min`` and not more than ``m # a is 1 a = clamp(speed, 1, 20) -.. _class_@GDScript_convert: +.. _class_@GDScript_method_convert: - :ref:`Variant` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** @@ -379,7 +387,7 @@ Converts from a type to another in the best way possible. The ``type`` parameter # (1, 0) is 6 characters print(a.length()) -.. _class_@GDScript_cos: +.. _class_@GDScript_method_cos: - :ref:`float` **cos** **(** :ref:`float` s **)** @@ -391,7 +399,7 @@ Returns the cosine of angle ``s`` in radians. print(cos(PI * 2)) print(cos(PI)) -.. _class_@GDScript_cosh: +.. _class_@GDScript_method_cosh: - :ref:`float` **cosh** **(** :ref:`float` s **)** @@ -402,13 +410,13 @@ Returns the hyperbolic cosine of ``s`` in radians. # prints 1.543081 print(cosh(1)) -.. _class_@GDScript_db2linear: +.. _class_@GDScript_method_db2linear: - :ref:`float` **db2linear** **(** :ref:`float` db **)** Converts from decibels to linear energy (audio). -.. _class_@GDScript_decimals: +.. _class_@GDScript_method_decimals: - :ref:`float` **decimals** **(** :ref:`float` step **)** @@ -419,7 +427,7 @@ Returns the position of the first non-zero digit, after the decimal point. # n is 2 n = decimals(0.035) -.. _class_@GDScript_dectime: +.. _class_@GDScript_method_dectime: - :ref:`float` **dectime** **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** @@ -430,7 +438,7 @@ Returns the result of ``value`` decreased by ``step`` \* ``amount``. # a = 59 a = dectime(60, 10, 0.1)) -.. _class_@GDScript_deg2rad: +.. _class_@GDScript_method_deg2rad: - :ref:`float` **deg2rad** **(** :ref:`float` deg **)** @@ -441,19 +449,19 @@ Returns degrees converted to radians. # r is 3.141593 r = deg2rad(180) -.. _class_@GDScript_dict2inst: +.. _class_@GDScript_method_dict2inst: - :ref:`Object` **dict2inst** **(** :ref:`Dictionary` dict **)** Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing. -.. _class_@GDScript_ease: +.. _class_@GDScript_method_ease: - :ref:`float` **ease** **(** :ref:`float` s, :ref:`float` curve **)** Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. -.. _class_@GDScript_exp: +.. _class_@GDScript_method_exp: - :ref:`float` **exp** **(** :ref:`float` s **)** @@ -465,7 +473,7 @@ The natural exponential function. It raises the mathematical constant **e** to t a = exp(2) # approximately 7.39 -.. _class_@GDScript_floor: +.. _class_@GDScript_method_floor: - :ref:`float` **floor** **(** :ref:`float` s **)** @@ -478,7 +486,7 @@ Rounds ``s`` to the closest smaller integer and returns it. # a is -3 a = floor(-2.99) -.. _class_@GDScript_fmod: +.. _class_@GDScript_method_fmod: - :ref:`float` **fmod** **(** :ref:`float` x, :ref:`float` y **)** @@ -489,7 +497,7 @@ Returns the floating-point remainder of ``x/y``. # remainder is 1.5 var remainder = fmod(7, 5.5) -.. _class_@GDScript_fposmod: +.. _class_@GDScript_method_fposmod: - :ref:`float` **fposmod** **(** :ref:`float` x, :ref:`float` y **)** @@ -517,7 +525,7 @@ Produces: -2 8 -1 9 -.. _class_@GDScript_funcref: +.. _class_@GDScript_method_funcref: - :ref:`FuncRef` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** @@ -531,7 +539,7 @@ Returns a reference to the specified function ``funcname`` in the ``instance`` n a = funcref(self, "foo") print(a.call_func()) # prints bar -.. _class_@GDScript_get_stack: +.. _class_@GDScript_method_get_stack: - :ref:`Array` **get_stack** **(** **)** @@ -554,7 +562,7 @@ would print [{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}] -.. _class_@GDScript_hash: +.. _class_@GDScript_method_hash: - :ref:`int` **hash** **(** :ref:`Variant` var **)** @@ -564,7 +572,7 @@ Returns the integer hash of the variable passed. print(hash("a")) # prints 177670 -.. _class_@GDScript_inst2dict: +.. _class_@GDScript_method_inst2dict: - :ref:`Dictionary` **inst2dict** **(** :ref:`Object` inst **)** @@ -585,7 +593,7 @@ Prints out: [@subpath, @path, foo] [, res://test.gd, bar] -.. _class_@GDScript_instance_from_id: +.. _class_@GDScript_method_instance_from_id: - :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** @@ -599,7 +607,7 @@ Returns the Object that corresponds to ``instance_id``. All Objects have a uniqu var inst = instance_from_id(id) print(inst.foo) # prints bar -.. _class_@GDScript_inverse_lerp: +.. _class_@GDScript_method_inverse_lerp: - :ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** @@ -609,25 +617,25 @@ Returns a normalized value considering the given range. inverse_lerp(3, 5, 4) # returns 0.5 -.. _class_@GDScript_is_inf: +.. _class_@GDScript_method_is_inf: - :ref:`bool` **is_inf** **(** :ref:`float` s **)** Returns whether ``s`` is an infinity value (either positive infinity or negative infinity). -.. _class_@GDScript_is_instance_valid: +.. _class_@GDScript_method_is_instance_valid: - :ref:`bool` **is_instance_valid** **(** :ref:`Object` instance **)** Returns whether ``instance`` is a valid object (e.g. has not been deleted from memory). -.. _class_@GDScript_is_nan: +.. _class_@GDScript_method_is_nan: - :ref:`bool` **is_nan** **(** :ref:`float` s **)** Returns whether ``s`` is a NaN (Not-A-Number) value. -.. _class_@GDScript_len: +.. _class_@GDScript_method_len: - :ref:`int` **len** **(** :ref:`Variant` var **)** @@ -640,7 +648,7 @@ Returns length of Variant ``var``. Length is the character count of String, elem a = [1, 2, 3, 4] len(a) # returns 4 -.. _class_@GDScript_lerp: +.. _class_@GDScript_method_lerp: - :ref:`float` **lerp** **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** @@ -650,13 +658,13 @@ Linearly interpolates between two values by a normalized value. lerp(1, 3, 0.5) # returns 2 -.. _class_@GDScript_linear2db: +.. _class_@GDScript_method_linear2db: - :ref:`float` **linear2db** **(** :ref:`float` nrg **)** Converts from linear energy to decibels (audio). -.. _class_@GDScript_load: +.. _class_@GDScript_method_load: - :ref:`Resource` **load** **(** :ref:`String` path **)** @@ -669,7 +677,7 @@ Loads a resource from the filesystem located at ``path``. # load a scene called main located in the root of the project directory var main = load("res://main.tscn") -.. _class_@GDScript_log: +.. _class_@GDScript_method_log: - :ref:`float` **log** **(** :ref:`float` s **)** @@ -681,7 +689,7 @@ Natural logarithm. The amount of time needed to reach a certain level of continu log(10) # returns 2.302585 -.. _class_@GDScript_max: +.. _class_@GDScript_method_max: - :ref:`float` **max** **(** :ref:`float` a, :ref:`float` b **)** @@ -692,7 +700,7 @@ Returns the maximum of two values. max(1, 2) # returns 2 max(-3.99, -4) # returns -3.99 -.. _class_@GDScript_min: +.. _class_@GDScript_method_min: - :ref:`float` **min** **(** :ref:`float` a, :ref:`float` b **)** @@ -703,7 +711,7 @@ Returns the minimum of two values. min(1, 2) # returns 1 min(-3.99, -4) # returns -4 -.. _class_@GDScript_nearest_po2: +.. _class_@GDScript_method_nearest_po2: - :ref:`int` **nearest_po2** **(** :ref:`int` value **)** @@ -715,11 +723,11 @@ Returns the nearest larger power of 2 for integer ``value``. nearest_po2(4) # returns 4 nearest_po2(5) # returns 8 -.. _class_@GDScript_parse_json: +.. _class_@GDScript_method_parse_json: - :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 it 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. @@ -733,13 +741,13 @@ Note that JSON objects do not preserve key order like Godot dictionaries, thus y else: print("unexpected results") -.. _class_@GDScript_polar2cartesian: +.. _class_@GDScript_method_polar2cartesian: - :ref:`Vector2` **polar2cartesian** **(** :ref:`float` r, :ref:`float` th **)** Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis). -.. _class_@GDScript_pow: +.. _class_@GDScript_method_pow: - :ref:`float` **pow** **(** :ref:`float` x, :ref:`float` y **)** @@ -749,7 +757,7 @@ Returns the result of ``x`` raised to the power of ``y``. pow(2, 5) # returns 32 -.. _class_@GDScript_preload: +.. _class_@GDScript_method_preload: - :ref:`Resource` **preload** **(** :ref:`String` path **)** @@ -762,7 +770,7 @@ Returns a resource from the filesystem that is loaded during script parsing. # load a scene called main located in the root of the project directory var main = preload("res://main.tscn") -.. _class_@GDScript_print: +.. _class_@GDScript_method_print: - void **print** **(** **)** vararg @@ -773,13 +781,13 @@ Converts one or more arguments to strings in the best way possible and prints th a = [1, 2, 3] print("a", "b", a) # prints ab[1, 2, 3] -.. _class_@GDScript_print_debug: +.. _class_@GDScript_method_print_debug: - void **print_debug** **(** **)** vararg -Like :ref:`print`, but prints only when used in debug mode. +Like :ref:`print`, but prints only when used in debug mode. -.. _class_@GDScript_print_stack: +.. _class_@GDScript_method_print_stack: - void **print_stack** **(** **)** @@ -791,7 +799,7 @@ Output in the console would look something like this: Frame 0 - res://test.gd:16 in function '_process' -.. _class_@GDScript_printerr: +.. _class_@GDScript_method_printerr: - void **printerr** **(** **)** vararg @@ -801,7 +809,7 @@ Prints one or more arguments to strings in the best way possible to standard err printerr("prints to stderr") -.. _class_@GDScript_printraw: +.. _class_@GDScript_method_printraw: - void **printraw** **(** **)** vararg @@ -813,7 +821,7 @@ Prints one or more arguments to strings in the best way possible to console. No printraw("B") # prints AB -.. _class_@GDScript_prints: +.. _class_@GDScript_method_prints: - void **prints** **(** **)** vararg @@ -823,7 +831,7 @@ Prints one or more arguments to the console with a space between each argument. prints("A", "B", "C") # prints A B C -.. _class_@GDScript_printt: +.. _class_@GDScript_method_printt: - void **printt** **(** **)** vararg @@ -833,7 +841,7 @@ Prints one or more arguments to the console with a tab between each argument. printt("A", "B", "C") # prints A B C -.. _class_@GDScript_push_error: +.. _class_@GDScript_method_push_error: - void **push_error** **(** :ref:`String` message **)** @@ -843,7 +851,7 @@ Pushes an error message to Godot's built-in debugger and to the OS terminal. push_error("test error") # prints "test error" to debugger and terminal as error call -.. _class_@GDScript_push_warning: +.. _class_@GDScript_method_push_warning: - void **push_warning** **(** :ref:`String` message **)** @@ -853,7 +861,7 @@ Pushes a warning message to Godot's built-in debugger and to the OS terminal. push_warning("test warning") # prints "test warning" to debugger and terminal as warning call -.. _class_@GDScript_rad2deg: +.. _class_@GDScript_method_rad2deg: - :ref:`float` **rad2deg** **(** :ref:`float` rad **)** @@ -863,7 +871,7 @@ Converts from radians to degrees. rad2deg(0.523599) # returns 30 -.. _class_@GDScript_rand_range: +.. _class_@GDScript_method_rand_range: - :ref:`float` **rand_range** **(** :ref:`float` from, :ref:`float` to **)** @@ -873,13 +881,13 @@ Random range, any floating point value between ``from`` and ``to``. prints(rand_range(0, 1), rand_range(0, 1)) # prints 0.135591 0.405263 -.. _class_@GDScript_rand_seed: +.. _class_@GDScript_method_rand_seed: - :ref:`Array` **rand_seed** **(** :ref:`int` seed **)** Random from seed: pass a ``seed``, and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits. -.. _class_@GDScript_randf: +.. _class_@GDScript_method_randf: - :ref:`float` **randf** **(** **)** @@ -889,7 +897,7 @@ Returns a random floating point value between 0 and 1. randf() # returns 0.375671 -.. _class_@GDScript_randi: +.. _class_@GDScript_method_randi: - :ref:`int` **randi** **(** **)** @@ -901,7 +909,7 @@ Returns a random 32 bit integer. Use remainder to obtain a random value between randi() % 100 # returns random number between 0 and 99 randi() % 100 + 1 # returns random number between 1 and 100 -.. _class_@GDScript_randomize: +.. _class_@GDScript_method_randomize: - void **randomize** **(** **)** @@ -912,7 +920,7 @@ Randomizes the seed (or the internal state) of the random number generator. Curr func _ready(): randomize() -.. _class_@GDScript_range: +.. _class_@GDScript_method_range: - :ref:`Array` **range** **(** **)** vararg @@ -944,7 +952,7 @@ Output: 2 4 -.. _class_@GDScript_range_lerp: +.. _class_@GDScript_method_range_lerp: - :ref:`float` **range_lerp** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** @@ -954,7 +962,7 @@ Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. range_lerp(75, 0, 100, -1, 1) # returns 0.5 -.. _class_@GDScript_round: +.. _class_@GDScript_method_round: - :ref:`float` **round** **(** :ref:`float` s **)** @@ -964,7 +972,7 @@ Returns the integral value that is nearest to ``s``, with halfway cases rounded round(2.6) # returns 3 -.. _class_@GDScript_seed: +.. _class_@GDScript_method_seed: - void **seed** **(** :ref:`int` seed **)** @@ -975,7 +983,7 @@ Sets seed for the random number generator. my_seed = "Godot Rocks" seed(my_seed.hash()) -.. _class_@GDScript_sign: +.. _class_@GDScript_method_sign: - :ref:`float` **sign** **(** :ref:`float` s **)** @@ -987,7 +995,7 @@ Returns the sign of ``s``: -1 or 1. Returns 0 if ``s`` is 0. sign(0) # returns 0 sign(6) # returns 1 -.. _class_@GDScript_sin: +.. _class_@GDScript_method_sin: - :ref:`float` **sin** **(** :ref:`float` s **)** @@ -997,7 +1005,7 @@ Returns the sine of angle ``s`` in radians. sin(0.523599) # returns 0.5 -.. _class_@GDScript_sinh: +.. _class_@GDScript_method_sinh: - :ref:`float` **sinh** **(** :ref:`float` s **)** @@ -1008,7 +1016,7 @@ Returns the hyperbolic sine of ``s``. a = log(2.0) # returns 0.693147 sinh(a) # returns 0.75 -.. _class_@GDScript_sqrt: +.. _class_@GDScript_method_sqrt: - :ref:`float` **sqrt** **(** :ref:`float` s **)** @@ -1018,13 +1026,13 @@ Returns the square root of ``s``. sqrt(9) # returns 3 -.. _class_@GDScript_stepify: +.. _class_@GDScript_method_stepify: - :ref:`float` **stepify** **(** :ref:`float` s, :ref:`float` step **)** Snaps float value ``s`` to a given ``step``. -.. _class_@GDScript_str: +.. _class_@GDScript_method_str: - :ref:`String` **str** **(** **)** vararg @@ -1037,11 +1045,11 @@ Converts one or more arguments to string in the best way possible. len(a) # returns 3 len(b) # returns 12 -.. _class_@GDScript_str2var: +.. _class_@GDScript_method_str2var: - :ref:`Variant` **str2var** **(** :ref:`String` string **)** -Converts a formatted string that was returned by :ref:`var2str` to the original value. +Converts a formatted string that was returned by :ref:`var2str` to the original value. :: @@ -1049,7 +1057,7 @@ Converts a formatted string that was returned by :ref:`var2str` **tan** **(** :ref:`float` s **)** @@ -1059,7 +1067,7 @@ Returns the tangent of angle ``s`` in radians. tan(deg2rad(45)) # returns 1 -.. _class_@GDScript_tanh: +.. _class_@GDScript_method_tanh: - :ref:`float` **tanh** **(** :ref:`float` s **)** @@ -1070,7 +1078,7 @@ Returns the hyperbolic tangent of ``s``. a = log(2.0) # returns 0.693147 tanh(a) # returns 0.6 -.. _class_@GDScript_to_json: +.. _class_@GDScript_method_to_json: - :ref:`String` **to_json** **(** :ref:`Variant` var **)** @@ -1082,7 +1090,7 @@ Converts a Variant ``var`` to JSON text and return the result. Useful for serial b = to_json(a) print(b) # {"a":1, "b":2} -.. _class_@GDScript_type_exists: +.. _class_@GDScript_method_type_exists: - :ref:`bool` **type_exists** **(** :ref:`String` type **)** @@ -1093,7 +1101,7 @@ Returns whether the given class exists in :ref:`ClassDB`. type_exists("Sprite") # returns true type_exists("Variant") # returns false -.. _class_@GDScript_typeof: +.. _class_@GDScript_method_typeof: - :ref:`int` **typeof** **(** :ref:`Variant` what **)** @@ -1107,7 +1115,7 @@ Returns the internal type of the given Variant object, using the TYPE\_\* enum i else: print("unexpected results") -.. _class_@GDScript_validate_json: +.. _class_@GDScript_method_validate_json: - :ref:`String` **validate_json** **(** :ref:`String` json **)** @@ -1122,17 +1130,17 @@ Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns else: prints("invalid", v) -.. _class_@GDScript_var2bytes: +.. _class_@GDScript_method_var2bytes: - :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** Encodes a variable value to a byte array. -.. _class_@GDScript_var2str: +.. _class_@GDScript_method_var2str: - :ref:`String` **var2str** **(** :ref:`Variant` var **)** -Converts a Variant ``var`` to a formatted string that can later be parsed using :ref:`str2var`. +Converts a Variant ``var`` to a formatted string that can later be parsed using :ref:`str2var`. :: @@ -1148,7 +1156,7 @@ prints "b": 2 } -.. _class_@GDScript_weakref: +.. _class_@GDScript_method_weakref: - :ref:`WeakRef` **weakref** **(** :ref:`Object` obj **)** @@ -1156,7 +1164,7 @@ Returns a weak reference to an object. A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. -.. _class_@GDScript_wrapf: +.. _class_@GDScript_method_wrapf: - :ref:`float` **wrapf** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** @@ -1179,7 +1187,7 @@ Usable for creating loop-alike behavior or infinite surfaces. # infinite loop between 0.0 and 0.99 f = wrapf(f + 0.1, 0.0, 1.0) -.. _class_@GDScript_wrapi: +.. _class_@GDScript_method_wrapi: - :ref:`int` **wrapi** **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** @@ -1202,13 +1210,13 @@ Usable for creating loop-alike behavior or infinite surfaces. # infinite loop between 0 and 9 frame = wrapi(frame + 1, 0, 10) -.. _class_@GDScript_yield: +.. _class_@GDScript_method_yield: - :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object=null, :ref:`String` signal="" **)** Stops the function execution and returns the current suspended state to the calling function. -From the caller, call :ref:`GDScriptFunctionState.resume` on the state to resume execution. This invalidates the state. Within the resumed function, ``yield()`` returns whatever was passed to the ``resume()`` function call. +From the caller, call :ref:`GDScriptFunctionState.resume` on the state to resume execution. This invalidates the state. Within the resumed function, ``yield()`` returns whatever was passed to the ``resume()`` function call. If passed an object and a signal, the execution is resumed when the object emits the given signal. In this case, ``yield()`` returns the argument passed to ``emit_signal()`` if the signal takes only one argument, or an array containing all the arguments passed to ``emit_signal()`` if the signal takes multiple arguments. diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 8dac0173c..b5ef84b8a 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -17,55 +17,63 @@ Global scope constants and variables. Properties ---------- -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`ARVRServer` | :ref:`ARVRServer` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`AudioServer` | :ref:`AudioServer` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`ClassDB` | :ref:`ClassDB` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`Engine` | :ref:`Engine` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`Geometry` | :ref:`Geometry` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`IP` | :ref:`IP` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`Input` | :ref:`Input` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`InputMap` | :ref:`InputMap` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`JSON` | :ref:`JSON` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`JavaScript` | :ref:`JavaScript` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`Reference` | :ref:`Marshalls` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`OS` | :ref:`OS` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`Performance` | :ref:`Performance` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`Physics2DServer` | :ref:`Physics2DServer` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`PhysicsServer` | :ref:`PhysicsServer` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`ProjectSettings` | :ref:`ProjectSettings` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`ResourceLoader` | :ref:`ResourceLoader` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`ResourceSaver` | :ref:`ResourceSaver` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`TranslationServer` | :ref:`TranslationServer` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`VisualScriptEditor` | :ref:`VisualScriptEditor` | -+-----------------------------------------------------+------------------------------------------------------------------+ -| :ref:`VisualServer` | :ref:`VisualServer` | -+-----------------------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`ARVRServer` | :ref:`ARVRServer` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`AudioServer` | :ref:`AudioServer` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`ClassDB` | :ref:`ClassDB` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`Engine` | :ref:`Engine` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`Geometry` | :ref:`Geometry` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`IP` | :ref:`IP` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`Input` | :ref:`Input` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`InputMap` | :ref:`InputMap` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`JSON` | :ref:`JSON` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`JavaScript` | :ref:`JavaScript` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`Reference` | :ref:`Marshalls` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`OS` | :ref:`OS` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`Performance` | :ref:`Performance` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`Physics2DServer` | :ref:`Physics2DServer` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`PhysicsServer` | :ref:`PhysicsServer` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`ProjectSettings` | :ref:`ProjectSettings` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`ResourceLoader` | :ref:`ResourceLoader` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`ResourceSaver` | :ref:`ResourceSaver` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`TranslationServer` | :ref:`TranslationServer` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`VisualScriptEditor` | :ref:`VisualScriptEditor` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`VisualServer` | :ref:`VisualServer` | ++-----------------------------------------------------+---------------------------------------------------------------------------+ Enumerations ------------ .. _enum_@GlobalScope_Margin: +.. _class_@GlobalScope_constant_MARGIN_LEFT: + +.. _class_@GlobalScope_constant_MARGIN_TOP: + +.. _class_@GlobalScope_constant_MARGIN_RIGHT: + +.. _class_@GlobalScope_constant_MARGIN_BOTTOM: + enum **Margin**: - **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. @@ -78,6 +86,14 @@ enum **Margin**: .. _enum_@GlobalScope_Corner: +.. _class_@GlobalScope_constant_CORNER_TOP_LEFT: + +.. _class_@GlobalScope_constant_CORNER_TOP_RIGHT: + +.. _class_@GlobalScope_constant_CORNER_BOTTOM_RIGHT: + +.. _class_@GlobalScope_constant_CORNER_BOTTOM_LEFT: + enum **Corner**: - **CORNER_TOP_LEFT** = **0** @@ -90,6 +106,10 @@ enum **Corner**: .. _enum_@GlobalScope_Orientation: +.. _class_@GlobalScope_constant_VERTICAL: + +.. _class_@GlobalScope_constant_HORIZONTAL: + enum **Orientation**: - **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. @@ -98,6 +118,12 @@ enum **Orientation**: .. _enum_@GlobalScope_HAlign: +.. _class_@GlobalScope_constant_HALIGN_LEFT: + +.. _class_@GlobalScope_constant_HALIGN_CENTER: + +.. _class_@GlobalScope_constant_HALIGN_RIGHT: + enum **HAlign**: - **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes. @@ -108,6 +134,12 @@ enum **HAlign**: .. _enum_@GlobalScope_VAlign: +.. _class_@GlobalScope_constant_VALIGN_TOP: + +.. _class_@GlobalScope_constant_VALIGN_CENTER: + +.. _class_@GlobalScope_constant_VALIGN_BOTTOM: + enum **VAlign**: - **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes. @@ -118,6 +150,490 @@ enum **VAlign**: .. _enum_@GlobalScope_KeyList: +.. _class_@GlobalScope_constant_KEY_ESCAPE: + +.. _class_@GlobalScope_constant_KEY_TAB: + +.. _class_@GlobalScope_constant_KEY_BACKTAB: + +.. _class_@GlobalScope_constant_KEY_BACKSPACE: + +.. _class_@GlobalScope_constant_KEY_ENTER: + +.. _class_@GlobalScope_constant_KEY_KP_ENTER: + +.. _class_@GlobalScope_constant_KEY_INSERT: + +.. _class_@GlobalScope_constant_KEY_DELETE: + +.. _class_@GlobalScope_constant_KEY_PAUSE: + +.. _class_@GlobalScope_constant_KEY_PRINT: + +.. _class_@GlobalScope_constant_KEY_SYSREQ: + +.. _class_@GlobalScope_constant_KEY_CLEAR: + +.. _class_@GlobalScope_constant_KEY_HOME: + +.. _class_@GlobalScope_constant_KEY_END: + +.. _class_@GlobalScope_constant_KEY_LEFT: + +.. _class_@GlobalScope_constant_KEY_UP: + +.. _class_@GlobalScope_constant_KEY_RIGHT: + +.. _class_@GlobalScope_constant_KEY_DOWN: + +.. _class_@GlobalScope_constant_KEY_PAGEUP: + +.. _class_@GlobalScope_constant_KEY_PAGEDOWN: + +.. _class_@GlobalScope_constant_KEY_SHIFT: + +.. _class_@GlobalScope_constant_KEY_CONTROL: + +.. _class_@GlobalScope_constant_KEY_META: + +.. _class_@GlobalScope_constant_KEY_ALT: + +.. _class_@GlobalScope_constant_KEY_CAPSLOCK: + +.. _class_@GlobalScope_constant_KEY_NUMLOCK: + +.. _class_@GlobalScope_constant_KEY_SCROLLLOCK: + +.. _class_@GlobalScope_constant_KEY_F1: + +.. _class_@GlobalScope_constant_KEY_F2: + +.. _class_@GlobalScope_constant_KEY_F3: + +.. _class_@GlobalScope_constant_KEY_F4: + +.. _class_@GlobalScope_constant_KEY_F5: + +.. _class_@GlobalScope_constant_KEY_F6: + +.. _class_@GlobalScope_constant_KEY_F7: + +.. _class_@GlobalScope_constant_KEY_F8: + +.. _class_@GlobalScope_constant_KEY_F9: + +.. _class_@GlobalScope_constant_KEY_F10: + +.. _class_@GlobalScope_constant_KEY_F11: + +.. _class_@GlobalScope_constant_KEY_F12: + +.. _class_@GlobalScope_constant_KEY_F13: + +.. _class_@GlobalScope_constant_KEY_F14: + +.. _class_@GlobalScope_constant_KEY_F15: + +.. _class_@GlobalScope_constant_KEY_F16: + +.. _class_@GlobalScope_constant_KEY_KP_MULTIPLY: + +.. _class_@GlobalScope_constant_KEY_KP_DIVIDE: + +.. _class_@GlobalScope_constant_KEY_KP_SUBTRACT: + +.. _class_@GlobalScope_constant_KEY_KP_PERIOD: + +.. _class_@GlobalScope_constant_KEY_KP_ADD: + +.. _class_@GlobalScope_constant_KEY_KP_0: + +.. _class_@GlobalScope_constant_KEY_KP_1: + +.. _class_@GlobalScope_constant_KEY_KP_2: + +.. _class_@GlobalScope_constant_KEY_KP_3: + +.. _class_@GlobalScope_constant_KEY_KP_4: + +.. _class_@GlobalScope_constant_KEY_KP_5: + +.. _class_@GlobalScope_constant_KEY_KP_6: + +.. _class_@GlobalScope_constant_KEY_KP_7: + +.. _class_@GlobalScope_constant_KEY_KP_8: + +.. _class_@GlobalScope_constant_KEY_KP_9: + +.. _class_@GlobalScope_constant_KEY_SUPER_L: + +.. _class_@GlobalScope_constant_KEY_SUPER_R: + +.. _class_@GlobalScope_constant_KEY_MENU: + +.. _class_@GlobalScope_constant_KEY_HYPER_L: + +.. _class_@GlobalScope_constant_KEY_HYPER_R: + +.. _class_@GlobalScope_constant_KEY_HELP: + +.. _class_@GlobalScope_constant_KEY_DIRECTION_L: + +.. _class_@GlobalScope_constant_KEY_DIRECTION_R: + +.. _class_@GlobalScope_constant_KEY_BACK: + +.. _class_@GlobalScope_constant_KEY_FORWARD: + +.. _class_@GlobalScope_constant_KEY_STOP: + +.. _class_@GlobalScope_constant_KEY_REFRESH: + +.. _class_@GlobalScope_constant_KEY_VOLUMEDOWN: + +.. _class_@GlobalScope_constant_KEY_VOLUMEMUTE: + +.. _class_@GlobalScope_constant_KEY_VOLUMEUP: + +.. _class_@GlobalScope_constant_KEY_BASSBOOST: + +.. _class_@GlobalScope_constant_KEY_BASSUP: + +.. _class_@GlobalScope_constant_KEY_BASSDOWN: + +.. _class_@GlobalScope_constant_KEY_TREBLEUP: + +.. _class_@GlobalScope_constant_KEY_TREBLEDOWN: + +.. _class_@GlobalScope_constant_KEY_MEDIAPLAY: + +.. _class_@GlobalScope_constant_KEY_MEDIASTOP: + +.. _class_@GlobalScope_constant_KEY_MEDIAPREVIOUS: + +.. _class_@GlobalScope_constant_KEY_MEDIANEXT: + +.. _class_@GlobalScope_constant_KEY_MEDIARECORD: + +.. _class_@GlobalScope_constant_KEY_HOMEPAGE: + +.. _class_@GlobalScope_constant_KEY_FAVORITES: + +.. _class_@GlobalScope_constant_KEY_SEARCH: + +.. _class_@GlobalScope_constant_KEY_STANDBY: + +.. _class_@GlobalScope_constant_KEY_OPENURL: + +.. _class_@GlobalScope_constant_KEY_LAUNCHMAIL: + +.. _class_@GlobalScope_constant_KEY_LAUNCHMEDIA: + +.. _class_@GlobalScope_constant_KEY_LAUNCH0: + +.. _class_@GlobalScope_constant_KEY_LAUNCH1: + +.. _class_@GlobalScope_constant_KEY_LAUNCH2: + +.. _class_@GlobalScope_constant_KEY_LAUNCH3: + +.. _class_@GlobalScope_constant_KEY_LAUNCH4: + +.. _class_@GlobalScope_constant_KEY_LAUNCH5: + +.. _class_@GlobalScope_constant_KEY_LAUNCH6: + +.. _class_@GlobalScope_constant_KEY_LAUNCH7: + +.. _class_@GlobalScope_constant_KEY_LAUNCH8: + +.. _class_@GlobalScope_constant_KEY_LAUNCH9: + +.. _class_@GlobalScope_constant_KEY_LAUNCHA: + +.. _class_@GlobalScope_constant_KEY_LAUNCHB: + +.. _class_@GlobalScope_constant_KEY_LAUNCHC: + +.. _class_@GlobalScope_constant_KEY_LAUNCHD: + +.. _class_@GlobalScope_constant_KEY_LAUNCHE: + +.. _class_@GlobalScope_constant_KEY_LAUNCHF: + +.. _class_@GlobalScope_constant_KEY_UNKNOWN: + +.. _class_@GlobalScope_constant_KEY_SPACE: + +.. _class_@GlobalScope_constant_KEY_EXCLAM: + +.. _class_@GlobalScope_constant_KEY_QUOTEDBL: + +.. _class_@GlobalScope_constant_KEY_NUMBERSIGN: + +.. _class_@GlobalScope_constant_KEY_DOLLAR: + +.. _class_@GlobalScope_constant_KEY_PERCENT: + +.. _class_@GlobalScope_constant_KEY_AMPERSAND: + +.. _class_@GlobalScope_constant_KEY_APOSTROPHE: + +.. _class_@GlobalScope_constant_KEY_PARENLEFT: + +.. _class_@GlobalScope_constant_KEY_PARENRIGHT: + +.. _class_@GlobalScope_constant_KEY_ASTERISK: + +.. _class_@GlobalScope_constant_KEY_PLUS: + +.. _class_@GlobalScope_constant_KEY_COMMA: + +.. _class_@GlobalScope_constant_KEY_MINUS: + +.. _class_@GlobalScope_constant_KEY_PERIOD: + +.. _class_@GlobalScope_constant_KEY_SLASH: + +.. _class_@GlobalScope_constant_KEY_0: + +.. _class_@GlobalScope_constant_KEY_1: + +.. _class_@GlobalScope_constant_KEY_2: + +.. _class_@GlobalScope_constant_KEY_3: + +.. _class_@GlobalScope_constant_KEY_4: + +.. _class_@GlobalScope_constant_KEY_5: + +.. _class_@GlobalScope_constant_KEY_6: + +.. _class_@GlobalScope_constant_KEY_7: + +.. _class_@GlobalScope_constant_KEY_8: + +.. _class_@GlobalScope_constant_KEY_9: + +.. _class_@GlobalScope_constant_KEY_COLON: + +.. _class_@GlobalScope_constant_KEY_SEMICOLON: + +.. _class_@GlobalScope_constant_KEY_LESS: + +.. _class_@GlobalScope_constant_KEY_EQUAL: + +.. _class_@GlobalScope_constant_KEY_GREATER: + +.. _class_@GlobalScope_constant_KEY_QUESTION: + +.. _class_@GlobalScope_constant_KEY_AT: + +.. _class_@GlobalScope_constant_KEY_A: + +.. _class_@GlobalScope_constant_KEY_B: + +.. _class_@GlobalScope_constant_KEY_C: + +.. _class_@GlobalScope_constant_KEY_D: + +.. _class_@GlobalScope_constant_KEY_E: + +.. _class_@GlobalScope_constant_KEY_F: + +.. _class_@GlobalScope_constant_KEY_G: + +.. _class_@GlobalScope_constant_KEY_H: + +.. _class_@GlobalScope_constant_KEY_I: + +.. _class_@GlobalScope_constant_KEY_J: + +.. _class_@GlobalScope_constant_KEY_K: + +.. _class_@GlobalScope_constant_KEY_L: + +.. _class_@GlobalScope_constant_KEY_M: + +.. _class_@GlobalScope_constant_KEY_N: + +.. _class_@GlobalScope_constant_KEY_O: + +.. _class_@GlobalScope_constant_KEY_P: + +.. _class_@GlobalScope_constant_KEY_Q: + +.. _class_@GlobalScope_constant_KEY_R: + +.. _class_@GlobalScope_constant_KEY_S: + +.. _class_@GlobalScope_constant_KEY_T: + +.. _class_@GlobalScope_constant_KEY_U: + +.. _class_@GlobalScope_constant_KEY_V: + +.. _class_@GlobalScope_constant_KEY_W: + +.. _class_@GlobalScope_constant_KEY_X: + +.. _class_@GlobalScope_constant_KEY_Y: + +.. _class_@GlobalScope_constant_KEY_Z: + +.. _class_@GlobalScope_constant_KEY_BRACKETLEFT: + +.. _class_@GlobalScope_constant_KEY_BACKSLASH: + +.. _class_@GlobalScope_constant_KEY_BRACKETRIGHT: + +.. _class_@GlobalScope_constant_KEY_ASCIICIRCUM: + +.. _class_@GlobalScope_constant_KEY_UNDERSCORE: + +.. _class_@GlobalScope_constant_KEY_QUOTELEFT: + +.. _class_@GlobalScope_constant_KEY_BRACELEFT: + +.. _class_@GlobalScope_constant_KEY_BAR: + +.. _class_@GlobalScope_constant_KEY_BRACERIGHT: + +.. _class_@GlobalScope_constant_KEY_ASCIITILDE: + +.. _class_@GlobalScope_constant_KEY_NOBREAKSPACE: + +.. _class_@GlobalScope_constant_KEY_EXCLAMDOWN: + +.. _class_@GlobalScope_constant_KEY_CENT: + +.. _class_@GlobalScope_constant_KEY_STERLING: + +.. _class_@GlobalScope_constant_KEY_CURRENCY: + +.. _class_@GlobalScope_constant_KEY_YEN: + +.. _class_@GlobalScope_constant_KEY_BROKENBAR: + +.. _class_@GlobalScope_constant_KEY_SECTION: + +.. _class_@GlobalScope_constant_KEY_DIAERESIS: + +.. _class_@GlobalScope_constant_KEY_COPYRIGHT: + +.. _class_@GlobalScope_constant_KEY_ORDFEMININE: + +.. _class_@GlobalScope_constant_KEY_GUILLEMOTLEFT: + +.. _class_@GlobalScope_constant_KEY_NOTSIGN: + +.. _class_@GlobalScope_constant_KEY_HYPHEN: + +.. _class_@GlobalScope_constant_KEY_REGISTERED: + +.. _class_@GlobalScope_constant_KEY_MACRON: + +.. _class_@GlobalScope_constant_KEY_DEGREE: + +.. _class_@GlobalScope_constant_KEY_PLUSMINUS: + +.. _class_@GlobalScope_constant_KEY_TWOSUPERIOR: + +.. _class_@GlobalScope_constant_KEY_THREESUPERIOR: + +.. _class_@GlobalScope_constant_KEY_ACUTE: + +.. _class_@GlobalScope_constant_KEY_MU: + +.. _class_@GlobalScope_constant_KEY_PARAGRAPH: + +.. _class_@GlobalScope_constant_KEY_PERIODCENTERED: + +.. _class_@GlobalScope_constant_KEY_CEDILLA: + +.. _class_@GlobalScope_constant_KEY_ONESUPERIOR: + +.. _class_@GlobalScope_constant_KEY_MASCULINE: + +.. _class_@GlobalScope_constant_KEY_GUILLEMOTRIGHT: + +.. _class_@GlobalScope_constant_KEY_ONEQUARTER: + +.. _class_@GlobalScope_constant_KEY_ONEHALF: + +.. _class_@GlobalScope_constant_KEY_THREEQUARTERS: + +.. _class_@GlobalScope_constant_KEY_QUESTIONDOWN: + +.. _class_@GlobalScope_constant_KEY_AGRAVE: + +.. _class_@GlobalScope_constant_KEY_AACUTE: + +.. _class_@GlobalScope_constant_KEY_ACIRCUMFLEX: + +.. _class_@GlobalScope_constant_KEY_ATILDE: + +.. _class_@GlobalScope_constant_KEY_ADIAERESIS: + +.. _class_@GlobalScope_constant_KEY_ARING: + +.. _class_@GlobalScope_constant_KEY_AE: + +.. _class_@GlobalScope_constant_KEY_CCEDILLA: + +.. _class_@GlobalScope_constant_KEY_EGRAVE: + +.. _class_@GlobalScope_constant_KEY_EACUTE: + +.. _class_@GlobalScope_constant_KEY_ECIRCUMFLEX: + +.. _class_@GlobalScope_constant_KEY_EDIAERESIS: + +.. _class_@GlobalScope_constant_KEY_IGRAVE: + +.. _class_@GlobalScope_constant_KEY_IACUTE: + +.. _class_@GlobalScope_constant_KEY_ICIRCUMFLEX: + +.. _class_@GlobalScope_constant_KEY_IDIAERESIS: + +.. _class_@GlobalScope_constant_KEY_ETH: + +.. _class_@GlobalScope_constant_KEY_NTILDE: + +.. _class_@GlobalScope_constant_KEY_OGRAVE: + +.. _class_@GlobalScope_constant_KEY_OACUTE: + +.. _class_@GlobalScope_constant_KEY_OCIRCUMFLEX: + +.. _class_@GlobalScope_constant_KEY_OTILDE: + +.. _class_@GlobalScope_constant_KEY_ODIAERESIS: + +.. _class_@GlobalScope_constant_KEY_MULTIPLY: + +.. _class_@GlobalScope_constant_KEY_OOBLIQUE: + +.. _class_@GlobalScope_constant_KEY_UGRAVE: + +.. _class_@GlobalScope_constant_KEY_UACUTE: + +.. _class_@GlobalScope_constant_KEY_UCIRCUMFLEX: + +.. _class_@GlobalScope_constant_KEY_UDIAERESIS: + +.. _class_@GlobalScope_constant_KEY_YACUTE: + +.. _class_@GlobalScope_constant_KEY_THORN: + +.. _class_@GlobalScope_constant_KEY_SSHARP: + +.. _class_@GlobalScope_constant_KEY_DIVISION: + +.. _class_@GlobalScope_constant_KEY_YDIAERESIS: + enum **KeyList**: - **KEY_ESCAPE** = **16777217** --- Escape Key @@ -606,6 +1122,24 @@ enum **KeyList**: .. _enum_@GlobalScope_KeyModifierMask: +.. _class_@GlobalScope_constant_KEY_CODE_MASK: + +.. _class_@GlobalScope_constant_KEY_MODIFIER_MASK: + +.. _class_@GlobalScope_constant_KEY_MASK_SHIFT: + +.. _class_@GlobalScope_constant_KEY_MASK_ALT: + +.. _class_@GlobalScope_constant_KEY_MASK_META: + +.. _class_@GlobalScope_constant_KEY_MASK_CTRL: + +.. _class_@GlobalScope_constant_KEY_MASK_CMD: + +.. _class_@GlobalScope_constant_KEY_MASK_KPAD: + +.. _class_@GlobalScope_constant_KEY_MASK_GROUP_SWITCH: + enum **KeyModifierMask**: - **KEY_CODE_MASK** = **33554431** --- Key Code Mask @@ -628,6 +1162,34 @@ enum **KeyModifierMask**: .. _enum_@GlobalScope_ButtonList: +.. _class_@GlobalScope_constant_BUTTON_LEFT: + +.. _class_@GlobalScope_constant_BUTTON_RIGHT: + +.. _class_@GlobalScope_constant_BUTTON_MIDDLE: + +.. _class_@GlobalScope_constant_BUTTON_XBUTTON1: + +.. _class_@GlobalScope_constant_BUTTON_XBUTTON2: + +.. _class_@GlobalScope_constant_BUTTON_WHEEL_UP: + +.. _class_@GlobalScope_constant_BUTTON_WHEEL_DOWN: + +.. _class_@GlobalScope_constant_BUTTON_WHEEL_LEFT: + +.. _class_@GlobalScope_constant_BUTTON_WHEEL_RIGHT: + +.. _class_@GlobalScope_constant_BUTTON_MASK_LEFT: + +.. _class_@GlobalScope_constant_BUTTON_MASK_RIGHT: + +.. _class_@GlobalScope_constant_BUTTON_MASK_MIDDLE: + +.. _class_@GlobalScope_constant_BUTTON_MASK_XBUTTON1: + +.. _class_@GlobalScope_constant_BUTTON_MASK_XBUTTON2: + enum **ButtonList**: - **BUTTON_LEFT** = **1** --- Left Mouse Button @@ -660,6 +1222,122 @@ enum **ButtonList**: .. _enum_@GlobalScope_JoystickList: +.. _class_@GlobalScope_constant_JOY_BUTTON_0: + +.. _class_@GlobalScope_constant_JOY_BUTTON_1: + +.. _class_@GlobalScope_constant_JOY_BUTTON_2: + +.. _class_@GlobalScope_constant_JOY_BUTTON_3: + +.. _class_@GlobalScope_constant_JOY_BUTTON_4: + +.. _class_@GlobalScope_constant_JOY_BUTTON_5: + +.. _class_@GlobalScope_constant_JOY_BUTTON_6: + +.. _class_@GlobalScope_constant_JOY_BUTTON_7: + +.. _class_@GlobalScope_constant_JOY_BUTTON_8: + +.. _class_@GlobalScope_constant_JOY_BUTTON_9: + +.. _class_@GlobalScope_constant_JOY_BUTTON_10: + +.. _class_@GlobalScope_constant_JOY_BUTTON_11: + +.. _class_@GlobalScope_constant_JOY_BUTTON_12: + +.. _class_@GlobalScope_constant_JOY_BUTTON_13: + +.. _class_@GlobalScope_constant_JOY_BUTTON_14: + +.. _class_@GlobalScope_constant_JOY_BUTTON_15: + +.. _class_@GlobalScope_constant_JOY_BUTTON_MAX: + +.. _class_@GlobalScope_constant_JOY_SONY_CIRCLE: + +.. _class_@GlobalScope_constant_JOY_SONY_X: + +.. _class_@GlobalScope_constant_JOY_SONY_SQUARE: + +.. _class_@GlobalScope_constant_JOY_SONY_TRIANGLE: + +.. _class_@GlobalScope_constant_JOY_XBOX_B: + +.. _class_@GlobalScope_constant_JOY_XBOX_A: + +.. _class_@GlobalScope_constant_JOY_XBOX_X: + +.. _class_@GlobalScope_constant_JOY_XBOX_Y: + +.. _class_@GlobalScope_constant_JOY_DS_A: + +.. _class_@GlobalScope_constant_JOY_DS_B: + +.. _class_@GlobalScope_constant_JOY_DS_X: + +.. _class_@GlobalScope_constant_JOY_DS_Y: + +.. _class_@GlobalScope_constant_JOY_SELECT: + +.. _class_@GlobalScope_constant_JOY_START: + +.. _class_@GlobalScope_constant_JOY_DPAD_UP: + +.. _class_@GlobalScope_constant_JOY_DPAD_DOWN: + +.. _class_@GlobalScope_constant_JOY_DPAD_LEFT: + +.. _class_@GlobalScope_constant_JOY_DPAD_RIGHT: + +.. _class_@GlobalScope_constant_JOY_L: + +.. _class_@GlobalScope_constant_JOY_L2: + +.. _class_@GlobalScope_constant_JOY_L3: + +.. _class_@GlobalScope_constant_JOY_R: + +.. _class_@GlobalScope_constant_JOY_R2: + +.. _class_@GlobalScope_constant_JOY_R3: + +.. _class_@GlobalScope_constant_JOY_AXIS_0: + +.. _class_@GlobalScope_constant_JOY_AXIS_1: + +.. _class_@GlobalScope_constant_JOY_AXIS_2: + +.. _class_@GlobalScope_constant_JOY_AXIS_3: + +.. _class_@GlobalScope_constant_JOY_AXIS_4: + +.. _class_@GlobalScope_constant_JOY_AXIS_5: + +.. _class_@GlobalScope_constant_JOY_AXIS_6: + +.. _class_@GlobalScope_constant_JOY_AXIS_7: + +.. _class_@GlobalScope_constant_JOY_AXIS_8: + +.. _class_@GlobalScope_constant_JOY_AXIS_9: + +.. _class_@GlobalScope_constant_JOY_AXIS_MAX: + +.. _class_@GlobalScope_constant_JOY_ANALOG_LX: + +.. _class_@GlobalScope_constant_JOY_ANALOG_LY: + +.. _class_@GlobalScope_constant_JOY_ANALOG_RX: + +.. _class_@GlobalScope_constant_JOY_ANALOG_RY: + +.. _class_@GlobalScope_constant_JOY_ANALOG_L2: + +.. _class_@GlobalScope_constant_JOY_ANALOG_R2: + enum **JoystickList**: - **JOY_BUTTON_0** = **0** --- Joypad Button 0 @@ -780,6 +1458,20 @@ enum **JoystickList**: .. _enum_@GlobalScope_MidiMessageList: +.. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF: + +.. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON: + +.. _class_@GlobalScope_constant_MIDI_MESSAGE_AFTERTOUCH: + +.. _class_@GlobalScope_constant_MIDI_MESSAGE_CONTROL_CHANGE: + +.. _class_@GlobalScope_constant_MIDI_MESSAGE_PROGRAM_CHANGE: + +.. _class_@GlobalScope_constant_MIDI_MESSAGE_CHANNEL_PRESSURE: + +.. _class_@GlobalScope_constant_MIDI_MESSAGE_PITCH_BEND: + enum **MidiMessageList**: - **MIDI_MESSAGE_NOTE_OFF** = **8** @@ -798,6 +1490,88 @@ enum **MidiMessageList**: .. _enum_@GlobalScope_Error: +.. _class_@GlobalScope_constant_OK: + +.. _class_@GlobalScope_constant_FAILED: + +.. _class_@GlobalScope_constant_ERR_UNAVAILABLE: + +.. _class_@GlobalScope_constant_ERR_UNCONFIGURED: + +.. _class_@GlobalScope_constant_ERR_UNAUTHORIZED: + +.. _class_@GlobalScope_constant_ERR_PARAMETER_RANGE_ERROR: + +.. _class_@GlobalScope_constant_ERR_OUT_OF_MEMORY: + +.. _class_@GlobalScope_constant_ERR_FILE_NOT_FOUND: + +.. _class_@GlobalScope_constant_ERR_FILE_BAD_DRIVE: + +.. _class_@GlobalScope_constant_ERR_FILE_BAD_PATH: + +.. _class_@GlobalScope_constant_ERR_FILE_NO_PERMISSION: + +.. _class_@GlobalScope_constant_ERR_FILE_ALREADY_IN_USE: + +.. _class_@GlobalScope_constant_ERR_FILE_CANT_OPEN: + +.. _class_@GlobalScope_constant_ERR_FILE_CANT_WRITE: + +.. _class_@GlobalScope_constant_ERR_FILE_CANT_READ: + +.. _class_@GlobalScope_constant_ERR_FILE_UNRECOGNIZED: + +.. _class_@GlobalScope_constant_ERR_FILE_CORRUPT: + +.. _class_@GlobalScope_constant_ERR_FILE_MISSING_DEPENDENCIES: + +.. _class_@GlobalScope_constant_ERR_FILE_EOF: + +.. _class_@GlobalScope_constant_ERR_CANT_OPEN: + +.. _class_@GlobalScope_constant_ERR_CANT_CREATE: + +.. _class_@GlobalScope_constant_ERR_PARSE_ERROR: + +.. _class_@GlobalScope_constant_ERR_QUERY_FAILED: + +.. _class_@GlobalScope_constant_ERR_ALREADY_IN_USE: + +.. _class_@GlobalScope_constant_ERR_LOCKED: + +.. _class_@GlobalScope_constant_ERR_TIMEOUT: + +.. _class_@GlobalScope_constant_ERR_CANT_ACQUIRE_RESOURCE: + +.. _class_@GlobalScope_constant_ERR_INVALID_DATA: + +.. _class_@GlobalScope_constant_ERR_INVALID_PARAMETER: + +.. _class_@GlobalScope_constant_ERR_ALREADY_EXISTS: + +.. _class_@GlobalScope_constant_ERR_DOES_NOT_EXIST: + +.. _class_@GlobalScope_constant_ERR_DATABASE_CANT_READ: + +.. _class_@GlobalScope_constant_ERR_DATABASE_CANT_WRITE: + +.. _class_@GlobalScope_constant_ERR_COMPILATION_FAILED: + +.. _class_@GlobalScope_constant_ERR_METHOD_NOT_FOUND: + +.. _class_@GlobalScope_constant_ERR_LINK_FAILED: + +.. _class_@GlobalScope_constant_ERR_SCRIPT_FAILED: + +.. _class_@GlobalScope_constant_ERR_CYCLIC_LINK: + +.. _class_@GlobalScope_constant_ERR_BUSY: + +.. _class_@GlobalScope_constant_ERR_HELP: + +.. _class_@GlobalScope_constant_ERR_BUG: + enum **Error**: - **OK** = **0** --- Functions that return Error return OK when no error occurred. Most functions don't return errors and/or just print errors to STDOUT. @@ -884,6 +1658,50 @@ enum **Error**: .. _enum_@GlobalScope_PropertyHint: +.. _class_@GlobalScope_constant_PROPERTY_HINT_NONE: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_RANGE: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_EXP_RANGE: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_ENUM: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_EXP_EASING: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_LENGTH: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_KEY_ACCEL: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_FLAGS: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_RENDER: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_PHYSICS: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_RENDER: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_PHYSICS: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_FILE: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_DIR: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_FILE: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_DIR: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_RESOURCE_TYPE: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_MULTILINE_TEXT: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_PLACEHOLDER_TEXT: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_COLOR_NO_ALPHA: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_IMAGE_COMPRESS_LOSSY: + +.. _class_@GlobalScope_constant_PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS: + enum **PropertyHint**: - **PROPERTY_HINT_NONE** = **0** --- No hint for edited property. @@ -932,6 +1750,36 @@ enum **PropertyHint**: .. _enum_@GlobalScope_PropertyUsageFlags: +.. _class_@GlobalScope_constant_PROPERTY_USAGE_STORAGE: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_NETWORK: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR_HELPER: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_CHECKABLE: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_CHECKED: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_INTERNATIONALIZED: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_GROUP: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_CATEGORY: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_NO_INSTANCE_STATE: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_RESTART_IF_CHANGED: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_SCRIPT_VARIABLE: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFAULT: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFAULT_INTL: + +.. _class_@GlobalScope_constant_PROPERTY_USAGE_NOEDITOR: + enum **PropertyUsageFlags**: - **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default). @@ -966,6 +1814,22 @@ enum **PropertyUsageFlags**: .. _enum_@GlobalScope_MethodFlags: +.. _class_@GlobalScope_constant_METHOD_FLAG_NORMAL: + +.. _class_@GlobalScope_constant_METHOD_FLAG_EDITOR: + +.. _class_@GlobalScope_constant_METHOD_FLAG_NOSCRIPT: + +.. _class_@GlobalScope_constant_METHOD_FLAG_CONST: + +.. _class_@GlobalScope_constant_METHOD_FLAG_REVERSE: + +.. _class_@GlobalScope_constant_METHOD_FLAG_VIRTUAL: + +.. _class_@GlobalScope_constant_METHOD_FLAG_FROM_SCRIPT: + +.. _class_@GlobalScope_constant_METHOD_FLAGS_DEFAULT: + enum **MethodFlags**: - **METHOD_FLAG_NORMAL** = **1** --- Flag for normal method @@ -986,6 +1850,62 @@ enum **MethodFlags**: .. _enum_@GlobalScope_Variant.Type: +.. _class_@GlobalScope_constant_TYPE_NIL: + +.. _class_@GlobalScope_constant_TYPE_BOOL: + +.. _class_@GlobalScope_constant_TYPE_INT: + +.. _class_@GlobalScope_constant_TYPE_REAL: + +.. _class_@GlobalScope_constant_TYPE_STRING: + +.. _class_@GlobalScope_constant_TYPE_VECTOR2: + +.. _class_@GlobalScope_constant_TYPE_RECT2: + +.. _class_@GlobalScope_constant_TYPE_VECTOR3: + +.. _class_@GlobalScope_constant_TYPE_TRANSFORM2D: + +.. _class_@GlobalScope_constant_TYPE_PLANE: + +.. _class_@GlobalScope_constant_TYPE_QUAT: + +.. _class_@GlobalScope_constant_TYPE_AABB: + +.. _class_@GlobalScope_constant_TYPE_BASIS: + +.. _class_@GlobalScope_constant_TYPE_TRANSFORM: + +.. _class_@GlobalScope_constant_TYPE_COLOR: + +.. _class_@GlobalScope_constant_TYPE_NODE_PATH: + +.. _class_@GlobalScope_constant_TYPE_RID: + +.. _class_@GlobalScope_constant_TYPE_OBJECT: + +.. _class_@GlobalScope_constant_TYPE_DICTIONARY: + +.. _class_@GlobalScope_constant_TYPE_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_RAW_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_INT_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_REAL_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_STRING_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_VECTOR2_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_VECTOR3_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_COLOR_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_MAX: + enum **Variant.Type**: - **TYPE_NIL** = **0** --- Variable is of type nil (only applied for null). @@ -1046,6 +1966,58 @@ enum **Variant.Type**: .. _enum_@GlobalScope_Variant.Operator: +.. _class_@GlobalScope_constant_OP_EQUAL: + +.. _class_@GlobalScope_constant_OP_NOT_EQUAL: + +.. _class_@GlobalScope_constant_OP_LESS: + +.. _class_@GlobalScope_constant_OP_LESS_EQUAL: + +.. _class_@GlobalScope_constant_OP_GREATER: + +.. _class_@GlobalScope_constant_OP_GREATER_EQUAL: + +.. _class_@GlobalScope_constant_OP_ADD: + +.. _class_@GlobalScope_constant_OP_SUBTRACT: + +.. _class_@GlobalScope_constant_OP_MULTIPLY: + +.. _class_@GlobalScope_constant_OP_DIVIDE: + +.. _class_@GlobalScope_constant_OP_NEGATE: + +.. _class_@GlobalScope_constant_OP_POSITIVE: + +.. _class_@GlobalScope_constant_OP_MODULE: + +.. _class_@GlobalScope_constant_OP_STRING_CONCAT: + +.. _class_@GlobalScope_constant_OP_SHIFT_LEFT: + +.. _class_@GlobalScope_constant_OP_SHIFT_RIGHT: + +.. _class_@GlobalScope_constant_OP_BIT_AND: + +.. _class_@GlobalScope_constant_OP_BIT_OR: + +.. _class_@GlobalScope_constant_OP_BIT_XOR: + +.. _class_@GlobalScope_constant_OP_BIT_NEGATE: + +.. _class_@GlobalScope_constant_OP_AND: + +.. _class_@GlobalScope_constant_OP_OR: + +.. _class_@GlobalScope_constant_OP_XOR: + +.. _class_@GlobalScope_constant_OP_NOT: + +.. _class_@GlobalScope_constant_OP_IN: + +.. _class_@GlobalScope_constant_OP_MAX: + enum **Variant.Operator**: - **OP_EQUAL** = **0** @@ -1103,6 +2075,8 @@ enum **Variant.Operator**: Constants --------- +.. _class_@GlobalScope_constant_SPKEY: + - **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable. Description @@ -1115,127 +2089,127 @@ Singletons are also documented here, since they can be accessed from anywhere. Property Descriptions --------------------- -.. _class_@GlobalScope_ARVRServer: +.. _class_@GlobalScope_property_ARVRServer: - :ref:`ARVRServer` **ARVRServer** :ref:`ARVRServer` singleton -.. _class_@GlobalScope_AudioServer: +.. _class_@GlobalScope_property_AudioServer: - :ref:`AudioServer` **AudioServer** :ref:`AudioServer` singleton -.. _class_@GlobalScope_ClassDB: +.. _class_@GlobalScope_property_ClassDB: - :ref:`ClassDB` **ClassDB** :ref:`ClassDB` singleton -.. _class_@GlobalScope_Engine: +.. _class_@GlobalScope_property_Engine: - :ref:`Engine` **Engine** :ref:`Engine` singleton -.. _class_@GlobalScope_Geometry: +.. _class_@GlobalScope_property_Geometry: - :ref:`Geometry` **Geometry** :ref:`Geometry` singleton -.. _class_@GlobalScope_IP: +.. _class_@GlobalScope_property_IP: - :ref:`IP` **IP** :ref:`IP` singleton -.. _class_@GlobalScope_Input: +.. _class_@GlobalScope_property_Input: - :ref:`Input` **Input** :ref:`Input` singleton -.. _class_@GlobalScope_InputMap: +.. _class_@GlobalScope_property_InputMap: - :ref:`InputMap` **InputMap** :ref:`InputMap` singleton -.. _class_@GlobalScope_JSON: +.. _class_@GlobalScope_property_JSON: - :ref:`JSON` **JSON** :ref:`JSON` singleton -.. _class_@GlobalScope_JavaScript: +.. _class_@GlobalScope_property_JavaScript: - :ref:`JavaScript` **JavaScript** :ref:`JavaScript` singleton -.. _class_@GlobalScope_Marshalls: +.. _class_@GlobalScope_property_Marshalls: - :ref:`Reference` **Marshalls** :ref:`Marshalls` singleton -.. _class_@GlobalScope_OS: +.. _class_@GlobalScope_property_OS: - :ref:`OS` **OS** :ref:`OS` singleton -.. _class_@GlobalScope_Performance: +.. _class_@GlobalScope_property_Performance: - :ref:`Performance` **Performance** :ref:`Performance` singleton -.. _class_@GlobalScope_Physics2DServer: +.. _class_@GlobalScope_property_Physics2DServer: - :ref:`Physics2DServer` **Physics2DServer** :ref:`Physics2DServer` singleton -.. _class_@GlobalScope_PhysicsServer: +.. _class_@GlobalScope_property_PhysicsServer: - :ref:`PhysicsServer` **PhysicsServer** :ref:`PhysicsServer` singleton -.. _class_@GlobalScope_ProjectSettings: +.. _class_@GlobalScope_property_ProjectSettings: - :ref:`ProjectSettings` **ProjectSettings** :ref:`ProjectSettings` singleton -.. _class_@GlobalScope_ResourceLoader: +.. _class_@GlobalScope_property_ResourceLoader: - :ref:`ResourceLoader` **ResourceLoader** :ref:`ResourceLoader` singleton -.. _class_@GlobalScope_ResourceSaver: +.. _class_@GlobalScope_property_ResourceSaver: - :ref:`ResourceSaver` **ResourceSaver** :ref:`ResourceSaver` singleton -.. _class_@GlobalScope_TranslationServer: +.. _class_@GlobalScope_property_TranslationServer: - :ref:`TranslationServer` **TranslationServer** :ref:`TranslationServer` singleton -.. _class_@GlobalScope_VisualScriptEditor: +.. _class_@GlobalScope_property_VisualScriptEditor: - :ref:`VisualScriptEditor` **VisualScriptEditor** :ref:`VisualScriptEditor` singleton -.. _class_@GlobalScope_VisualServer: +.. _class_@GlobalScope_property_VisualServer: - :ref:`VisualServer` **VisualServer** diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 62f9724a9..f6176d499 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -17,60 +17,60 @@ Axis-Aligned Bounding Box. Properties ---------- -+-------------------------------+--------------------------------------+ -| :ref:`Vector3` | :ref:`end` | -+-------------------------------+--------------------------------------+ -| :ref:`Vector3` | :ref:`position` | -+-------------------------------+--------------------------------------+ -| :ref:`Vector3` | :ref:`size` | -+-------------------------------+--------------------------------------+ ++-------------------------------+-----------------------------------------------+ +| :ref:`Vector3` | :ref:`end` | ++-------------------------------+-----------------------------------------------+ +| :ref:`Vector3` | :ref:`position` | ++-------------------------------+-----------------------------------------------+ +| :ref:`Vector3` | :ref:`size` | ++-------------------------------+-----------------------------------------------+ Methods ------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`encloses` **(** :ref:`AABB` with **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_area` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_area` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_surface` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`encloses` **(** :ref:`AABB` with **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_area` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_area` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_surface` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -85,19 +85,19 @@ Tutorials Property Descriptions --------------------- -.. _class_AABB_end: +.. _class_AABB_property_end: - :ref:`Vector3` **end** Ending corner. -.. _class_AABB_position: +.. _class_AABB_property_position: - :ref:`Vector3` **position** Beginning corner. -.. _class_AABB_size: +.. _class_AABB_property_size: - :ref:`Vector3` **size** @@ -106,127 +106,127 @@ Size from position to end. Method Descriptions ------------------- -.. _class_AABB_AABB: +.. _class_AABB_method_AABB: - :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** Optional constructor, accepts position and size. -.. _class_AABB_encloses: +.. _class_AABB_method_encloses: - :ref:`bool` **encloses** **(** :ref:`AABB` with **)** Returns ``true`` if this ``AABB`` completely encloses another one. -.. _class_AABB_expand: +.. _class_AABB_method_expand: - :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** Returns this ``AABB`` expanded to include a given point. -.. _class_AABB_get_area: +.. _class_AABB_method_get_area: - :ref:`float` **get_area** **(** **)** Gets the area of the ``AABB``. -.. _class_AABB_get_endpoint: +.. _class_AABB_method_get_endpoint: - :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** Gets the position of the 8 endpoints of the ``AABB`` in space. -.. _class_AABB_get_longest_axis: +.. _class_AABB_method_get_longest_axis: - :ref:`Vector3` **get_longest_axis** **(** **)** Returns the normalized longest axis of the ``AABB``. -.. _class_AABB_get_longest_axis_index: +.. _class_AABB_method_get_longest_axis_index: - :ref:`int` **get_longest_axis_index** **(** **)** Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). -.. _class_AABB_get_longest_axis_size: +.. _class_AABB_method_get_longest_axis_size: - :ref:`float` **get_longest_axis_size** **(** **)** Returns the scalar length of the longest axis of the ``AABB``. -.. _class_AABB_get_shortest_axis: +.. _class_AABB_method_get_shortest_axis: - :ref:`Vector3` **get_shortest_axis** **(** **)** Returns the normalized shortest axis of the ``AABB``. -.. _class_AABB_get_shortest_axis_index: +.. _class_AABB_method_get_shortest_axis_index: - :ref:`int` **get_shortest_axis_index** **(** **)** Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). -.. _class_AABB_get_shortest_axis_size: +.. _class_AABB_method_get_shortest_axis_size: - :ref:`float` **get_shortest_axis_size** **(** **)** Returns the scalar length of the shortest axis of the ``AABB``. -.. _class_AABB_get_support: +.. _class_AABB_method_get_support: - :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** Returns the support point in a given direction. This is useful for collision detection algorithms. -.. _class_AABB_grow: +.. _class_AABB_method_grow: - :ref:`AABB` **grow** **(** :ref:`float` by **)** Returns a copy of the ``AABB`` grown a given amount of units towards all the sides. -.. _class_AABB_has_no_area: +.. _class_AABB_method_has_no_area: - :ref:`bool` **has_no_area** **(** **)** Returns ``true`` if the ``AABB`` is flat or empty. -.. _class_AABB_has_no_surface: +.. _class_AABB_method_has_no_surface: - :ref:`bool` **has_no_surface** **(** **)** Returns ``true`` if the ``AABB`` is empty. -.. _class_AABB_has_point: +.. _class_AABB_method_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** Returns ``true`` if the ``AABB`` contains a point. -.. _class_AABB_intersection: +.. _class_AABB_method_intersection: - :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** Returns the intersection between two ``AABB``. An empty AABB (size 0,0,0) is returned on failure. -.. _class_AABB_intersects: +.. _class_AABB_method_intersects: - :ref:`bool` **intersects** **(** :ref:`AABB` with **)** Returns ``true`` if the ``AABB`` overlaps with another. -.. _class_AABB_intersects_plane: +.. _class_AABB_method_intersects_plane: - :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** Returns ``true`` if the ``AABB`` is on both sides of a plane. -.. _class_AABB_intersects_segment: +.. _class_AABB_method_intersects_segment: - :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** Returns ``true`` if the ``AABB`` intersects the line segment between ``from`` and ``to``. -.. _class_AABB_merge: +.. _class_AABB_method_merge: - :ref:`AABB` **merge** **(** :ref:`AABB` with **)** diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index cdc9a8466..60d599e73 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -21,41 +21,41 @@ Base dialog for user notification. Properties ---------- -+-----------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`dialog_hide_on_ok` | -+-----------------------------+----------------------------------------------------------------+ -| :ref:`String` | :ref:`dialog_text` | -+-----------------------------+----------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`dialog_hide_on_ok` | ++-----------------------------+-------------------------------------------------------------------------+ +| :ref:`String` | :ref:`dialog_text` | ++-----------------------------+-------------------------------------------------------------------------+ Methods ------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Label` | :ref:`get_label` **(** **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`get_ok` **(** **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Label` | :ref:`get_label` **(** **)** | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`get_ok` **(** **)** | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | ++-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AcceptDialog_confirmed: +.. _class_AcceptDialog_signal_confirmed: - **confirmed** **(** **)** Emitted when the dialog is accepted, i.e. the OK button is pressed. -.. _class_AcceptDialog_custom_action: +.. _class_AcceptDialog_signal_custom_action: - **custom_action** **(** :ref:`String` action **)** -Emitted when a custom button is pressed. See :ref:`add_button`. +Emitted when a custom button is pressed. See :ref:`add_button`. Description ----------- @@ -65,7 +65,7 @@ This dialog is useful for small notifications to the user about an event. It can Property Descriptions --------------------- -.. _class_AcceptDialog_dialog_hide_on_ok: +.. _class_AcceptDialog_property_dialog_hide_on_ok: - :ref:`bool` **dialog_hide_on_ok** @@ -75,11 +75,11 @@ Property Descriptions | *Getter* | get_hide_on_ok() | +----------+-----------------------+ -If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed` signal, and handle hiding the dialog in your own logic. Default value: ``true``. +If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed` signal, and handle hiding the dialog in your own logic. Default value: ``true``. Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example :ref:`FileDialog` defaults to ``false``, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in :ref:`FileDialog` to disable hiding the dialog when pressing OK. -.. _class_AcceptDialog_dialog_text: +.. _class_AcceptDialog_property_dialog_text: - :ref:`String` **dialog_text** @@ -94,33 +94,33 @@ The text displayed by this dialog. Method Descriptions ------------------- -.. _class_AcceptDialog_add_button: +.. _class_AcceptDialog_method_add_button: - :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** -Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the :ref:`custom_action` signal when pressed. +Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the :ref:`custom_action` signal when pressed. If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``. -.. _class_AcceptDialog_add_cancel: +.. _class_AcceptDialog_method_add_cancel: - :ref:`Button` **add_cancel** **(** :ref:`String` name **)** Adds a button with label *name* and a cancel action to the dialog and returns the created button. -.. _class_AcceptDialog_get_label: +.. _class_AcceptDialog_method_get_label: - :ref:`Label` **get_label** **(** **)** Return the label used for built-in text. -.. _class_AcceptDialog_get_ok: +.. _class_AcceptDialog_method_get_ok: - :ref:`Button` **get_ok** **(** **)** Return the OK Button. -.. _class_AcceptDialog_register_text_enter: +.. _class_AcceptDialog_method_register_text_enter: - void **register_text_enter** **(** :ref:`Node` line_edit **)** diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 41c2f42d4..8996a625c 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -19,51 +19,51 @@ Sprite node that can use multiple textures for animation. Properties ---------- -+-----------------------------------------+------------------------------------------------------+ -| :ref:`String` | :ref:`animation` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`centered` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_h` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_v` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`frame` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`SpriteFrames` | :ref:`frames` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+-----------------------------------------+------------------------------------------------------+ ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`String` | :ref:`animation` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`centered` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`flip_h` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`flip_v` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`frame` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`SpriteFrames` | :ref:`frames` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`offset` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`playing` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`speed_scale` | ++-----------------------------------------+---------------------------------------------------------------+ Methods ------- -+--------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | -+--------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+--------------------------+----------------------------------------------------------------------------------------+ ++-------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++-------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` anim="" **)** | ++-------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------+-----------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AnimatedSprite_animation_finished: +.. _class_AnimatedSprite_signal_animation_finished: - **animation_finished** **(** **)** Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn. -.. _class_AnimatedSprite_frame_changed: +.. _class_AnimatedSprite_signal_frame_changed: - **frame_changed** **(** **)** -Emitted when :ref:`frame` changed. +Emitted when :ref:`frame` changed. Description ----------- @@ -73,7 +73,7 @@ Animations are created using a :ref:`SpriteFrames` resource, Property Descriptions --------------------- -.. _class_AnimatedSprite_animation: +.. _class_AnimatedSprite_property_animation: - :ref:`String` **animation** @@ -85,7 +85,7 @@ Property Descriptions The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. -.. _class_AnimatedSprite_centered: +.. _class_AnimatedSprite_property_centered: - :ref:`bool` **centered** @@ -97,7 +97,7 @@ The current animation from the ``frames`` resource. If this value changes, the ` If ``true``, texture will be centered. Default value: ``true``. -.. _class_AnimatedSprite_flip_h: +.. _class_AnimatedSprite_property_flip_h: - :ref:`bool` **flip_h** @@ -109,7 +109,7 @@ If ``true``, texture will be centered. Default value: ``true``. If ``true``, texture is flipped horizontally. Default value: ``false``. -.. _class_AnimatedSprite_flip_v: +.. _class_AnimatedSprite_property_flip_v: - :ref:`bool` **flip_v** @@ -121,7 +121,7 @@ If ``true``, texture is flipped horizontally. Default value: ``false``. If ``true``, texture is flipped vertically. Default value: ``false``. -.. _class_AnimatedSprite_frame: +.. _class_AnimatedSprite_property_frame: - :ref:`int` **frame** @@ -133,7 +133,7 @@ If ``true``, texture is flipped vertically. Default value: ``false``. The displayed animation frame's index. -.. _class_AnimatedSprite_frames: +.. _class_AnimatedSprite_property_frames: - :ref:`SpriteFrames` **frames** @@ -145,7 +145,7 @@ The displayed animation frame's index. The :ref:`SpriteFrames` resource containing the animation(s). -.. _class_AnimatedSprite_offset: +.. _class_AnimatedSprite_property_offset: - :ref:`Vector2` **offset** @@ -157,13 +157,13 @@ The :ref:`SpriteFrames` resource containing the animation(s) The texture's drawing offset. -.. _class_AnimatedSprite_playing: +.. _class_AnimatedSprite_property_playing: - :ref:`bool` **playing** -If ``true``, the :ref:`animation` is currently playing. +If ``true``, the :ref:`animation` is currently playing. -.. _class_AnimatedSprite_speed_scale: +.. _class_AnimatedSprite_property_speed_scale: - :ref:`float` **speed_scale** @@ -176,19 +176,19 @@ If ``true``, the :ref:`animation` is currently p Method Descriptions ------------------- -.. _class_AnimatedSprite_is_playing: +.. _class_AnimatedSprite_method_is_playing: - :ref:`bool` **is_playing** **(** **)** const Return true if an animation if currently being played. -.. _class_AnimatedSprite_play: +.. _class_AnimatedSprite_method_play: - void **play** **(** :ref:`String` anim="" **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. -.. _class_AnimatedSprite_stop: +.. _class_AnimatedSprite_method_stop: - void **stop** **(** **)** diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 2ace1ae66..30991abe3 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -19,35 +19,35 @@ Brief Description Properties ---------- -+-----------------------------------------+----------------------------------------------------+ -| :ref:`String` | :ref:`animation` | -+-----------------------------------------+----------------------------------------------------+ -| :ref:`int` | :ref:`frame` | -+-----------------------------------------+----------------------------------------------------+ -| :ref:`SpriteFrames` | :ref:`frames` | -+-----------------------------------------+----------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+-----------------------------------------+----------------------------------------------------+ ++-----------------------------------------+-------------------------------------------------------------+ +| :ref:`String` | :ref:`animation` | ++-----------------------------------------+-------------------------------------------------------------+ +| :ref:`int` | :ref:`frame` | ++-----------------------------------------+-------------------------------------------------------------+ +| :ref:`SpriteFrames` | :ref:`frames` | ++-----------------------------------------+-------------------------------------------------------------+ +| :ref:`bool` | :ref:`playing` | ++-----------------------------------------+-------------------------------------------------------------+ Methods ------- -+--------------------------+------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | -+--------------------------+------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++-------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` anim="" **)** | ++-------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------+-------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AnimatedSprite3D_frame_changed: +.. _class_AnimatedSprite3D_signal_frame_changed: - **frame_changed** **(** **)** -Emitted when :ref:`frame` changed. +Emitted when :ref:`frame` changed. Description ----------- @@ -57,7 +57,7 @@ Animations are created using a :ref:`SpriteFrames` resource, Property Descriptions --------------------- -.. _class_AnimatedSprite3D_animation: +.. _class_AnimatedSprite3D_property_animation: - :ref:`String` **animation** @@ -69,7 +69,7 @@ Property Descriptions The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. -.. _class_AnimatedSprite3D_frame: +.. _class_AnimatedSprite3D_property_frame: - :ref:`int` **frame** @@ -81,7 +81,7 @@ The current animation from the ``frames`` resource. If this value changes, the ` The displayed animation frame's index. -.. _class_AnimatedSprite3D_frames: +.. _class_AnimatedSprite3D_property_frames: - :ref:`SpriteFrames` **frames** @@ -93,28 +93,28 @@ The displayed animation frame's index. The :ref:`SpriteFrames` resource containing the animation(s). -.. _class_AnimatedSprite3D_playing: +.. _class_AnimatedSprite3D_property_playing: - :ref:`bool` **playing** -If ``true``, the :ref:`animation` is currently playing. +If ``true``, the :ref:`animation` is currently playing. Method Descriptions ------------------- -.. _class_AnimatedSprite3D_is_playing: +.. _class_AnimatedSprite3D_method_is_playing: - :ref:`bool` **is_playing** **(** **)** const Return true if an animation if currently being played. -.. _class_AnimatedSprite3D_play: +.. _class_AnimatedSprite3D_method_play: - void **play** **(** :ref:`String` anim="" **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. -.. _class_AnimatedSprite3D_stop: +.. _class_AnimatedSprite3D_method_stop: - void **stop** **(** **)** diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index 7d19c41ae..ae9cca530 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -19,29 +19,29 @@ Brief Description Properties ---------- -+---------------------------+---------------------------------------------+ -| :ref:`float` | :ref:`fps` | -+---------------------------+---------------------------------------------+ -| :ref:`int` | :ref:`frames` | -+---------------------------+---------------------------------------------+ ++---------------------------+------------------------------------------------------+ +| :ref:`float` | :ref:`fps` | ++---------------------------+------------------------------------------------------+ +| :ref:`int` | :ref:`frames` | ++---------------------------+------------------------------------------------------+ Methods ------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_frame_delay` **(** :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 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame_texture` **(** :ref:`int` frame, :ref:`Texture` texture **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_frame_delay` **(** :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 **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame_texture` **(** :ref:`int` frame, :ref:`Texture` texture **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_AnimatedTexture_fps: +.. _class_AnimatedTexture_property_fps: - :ref:`float` **fps** @@ -51,7 +51,7 @@ Property Descriptions | *Getter* | get_fps() | +----------+----------------+ -.. _class_AnimatedTexture_frames: +.. _class_AnimatedTexture_property_frames: - :ref:`int` **frames** @@ -64,19 +64,19 @@ Property Descriptions Method Descriptions ------------------- -.. _class_AnimatedTexture_get_frame_delay: +.. _class_AnimatedTexture_method_get_frame_delay: - :ref:`float` **get_frame_delay** **(** :ref:`int` frame **)** const -.. _class_AnimatedTexture_get_frame_texture: +.. _class_AnimatedTexture_method_get_frame_texture: - :ref:`Texture` **get_frame_texture** **(** :ref:`int` frame **)** const -.. _class_AnimatedTexture_set_frame_delay: +.. _class_AnimatedTexture_method_set_frame_delay: - void **set_frame_delay** **(** :ref:`int` frame, :ref:`float` delay **)** -.. _class_AnimatedTexture_set_frame_texture: +.. _class_AnimatedTexture_method_set_frame_texture: - void **set_frame_texture** **(** :ref:`int` frame, :ref:`Texture` texture **)** diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 48cd2b915..cc87e1fde 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -19,136 +19,148 @@ Contains data used to animate everything in the engine. Properties ---------- -+---------------------------+---------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+---------------------------------------+ -| :ref:`bool` | :ref:`loop` | -+---------------------------+---------------------------------------+ -| :ref:`float` | :ref:`step` | -+---------------------------+---------------------------------------+ ++---------------------------+------------------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+------------------------------------------------+ +| :ref:`bool` | :ref:`loop` | ++---------------------------+------------------------------------------------+ +| :ref:`float` | :ref:`step` | ++---------------------------+------------------------------------------------+ Methods ------- -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_track` **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_track_get_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`animation_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_track_set_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio_track_get_key_end_offset` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio_track_get_key_start_offset` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`audio_track_get_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`audio_track_set_key_end_offset` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`audio_track_set_key_start_offset` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`audio_track_set_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`bezier_track_get_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`bezier_track_get_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bezier_track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bezier_track_insert_key` **(** :ref:`int` track, :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, :ref:`float` time **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bezier_track_set_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bezier_track_set_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bezier_track_set_key_value` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` value **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_track` **(** :ref:`int` track, :ref:`Animation` to_animation **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_track_count` **(** **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_track` **(** :ref:`int` idx **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InterpolationType` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackType` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_is_enabled` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key_at_position` **(** :ref:`int` idx, :ref:`float` position **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_enabled` **(** :ref:`int` idx, :ref:`bool` enabled **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_swap` **(** :ref:`int` idx, :ref:`int` with_idx **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** | -+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_track` **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`animation_track_get_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`animation_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_track_set_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio_track_get_key_end_offset` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio_track_get_key_start_offset` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`audio_track_get_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`audio_track_set_key_end_offset` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`audio_track_set_key_start_offset` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`audio_track_set_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`bezier_track_get_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`bezier_track_get_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bezier_track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bezier_track_insert_key` **(** :ref:`int` track, :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, :ref:`float` time **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bezier_track_set_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bezier_track_set_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bezier_track_set_key_value` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` value **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_track` **(** :ref:`int` track, :ref:`Animation` to_animation **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_track_count` **(** **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_track` **(** :ref:`int` idx **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InterpolationType` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TrackType` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_is_enabled` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key_at_position` **(** :ref:`int` idx, :ref:`float` position **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_enabled` **(** :ref:`int` idx, :ref:`bool` enabled **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_swap` **(** :ref:`int` idx, :ref:`int` with_idx **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Animation_TrackType: +.. _class_Animation_constant_TYPE_VALUE: + +.. _class_Animation_constant_TYPE_TRANSFORM: + +.. _class_Animation_constant_TYPE_METHOD: + +.. _class_Animation_constant_TYPE_BEZIER: + +.. _class_Animation_constant_TYPE_AUDIO: + +.. _class_Animation_constant_TYPE_ANIMATION: + enum **TrackType**: - **TYPE_VALUE** = **0** --- Value tracks set values in node properties, but only those which can be Interpolated. @@ -165,6 +177,12 @@ enum **TrackType**: .. _enum_Animation_InterpolationType: +.. _class_Animation_constant_INTERPOLATION_NEAREST: + +.. _class_Animation_constant_INTERPOLATION_LINEAR: + +.. _class_Animation_constant_INTERPOLATION_CUBIC: + enum **InterpolationType**: - **INTERPOLATION_NEAREST** = **0** --- No interpolation (nearest value). @@ -175,6 +193,14 @@ enum **InterpolationType**: .. _enum_Animation_UpdateMode: +.. _class_Animation_constant_UPDATE_CONTINUOUS: + +.. _class_Animation_constant_UPDATE_DISCRETE: + +.. _class_Animation_constant_UPDATE_TRIGGER: + +.. _class_Animation_constant_UPDATE_CAPTURE: + enum **UpdateMode**: - **UPDATE_CONTINUOUS** = **0** --- Update between keyframes. @@ -210,7 +236,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Animation_length: +.. _class_Animation_property_length: - :ref:`float` **length** @@ -222,7 +248,7 @@ Property Descriptions The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. -.. _class_Animation_loop: +.. _class_Animation_property_loop: - :ref:`bool` **loop** @@ -234,7 +260,7 @@ The total length of the animation (in seconds). Note that length is not delimite A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. -.. _class_Animation_step: +.. _class_Animation_property_step: - :ref:`float` **step** @@ -249,265 +275,265 @@ The animation step value. Method Descriptions ------------------- -.. _class_Animation_add_track: +.. _class_Animation_method_add_track: - :ref:`int` **add_track** **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration. -.. _class_Animation_animation_track_get_key_animation: +.. _class_Animation_method_animation_track_get_key_animation: - :ref:`String` **animation_track_get_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -.. _class_Animation_animation_track_insert_key: +.. _class_Animation_method_animation_track_insert_key: - :ref:`int` **animation_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** -.. _class_Animation_animation_track_set_key_animation: +.. _class_Animation_method_animation_track_set_key_animation: - void **animation_track_set_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** -.. _class_Animation_audio_track_get_key_end_offset: +.. _class_Animation_method_audio_track_get_key_end_offset: - :ref:`float` **audio_track_get_key_end_offset** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -.. _class_Animation_audio_track_get_key_start_offset: +.. _class_Animation_method_audio_track_get_key_start_offset: - :ref:`float` **audio_track_get_key_start_offset** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -.. _class_Animation_audio_track_get_key_stream: +.. _class_Animation_method_audio_track_get_key_stream: - :ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -.. _class_Animation_audio_track_insert_key: +.. _class_Animation_method_audio_track_insert_key: - :ref:`int` **audio_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** -.. _class_Animation_audio_track_set_key_end_offset: +.. _class_Animation_method_audio_track_set_key_end_offset: - void **audio_track_set_key_end_offset** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** -.. _class_Animation_audio_track_set_key_start_offset: +.. _class_Animation_method_audio_track_set_key_start_offset: - void **audio_track_set_key_start_offset** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** -.. _class_Animation_audio_track_set_key_stream: +.. _class_Animation_method_audio_track_set_key_stream: - void **audio_track_set_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** -.. _class_Animation_bezier_track_get_key_in_handle: +.. _class_Animation_method_bezier_track_get_key_in_handle: - :ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -.. _class_Animation_bezier_track_get_key_out_handle: +.. _class_Animation_method_bezier_track_get_key_out_handle: - :ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -.. _class_Animation_bezier_track_get_key_value: +.. _class_Animation_method_bezier_track_get_key_value: - :ref:`float` **bezier_track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const -.. _class_Animation_bezier_track_insert_key: +.. _class_Animation_method_bezier_track_insert_key: - :ref:`int` **bezier_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** -.. _class_Animation_bezier_track_interpolate: +.. _class_Animation_method_bezier_track_interpolate: - :ref:`float` **bezier_track_interpolate** **(** :ref:`int` track, :ref:`float` time **)** const -.. _class_Animation_bezier_track_set_key_in_handle: +.. _class_Animation_method_bezier_track_set_key_in_handle: - void **bezier_track_set_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** -.. _class_Animation_bezier_track_set_key_out_handle: +.. _class_Animation_method_bezier_track_set_key_out_handle: - void **bezier_track_set_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** -.. _class_Animation_bezier_track_set_key_value: +.. _class_Animation_method_bezier_track_set_key_value: - void **bezier_track_set_key_value** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` value **)** -.. _class_Animation_clear: +.. _class_Animation_method_clear: - void **clear** **(** **)** Clear the animation (clear all tracks and reset all). -.. _class_Animation_copy_track: +.. _class_Animation_method_copy_track: - void **copy_track** **(** :ref:`int` track, :ref:`Animation` to_animation **)** Adds a new track that is a copy of the given track from ``to_animation``. -.. _class_Animation_find_track: +.. _class_Animation_method_find_track: - :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const Return the index of the specified track. If the track is not found, return -1. -.. _class_Animation_get_track_count: +.. _class_Animation_method_get_track_count: - :ref:`int` **get_track_count** **(** **)** const Return the amount of tracks in the animation. -.. _class_Animation_method_track_get_key_indices: +.. _class_Animation_method_method_track_get_key_indices: - :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const Return all the key indices of a method track, given a position and delta time. -.. _class_Animation_method_track_get_name: +.. _class_Animation_method_method_track_get_name: - :ref:`String` **method_track_get_name** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the method name of a method track. -.. _class_Animation_method_track_get_params: +.. _class_Animation_method_method_track_get_params: - :ref:`Array` **method_track_get_params** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the arguments values to be called on a method track for a given key in a given track. -.. _class_Animation_remove_track: +.. _class_Animation_method_remove_track: - void **remove_track** **(** :ref:`int` idx **)** Remove a track by specifying the track index. -.. _class_Animation_track_find_key: +.. _class_Animation_method_track_find_key: - :ref:`int` **track_find_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const Find the key index by time in a given track. Optionally, only find it if the exact time is given. -.. _class_Animation_track_get_interpolation_loop_wrap: +.. _class_Animation_method_track_get_interpolation_loop_wrap: - :ref:`bool` **track_get_interpolation_loop_wrap** **(** :ref:`int` idx **)** const Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default value: ``true``. -.. _class_Animation_track_get_interpolation_type: +.. _class_Animation_method_track_get_interpolation_type: - :ref:`InterpolationType` **track_get_interpolation_type** **(** :ref:`int` idx **)** const Return the interpolation type of a given track, from the INTERPOLATION\_\* enum. -.. _class_Animation_track_get_key_count: +.. _class_Animation_method_track_get_key_count: - :ref:`int` **track_get_key_count** **(** :ref:`int` idx **)** const Return the amount of keys in a given track. -.. _class_Animation_track_get_key_time: +.. _class_Animation_method_track_get_key_time: - :ref:`float` **track_get_key_time** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the time at which the key is located. -.. _class_Animation_track_get_key_transition: +.. _class_Animation_method_track_get_key_transition: - :ref:`float` **track_get_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the transition curve (easing) for a specific key (see built-in math function "ease"). -.. _class_Animation_track_get_key_value: +.. _class_Animation_method_track_get_key_value: - :ref:`Variant` **track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the value of a given key in a given track. -.. _class_Animation_track_get_path: +.. _class_Animation_method_track_get_path: - :ref:`NodePath` **track_get_path** **(** :ref:`int` idx **)** const -Get the path of a track. for more information on the path format, see :ref:`track_set_path` +Get the path of a track. for more information on the path format, see :ref:`track_set_path` -.. _class_Animation_track_get_type: +.. _class_Animation_method_track_get_type: - :ref:`TrackType` **track_get_type** **(** :ref:`int` idx **)** const Get the type of a track. -.. _class_Animation_track_insert_key: +.. _class_Animation_method_track_insert_key: - void **track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** Insert a generic key in a given track. -.. _class_Animation_track_is_enabled: +.. _class_Animation_method_track_is_enabled: - :ref:`bool` **track_is_enabled** **(** :ref:`int` idx **)** const Returns ``true`` if the track at index ``idx`` is enabled. -.. _class_Animation_track_is_imported: +.. _class_Animation_method_track_is_imported: - :ref:`bool` **track_is_imported** **(** :ref:`int` idx **)** const Return true if the given track is imported. Else, return false. -.. _class_Animation_track_move_down: +.. _class_Animation_method_track_move_down: - void **track_move_down** **(** :ref:`int` idx **)** Move a track down. -.. _class_Animation_track_move_up: +.. _class_Animation_method_track_move_up: - void **track_move_up** **(** :ref:`int` idx **)** Move a track up. -.. _class_Animation_track_remove_key: +.. _class_Animation_method_track_remove_key: - void **track_remove_key** **(** :ref:`int` idx, :ref:`int` key_idx **)** Remove a key by index in a given track. -.. _class_Animation_track_remove_key_at_position: +.. _class_Animation_method_track_remove_key_at_position: - void **track_remove_key_at_position** **(** :ref:`int` idx, :ref:`float` position **)** Remove a key by position (seconds) in a given track. -.. _class_Animation_track_set_enabled: +.. _class_Animation_method_track_set_enabled: - void **track_set_enabled** **(** :ref:`int` idx, :ref:`bool` enabled **)** Enables/disables the given track. Tracks are enabled by default. -.. _class_Animation_track_set_imported: +.. _class_Animation_method_track_set_imported: - void **track_set_imported** **(** :ref:`int` idx, :ref:`bool` imported **)** Set the given track as imported or not. -.. _class_Animation_track_set_interpolation_loop_wrap: +.. _class_Animation_method_track_set_interpolation_loop_wrap: - void **track_set_interpolation_loop_wrap** **(** :ref:`int` idx, :ref:`bool` interpolation **)** If ``true``, the track at ``idx`` wraps the interpolation loop. -.. _class_Animation_track_set_interpolation_type: +.. _class_Animation_method_track_set_interpolation_type: - void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** Set the interpolation type of a given track, from the INTERPOLATION\_\* enum. -.. _class_Animation_track_set_key_transition: +.. _class_Animation_method_track_set_key_transition: - void **track_set_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** Set the transition curve (easing) for a specific key (see built-in math function "ease"). -.. _class_Animation_track_set_key_value: +.. _class_Animation_method_track_set_key_value: - void **track_set_key_value** **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** Set the value of an existing key. -.. _class_Animation_track_set_path: +.. _class_Animation_method_track_set_path: - void **track_set_path** **(** :ref:`int` idx, :ref:`NodePath` path **)** @@ -515,35 +541,35 @@ Set the path of a track. Paths must be valid scene-tree paths to a node, and mus **Example:** "character/skeleton:ankle" or "character/mesh:transform/local". -.. _class_Animation_track_swap: +.. _class_Animation_method_track_swap: - void **track_swap** **(** :ref:`int` idx, :ref:`int` with_idx **)** -.. _class_Animation_transform_track_insert_key: +.. _class_Animation_method_transform_track_insert_key: - :ref:`int` **transform_track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** Insert a transform key for a transform track. -.. _class_Animation_transform_track_interpolate: +.. _class_Animation_method_transform_track_interpolate: - :ref:`Array` **transform_track_interpolate** **(** :ref:`int` idx, :ref:`float` time_sec **)** const Return 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`). -.. _class_Animation_value_track_get_key_indices: +.. _class_Animation_method_value_track_get_key_indices: - :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const Return all the key indices of a value track, given a position and delta time. -.. _class_Animation_value_track_get_update_mode: +.. _class_Animation_method_value_track_get_update_mode: - :ref:`UpdateMode` **value_track_get_update_mode** **(** :ref:`int` idx **)** const Return the update mode of a value track. -.. _class_Animation_value_track_set_update_mode: +.. _class_Animation_method_value_track_set_update_mode: - void **value_track_set_update_mode** **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index e858ee177..1d93d7a35 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -21,61 +21,61 @@ Base resource for :ref:`AnimationTree` nodes. Properties ---------- -+-------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`filter_enabled` | -+-------------------------+-----------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`filter_enabled` | ++-------------------------+--------------------------------------------------------------------+ Methods ------- -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_input` **(** :ref:`String` name **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_animation` **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`Object` | :ref:`get_child_by_name` **(** :ref:`String` name **)** virtual | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_child_nodes` **(** **)** virtual | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_default_value` **(** :ref:`String` name **)** virtual | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_parameter_list` **(** **)** virtual | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`has_filter` **(** **)** virtual | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** virtual | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_input` **(** :ref:`int` index **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_parameter` **(** :ref:`String` name, :ref:`Variant` value **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_input` **(** :ref:`String` name **)** | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_animation` **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`Object` | :ref:`get_child_by_name` **(** :ref:`String` name **)** virtual | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_child_nodes` **(** **)** virtual | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_default_value` **(** :ref:`String` name **)** virtual | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_parameter_list` **(** **)** virtual | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`has_filter` **(** **)** virtual | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** virtual | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_input` **(** :ref:`int` index **)** | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_parameter` **(** :ref:`String` name, :ref:`Variant` value **)** | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AnimationNode_removed_from_graph: +.. _class_AnimationNode_signal_removed_from_graph: - **removed_from_graph** **(** **)** Called when the node was removed from the graph. -.. _class_AnimationNode_tree_changed: +.. _class_AnimationNode_signal_tree_changed: - **tree_changed** **(** **)** @@ -84,6 +84,14 @@ Enumerations .. _enum_AnimationNode_FilterAction: +.. _class_AnimationNode_constant_FILTER_IGNORE: + +.. _class_AnimationNode_constant_FILTER_PASS: + +.. _class_AnimationNode_constant_FILTER_STOP: + +.. _class_AnimationNode_constant_FILTER_BLEND: + enum **FilterAction**: - **FILTER_IGNORE** = **0** --- Do not use filtering. @@ -104,7 +112,7 @@ Inherit this when creating nodes mainly for use in :ref:`AnimationNodeBlendTree< Property Descriptions --------------------- -.. _class_AnimationNode_filter_enabled: +.. _class_AnimationNode_property_filter_enabled: - :ref:`bool` **filter_enabled** @@ -119,115 +127,115 @@ Return whether filtering is enabled. Method Descriptions ------------------- -.. _class_AnimationNode_add_input: +.. _class_AnimationNode_method_add_input: - void **add_input** **(** :ref:`String` name **)** Add an input to the node. This is only useful for nodes created for use in an :ref:`AnimationNodeBlendTree` -.. _class_AnimationNode_blend_animation: +.. _class_AnimationNode_method_blend_animation: - void **blend_animation** **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** Blend an animation by "blend" amount (name must be valid in the linked :ref:`AnimationPlayer`). A time and delta mas be passed, as well as whether seek happened. -.. _class_AnimationNode_blend_input: +.. _class_AnimationNode_method_blend_input: - :ref:`float` **blend_input** **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** Blend an input. This is only useful for nodes created for an :ref:`AnimationNodeBlendTree`. Time is a delta, unless "seek" is true, in which case it is absolute. A filter mode may be optionally passed. -.. _class_AnimationNode_blend_node: +.. _class_AnimationNode_method_blend_node: - :ref:`float` **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 **)** Blend another animaiton node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode` instead, else editors will not display your node for addition. -.. _class_AnimationNode_get_caption: +.. _class_AnimationNode_method_get_caption: - :ref:`String` **get_caption** **(** **)** virtual Get the text caption for this node (used by some editors) -.. _class_AnimationNode_get_child_by_name: +.. _class_AnimationNode_method_get_child_by_name: - :ref:`Object` **get_child_by_name** **(** :ref:`String` name **)** virtual Get the a child node by index (used by editors inheriting from :ref:`AnimationRootNode`). -.. _class_AnimationNode_get_child_nodes: +.. _class_AnimationNode_method_get_child_nodes: - :ref:`Dictionary` **get_child_nodes** **(** **)** virtual Get all children nodes, in order as a name:node dictionary. Only useful when inheriting :ref:`AnimationRootNode`. -.. _class_AnimationNode_get_input_count: +.. _class_AnimationNode_method_get_input_count: - :ref:`int` **get_input_count** **(** **)** const Amount of inputs in this node, only useful for nodes that go into :ref:`AnimationNodeBlendTree`. -.. _class_AnimationNode_get_input_name: +.. _class_AnimationNode_method_get_input_name: - :ref:`String` **get_input_name** **(** :ref:`int` input **)** Get the name of an input by index. -.. _class_AnimationNode_get_parameter: +.. _class_AnimationNode_method_get_parameter: - :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** const Get the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. -.. _class_AnimationNode_get_parameter_default_value: +.. _class_AnimationNode_method_get_parameter_default_value: - :ref:`Variant` **get_parameter_default_value** **(** :ref:`String` name **)** virtual Get the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. -.. _class_AnimationNode_get_parameter_list: +.. _class_AnimationNode_method_get_parameter_list: - :ref:`Array` **get_parameter_list** **(** **)** virtual -Get 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`. +Get 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`. -.. _class_AnimationNode_has_filter: +.. _class_AnimationNode_method_has_filter: - :ref:`String` **has_filter** **(** **)** virtual Return true whether you want the blend tree editor to display filter editing on this node. -.. _class_AnimationNode_is_path_filtered: +.. _class_AnimationNode_method_is_path_filtered: - :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const Return true wether a given path is filtered. -.. _class_AnimationNode_process: +.. _class_AnimationNode_method_process: - void **process** **(** :ref:`float` time, :ref:`bool` seek **)** virtual Called when a custom node is processed. The argument "time" is relative, unless "seek" is true (in which case it is absolute). -Here, call the :ref:`blend_input`, :ref:`blend_node` or :ref:`blend_animation` functions. +Here, call the :ref:`blend_input`, :ref:`blend_node` or :ref:`blend_animation` functions. -You can also use :ref:`get_parameter` and :ref:`set_parameter` to modify local memory. +You can also use :ref:`get_parameter` and :ref:`set_parameter` to modify local memory. This function returns the time left for the current animation to finish (if unsure, just pass the value from the main blend being called). -.. _class_AnimationNode_remove_input: +.. _class_AnimationNode_method_remove_input: - void **remove_input** **(** :ref:`int` index **)** Remove an input, call this only when inactive. -.. _class_AnimationNode_set_filter_path: +.. _class_AnimationNode_method_set_filter_path: - void **set_filter_path** **(** :ref:`NodePath` path, :ref:`bool` enable **)** Add/Remove a path for the filter. -.. _class_AnimationNode_set_parameter: +.. _class_AnimationNode_method_set_parameter: - void **set_parameter** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index b3dc21691..64489ab52 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-------------------------+-------------------------------------------+ -| :ref:`bool` | :ref:`sync` | -+-------------------------+-------------------------------------------+ ++-------------------------+----------------------------------------------------+ +| :ref:`bool` | :ref:`sync` | ++-------------------------+----------------------------------------------------+ Property Descriptions --------------------- -.. _class_AnimationNodeAdd2_sync: +.. _class_AnimationNodeAdd2_property_sync: - :ref:`bool` **sync** diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index eaab61192..efc729555 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-------------------------+-------------------------------------------+ -| :ref:`bool` | :ref:`sync` | -+-------------------------+-------------------------------------------+ ++-------------------------+----------------------------------------------------+ +| :ref:`bool` | :ref:`sync` | ++-------------------------+----------------------------------------------------+ Property Descriptions --------------------- -.. _class_AnimationNodeAdd3_sync: +.. _class_AnimationNodeAdd3_property_sync: - :ref:`bool` **sync** diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index 63ee6525d..a35b2176d 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-----------------------------+----------------------------------------------------------+ -| :ref:`String` | :ref:`animation` | -+-----------------------------+----------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------+ +| :ref:`String` | :ref:`animation` | ++-----------------------------+-------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_AnimationNodeAnimation_animation: +.. _class_AnimationNodeAnimation_property_animation: - :ref:`String` **animation** diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index dfe6f90ec..d0d351271 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-------------------------+---------------------------------------------+ -| :ref:`bool` | :ref:`sync` | -+-------------------------+---------------------------------------------+ ++-------------------------+------------------------------------------------------+ +| :ref:`bool` | :ref:`sync` | ++-------------------------+------------------------------------------------------+ Property Descriptions --------------------- -.. _class_AnimationNodeBlend2_sync: +.. _class_AnimationNodeBlend2_property_sync: - :ref:`bool` **sync** diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 46be973d5..75729ff0c 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-------------------------+---------------------------------------------+ -| :ref:`bool` | :ref:`sync` | -+-------------------------+---------------------------------------------+ ++-------------------------+------------------------------------------------------+ +| :ref:`bool` | :ref:`sync` | ++-------------------------+------------------------------------------------------+ Property Descriptions --------------------- -.. _class_AnimationNodeBlend3_sync: +.. _class_AnimationNodeBlend3_property_sync: - :ref:`bool` **sync** diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index a50ad2620..8f26b9ba2 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -19,39 +19,39 @@ Brief Description Properties ---------- -+-----------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`max_space` | -+-----------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`min_space` | -+-----------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`snap` | -+-----------------------------+-----------------------------------------------------------------+ -| :ref:`String` | :ref:`value_label` | -+-----------------------------+-----------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max_space` | ++-----------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`min_space` | ++-----------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`snap` | ++-----------------------------+--------------------------------------------------------------------------+ +| :ref:`String` | :ref:`value_label` | ++-----------------------------+--------------------------------------------------------------------------+ 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:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | -+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** const | -+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | -+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | -+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`float` pos **)** | -+----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`float` pos **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_AnimationNodeBlendSpace1D_max_space: +.. _class_AnimationNodeBlendSpace1D_property_max_space: - :ref:`float` **max_space** @@ -61,7 +61,7 @@ Property Descriptions | *Getter* | get_max_space() | +----------+----------------------+ -.. _class_AnimationNodeBlendSpace1D_min_space: +.. _class_AnimationNodeBlendSpace1D_property_min_space: - :ref:`float` **min_space** @@ -71,7 +71,7 @@ Property Descriptions | *Getter* | get_min_space() | +----------+----------------------+ -.. _class_AnimationNodeBlendSpace1D_snap: +.. _class_AnimationNodeBlendSpace1D_property_snap: - :ref:`float` **snap** @@ -81,7 +81,7 @@ Property Descriptions | *Getter* | get_snap() | +----------+-----------------+ -.. _class_AnimationNodeBlendSpace1D_value_label: +.. _class_AnimationNodeBlendSpace1D_property_value_label: - :ref:`String` **value_label** @@ -94,31 +94,31 @@ Property Descriptions Method Descriptions ------------------- -.. _class_AnimationNodeBlendSpace1D_add_blend_point: +.. _class_AnimationNodeBlendSpace1D_method_add_blend_point: - void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** -.. _class_AnimationNodeBlendSpace1D_get_blend_point_count: +.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count: - :ref:`int` **get_blend_point_count** **(** **)** const -.. _class_AnimationNodeBlendSpace1D_get_blend_point_node: +.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node: - :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const -.. _class_AnimationNodeBlendSpace1D_get_blend_point_position: +.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position: - :ref:`float` **get_blend_point_position** **(** :ref:`int` point **)** const -.. _class_AnimationNodeBlendSpace1D_remove_blend_point: +.. _class_AnimationNodeBlendSpace1D_method_remove_blend_point: - void **remove_blend_point** **(** :ref:`int` point **)** -.. _class_AnimationNodeBlendSpace1D_set_blend_point_node: +.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_node: - void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** -.. _class_AnimationNodeBlendSpace1D_set_blend_point_position: +.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_position: - void **set_blend_point_position** **(** :ref:`int` point, :ref:`float` pos **)** diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 00fd4f10d..d0ea0cc46 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -19,54 +19,60 @@ Brief Description Properties ---------- -+------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_triangles` | -+------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`BlendMode` | :ref:`blend_mode` | -+------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`max_space` | -+------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`min_space` | -+------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`snap` | -+------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`String` | :ref:`x_label` | -+------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`String` | :ref:`y_label` | -+------------------------------------------------------------+-----------------------------------------------------------------------+ ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`auto_triangles` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`BlendMode` | :ref:`blend_mode` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`max_space` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`min_space` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`snap` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`x_label` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`y_label` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ Methods ------- -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :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_point` **(** :ref:`int` triangle, :ref:`int` point **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_triangle` **(** :ref:`int` triangle **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`Vector2` pos **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :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_point` **(** :ref:`int` triangle, :ref:`int` point **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_triangle` **(** :ref:`int` triangle **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`Vector2` pos **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_AnimationNodeBlendSpace2D_BlendMode: +.. _class_AnimationNodeBlendSpace2D_constant_BLEND_MODE_INTERPOLATED: + +.. _class_AnimationNodeBlendSpace2D_constant_BLEND_MODE_DISCRETE: + +.. _class_AnimationNodeBlendSpace2D_constant_BLEND_MODE_DISCRETE_CARRY: + enum **BlendMode**: - **BLEND_MODE_INTERPOLATED** = **0** @@ -78,7 +84,7 @@ enum **BlendMode**: Property Descriptions --------------------- -.. _class_AnimationNodeBlendSpace2D_auto_triangles: +.. _class_AnimationNodeBlendSpace2D_property_auto_triangles: - :ref:`bool` **auto_triangles** @@ -88,7 +94,7 @@ Property Descriptions | *Getter* | get_auto_triangles() | +----------+---------------------------+ -.. _class_AnimationNodeBlendSpace2D_blend_mode: +.. _class_AnimationNodeBlendSpace2D_property_blend_mode: - :ref:`BlendMode` **blend_mode** @@ -98,7 +104,7 @@ Property Descriptions | *Getter* | get_blend_mode() | +----------+-----------------------+ -.. _class_AnimationNodeBlendSpace2D_max_space: +.. _class_AnimationNodeBlendSpace2D_property_max_space: - :ref:`Vector2` **max_space** @@ -108,7 +114,7 @@ Property Descriptions | *Getter* | get_max_space() | +----------+----------------------+ -.. _class_AnimationNodeBlendSpace2D_min_space: +.. _class_AnimationNodeBlendSpace2D_property_min_space: - :ref:`Vector2` **min_space** @@ -118,7 +124,7 @@ Property Descriptions | *Getter* | get_min_space() | +----------+----------------------+ -.. _class_AnimationNodeBlendSpace2D_snap: +.. _class_AnimationNodeBlendSpace2D_property_snap: - :ref:`Vector2` **snap** @@ -128,7 +134,7 @@ Property Descriptions | *Getter* | get_snap() | +----------+-----------------+ -.. _class_AnimationNodeBlendSpace2D_x_label: +.. _class_AnimationNodeBlendSpace2D_property_x_label: - :ref:`String` **x_label** @@ -138,7 +144,7 @@ Property Descriptions | *Getter* | get_x_label() | +----------+--------------------+ -.. _class_AnimationNodeBlendSpace2D_y_label: +.. _class_AnimationNodeBlendSpace2D_property_y_label: - :ref:`String` **y_label** @@ -151,47 +157,47 @@ Property Descriptions Method Descriptions ------------------- -.. _class_AnimationNodeBlendSpace2D_add_blend_point: +.. _class_AnimationNodeBlendSpace2D_method_add_blend_point: - void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** -.. _class_AnimationNodeBlendSpace2D_add_triangle: +.. _class_AnimationNodeBlendSpace2D_method_add_triangle: - void **add_triangle** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` at_index=-1 **)** -.. _class_AnimationNodeBlendSpace2D_get_blend_point_count: +.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_count: - :ref:`int` **get_blend_point_count** **(** **)** const -.. _class_AnimationNodeBlendSpace2D_get_blend_point_node: +.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_node: - :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const -.. _class_AnimationNodeBlendSpace2D_get_blend_point_position: +.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_position: - :ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** const -.. _class_AnimationNodeBlendSpace2D_get_triangle_count: +.. _class_AnimationNodeBlendSpace2D_method_get_triangle_count: - :ref:`int` **get_triangle_count** **(** **)** const -.. _class_AnimationNodeBlendSpace2D_get_triangle_point: +.. _class_AnimationNodeBlendSpace2D_method_get_triangle_point: - :ref:`int` **get_triangle_point** **(** :ref:`int` triangle, :ref:`int` point **)** -.. _class_AnimationNodeBlendSpace2D_remove_blend_point: +.. _class_AnimationNodeBlendSpace2D_method_remove_blend_point: - void **remove_blend_point** **(** :ref:`int` point **)** -.. _class_AnimationNodeBlendSpace2D_remove_triangle: +.. _class_AnimationNodeBlendSpace2D_method_remove_triangle: - void **remove_triangle** **(** :ref:`int` triangle **)** -.. _class_AnimationNodeBlendSpace2D_set_blend_point_node: +.. _class_AnimationNodeBlendSpace2D_method_set_blend_point_node: - void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** -.. _class_AnimationNodeBlendSpace2D_set_blend_point_position: +.. _class_AnimationNodeBlendSpace2D_method_set_blend_point_position: - void **set_blend_point_position** **(** :ref:`int` point, :ref:`Vector2` pos **)** diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 5097959c1..b26300cac 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -19,36 +19,48 @@ Brief Description Properties ---------- -+-------------------------------+----------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`graph_offset` | -+-------------------------------+----------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`graph_offset` | ++-------------------------------+-------------------------------------------------------------------------+ Methods ------- -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_node` **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_node` **(** :ref:`String` input_node, :ref:`int` input_index **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` name **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_node` **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_node` **(** :ref:`String` input_node, :ref:`int` input_index **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` name **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_AnimationNodeBlendTree_constant_CONNECTION_OK: + +.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_NO_INPUT: + +.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_NO_INPUT_INDEX: + +.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_NO_OUTPUT: + +.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_SAME_NODE: + +.. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_CONNECTION_EXISTS: + - **CONNECTION_OK** = **0** - **CONNECTION_ERROR_NO_INPUT** = **1** @@ -64,7 +76,7 @@ Constants Property Descriptions --------------------- -.. _class_AnimationNodeBlendTree_graph_offset: +.. _class_AnimationNodeBlendTree_property_graph_offset: - :ref:`Vector2` **graph_offset** @@ -77,39 +89,39 @@ Property Descriptions Method Descriptions ------------------- -.. _class_AnimationNodeBlendTree_add_node: +.. _class_AnimationNodeBlendTree_method_add_node: - void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** -.. _class_AnimationNodeBlendTree_connect_node: +.. _class_AnimationNodeBlendTree_method_connect_node: - void **connect_node** **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** -.. _class_AnimationNodeBlendTree_disconnect_node: +.. _class_AnimationNodeBlendTree_method_disconnect_node: - void **disconnect_node** **(** :ref:`String` input_node, :ref:`int` input_index **)** -.. _class_AnimationNodeBlendTree_get_node: +.. _class_AnimationNodeBlendTree_method_get_node: - :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const -.. _class_AnimationNodeBlendTree_get_node_position: +.. _class_AnimationNodeBlendTree_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const -.. _class_AnimationNodeBlendTree_has_node: +.. _class_AnimationNodeBlendTree_method_has_node: - :ref:`bool` **has_node** **(** :ref:`String` name **)** const -.. _class_AnimationNodeBlendTree_remove_node: +.. _class_AnimationNodeBlendTree_method_remove_node: - void **remove_node** **(** :ref:`String` name **)** -.. _class_AnimationNodeBlendTree_rename_node: +.. _class_AnimationNodeBlendTree_method_rename_node: - void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** -.. _class_AnimationNodeBlendTree_set_node_position: +.. _class_AnimationNodeBlendTree_method_set_node_position: - void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index b4d9c4f85..ee47d786f 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -19,34 +19,38 @@ Brief Description Properties ---------- -+---------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`autorestart` | -+---------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`autorestart_delay` | -+---------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`autorestart_random_delay` | -+---------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fadein_time` | -+---------------------------+--------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fadeout_time` | -+---------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sync` | -+---------------------------+--------------------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`autorestart` | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`autorestart_delay` | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`autorestart_random_delay` | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fadein_time` | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fadeout_time` | ++---------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`sync` | ++---------------------------+-----------------------------------------------------------------------------------------------+ Methods ------- -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MixMode` | :ref:`get_mix_mode` **(** **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_mode` **(** :ref:`MixMode` mode **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MixMode` | :ref:`get_mix_mode` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix_mode` **(** :ref:`MixMode` mode **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_AnimationNodeOneShot_MixMode: +.. _class_AnimationNodeOneShot_constant_MIX_MODE_BLEND: + +.. _class_AnimationNodeOneShot_constant_MIX_MODE_ADD: + enum **MixMode**: - **MIX_MODE_BLEND** = **0** @@ -56,7 +60,7 @@ enum **MixMode**: Property Descriptions --------------------- -.. _class_AnimationNodeOneShot_autorestart: +.. _class_AnimationNodeOneShot_property_autorestart: - :ref:`bool` **autorestart** @@ -66,7 +70,7 @@ Property Descriptions | *Getter* | has_autorestart() | +----------+------------------------+ -.. _class_AnimationNodeOneShot_autorestart_delay: +.. _class_AnimationNodeOneShot_property_autorestart_delay: - :ref:`float` **autorestart_delay** @@ -76,7 +80,7 @@ Property Descriptions | *Getter* | get_autorestart_delay() | +----------+------------------------------+ -.. _class_AnimationNodeOneShot_autorestart_random_delay: +.. _class_AnimationNodeOneShot_property_autorestart_random_delay: - :ref:`float` **autorestart_random_delay** @@ -86,7 +90,7 @@ Property Descriptions | *Getter* | get_autorestart_random_delay() | +----------+-------------------------------------+ -.. _class_AnimationNodeOneShot_fadein_time: +.. _class_AnimationNodeOneShot_property_fadein_time: - :ref:`float` **fadein_time** @@ -96,7 +100,7 @@ Property Descriptions | *Getter* | get_fadein_time() | +----------+------------------------+ -.. _class_AnimationNodeOneShot_fadeout_time: +.. _class_AnimationNodeOneShot_property_fadeout_time: - :ref:`float` **fadeout_time** @@ -106,7 +110,7 @@ Property Descriptions | *Getter* | get_fadeout_time() | +----------+-------------------------+ -.. _class_AnimationNodeOneShot_sync: +.. _class_AnimationNodeOneShot_property_sync: - :ref:`bool` **sync** @@ -119,11 +123,11 @@ Property Descriptions Method Descriptions ------------------- -.. _class_AnimationNodeOneShot_get_mix_mode: +.. _class_AnimationNodeOneShot_method_get_mix_mode: - :ref:`MixMode` **get_mix_mode** **(** **)** const -.. _class_AnimationNodeOneShot_set_mix_mode: +.. _class_AnimationNodeOneShot_method_set_mix_mode: - void **set_mix_mode** **(** :ref:`MixMode` mode **)** diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index 7e74b5099..46dde5a86 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -19,140 +19,140 @@ Brief Description Methods ------- -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_transition` **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_end_node` **(** **)** const | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** const | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** const | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_start_node` **(** **)** const | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** const | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_transition_count` **(** **)** const | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_transition_from` **(** :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_transition` **(** :ref:`String` from, :ref:`String` to **)** const | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` name **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_transition` **(** :ref:`String` from, :ref:`String` to **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_transition_by_index` **(** :ref:`int` idx **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end_node` **(** :ref:`String` name **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_graph_offset` **(** :ref:`Vector2` name **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_start_node` **(** :ref:`String` name **)** | -+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_transition` **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_end_node` **(** **)** const | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** const | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** const | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_start_node` **(** **)** const | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** const | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_transition_count` **(** **)** const | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_transition_from` **(** :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_transition` **(** :ref:`String` from, :ref:`String` to **)** const | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` name **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_transition` **(** :ref:`String` from, :ref:`String` to **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_transition_by_index` **(** :ref:`int` idx **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end_node` **(** :ref:`String` name **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_graph_offset` **(** :ref:`Vector2` name **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_start_node` **(** :ref:`String` name **)** | ++---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_AnimationNodeStateMachine_add_node: +.. _class_AnimationNodeStateMachine_method_add_node: - void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** -.. _class_AnimationNodeStateMachine_add_transition: +.. _class_AnimationNodeStateMachine_method_add_transition: - void **add_transition** **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** -.. _class_AnimationNodeStateMachine_get_end_node: +.. _class_AnimationNodeStateMachine_method_get_end_node: - :ref:`String` **get_end_node** **(** **)** const -.. _class_AnimationNodeStateMachine_get_graph_offset: +.. _class_AnimationNodeStateMachine_method_get_graph_offset: - :ref:`Vector2` **get_graph_offset** **(** **)** const -.. _class_AnimationNodeStateMachine_get_node: +.. _class_AnimationNodeStateMachine_method_get_node: - :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const -.. _class_AnimationNodeStateMachine_get_node_name: +.. _class_AnimationNodeStateMachine_method_get_node_name: - :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const -.. _class_AnimationNodeStateMachine_get_node_position: +.. _class_AnimationNodeStateMachine_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const -.. _class_AnimationNodeStateMachine_get_start_node: +.. _class_AnimationNodeStateMachine_method_get_start_node: - :ref:`String` **get_start_node** **(** **)** const -.. _class_AnimationNodeStateMachine_get_transition: +.. _class_AnimationNodeStateMachine_method_get_transition: - :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** const -.. _class_AnimationNodeStateMachine_get_transition_count: +.. _class_AnimationNodeStateMachine_method_get_transition_count: - :ref:`int` **get_transition_count** **(** **)** const -.. _class_AnimationNodeStateMachine_get_transition_from: +.. _class_AnimationNodeStateMachine_method_get_transition_from: - :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const -.. _class_AnimationNodeStateMachine_get_transition_to: +.. _class_AnimationNodeStateMachine_method_get_transition_to: - :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const -.. _class_AnimationNodeStateMachine_has_node: +.. _class_AnimationNodeStateMachine_method_has_node: - :ref:`bool` **has_node** **(** :ref:`String` name **)** const -.. _class_AnimationNodeStateMachine_has_transition: +.. _class_AnimationNodeStateMachine_method_has_transition: - :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const -.. _class_AnimationNodeStateMachine_remove_node: +.. _class_AnimationNodeStateMachine_method_remove_node: - void **remove_node** **(** :ref:`String` name **)** -.. _class_AnimationNodeStateMachine_remove_transition: +.. _class_AnimationNodeStateMachine_method_remove_transition: - void **remove_transition** **(** :ref:`String` from, :ref:`String` to **)** -.. _class_AnimationNodeStateMachine_remove_transition_by_index: +.. _class_AnimationNodeStateMachine_method_remove_transition_by_index: - void **remove_transition_by_index** **(** :ref:`int` idx **)** -.. _class_AnimationNodeStateMachine_rename_node: +.. _class_AnimationNodeStateMachine_method_rename_node: - void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** -.. _class_AnimationNodeStateMachine_set_end_node: +.. _class_AnimationNodeStateMachine_method_set_end_node: - void **set_end_node** **(** :ref:`String` name **)** -.. _class_AnimationNodeStateMachine_set_graph_offset: +.. _class_AnimationNodeStateMachine_method_set_graph_offset: - void **set_graph_offset** **(** :ref:`Vector2` name **)** -.. _class_AnimationNodeStateMachine_set_node_position: +.. _class_AnimationNodeStateMachine_method_set_node_position: - void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** -.. _class_AnimationNodeStateMachine_set_start_node: +.. _class_AnimationNodeStateMachine_method_set_start_node: - void **set_start_node** **(** :ref:`String` name **)** diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 95ac358b9..fbc61c644 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -19,44 +19,44 @@ Brief Description Methods ------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_node` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_travel_path` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start` **(** :ref:`String` node **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`travel` **(** :ref:`String` to_node **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_node` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_travel_path` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start` **(** :ref:`String` node **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`travel` **(** :ref:`String` to_node **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_AnimationNodeStateMachinePlayback_get_current_node: +.. _class_AnimationNodeStateMachinePlayback_method_get_current_node: - :ref:`String` **get_current_node** **(** **)** const -.. _class_AnimationNodeStateMachinePlayback_get_travel_path: +.. _class_AnimationNodeStateMachinePlayback_method_get_travel_path: - :ref:`PoolStringArray` **get_travel_path** **(** **)** const -.. _class_AnimationNodeStateMachinePlayback_is_playing: +.. _class_AnimationNodeStateMachinePlayback_method_is_playing: - :ref:`bool` **is_playing** **(** **)** const -.. _class_AnimationNodeStateMachinePlayback_start: +.. _class_AnimationNodeStateMachinePlayback_method_start: - void **start** **(** :ref:`String` node **)** -.. _class_AnimationNodeStateMachinePlayback_stop: +.. _class_AnimationNodeStateMachinePlayback_method_stop: - void **stop** **(** **)** -.. _class_AnimationNodeStateMachinePlayback_travel: +.. _class_AnimationNodeStateMachinePlayback_method_travel: - void **travel** **(** :ref:`String` to_node **)** diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index ed3ed992b..09363ec6c 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -19,24 +19,24 @@ Brief Description Properties ---------- -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`advance_condition` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_advance` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`priority` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`SwitchMode` | :ref:`switch_mode` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`xfade_time` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`advance_condition` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`auto_advance` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`priority` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`SwitchMode` | :ref:`switch_mode` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`xfade_time` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AnimationNodeStateMachineTransition_advance_condition_changed: +.. _class_AnimationNodeStateMachineTransition_signal_advance_condition_changed: - **advance_condition_changed** **(** **)** @@ -45,6 +45,12 @@ Enumerations .. _enum_AnimationNodeStateMachineTransition_SwitchMode: +.. _class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_IMMEDIATE: + +.. _class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_SYNC: + +.. _class_AnimationNodeStateMachineTransition_constant_SWITCH_MODE_AT_END: + enum **SwitchMode**: - **SWITCH_MODE_IMMEDIATE** = **0** @@ -56,7 +62,7 @@ enum **SwitchMode**: Property Descriptions --------------------- -.. _class_AnimationNodeStateMachineTransition_advance_condition: +.. _class_AnimationNodeStateMachineTransition_property_advance_condition: - :ref:`String` **advance_condition** @@ -66,7 +72,7 @@ Property Descriptions | *Getter* | get_advance_condition() | +----------+------------------------------+ -.. _class_AnimationNodeStateMachineTransition_auto_advance: +.. _class_AnimationNodeStateMachineTransition_property_auto_advance: - :ref:`bool` **auto_advance** @@ -76,7 +82,7 @@ Property Descriptions | *Getter* | has_auto_advance() | +----------+-------------------------+ -.. _class_AnimationNodeStateMachineTransition_disabled: +.. _class_AnimationNodeStateMachineTransition_property_disabled: - :ref:`bool` **disabled** @@ -86,7 +92,7 @@ Property Descriptions | *Getter* | is_disabled() | +----------+---------------------+ -.. _class_AnimationNodeStateMachineTransition_priority: +.. _class_AnimationNodeStateMachineTransition_property_priority: - :ref:`int` **priority** @@ -96,7 +102,7 @@ Property Descriptions | *Getter* | get_priority() | +----------+---------------------+ -.. _class_AnimationNodeStateMachineTransition_switch_mode: +.. _class_AnimationNodeStateMachineTransition_property_switch_mode: - :ref:`SwitchMode` **switch_mode** @@ -106,7 +112,7 @@ Property Descriptions | *Getter* | get_switch_mode() | +----------+------------------------+ -.. _class_AnimationNodeStateMachineTransition_xfade_time: +.. _class_AnimationNodeStateMachineTransition_property_xfade_time: - :ref:`float` **xfade_time** diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index b1fd5752a..2c636c10b 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -19,144 +19,144 @@ Brief Description Properties ---------- -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_0/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_0/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_1/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_1/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_10/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_10/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_11/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_11/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_12/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_12/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_13/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_13/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_14/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_14/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_15/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_15/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_16/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_16/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_17/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_17/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_18/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_18/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_19/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_19/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_2/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_2/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_20/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_20/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_21/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_21/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_22/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_22/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_23/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_23/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_24/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_24/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_25/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_25/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_26/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_26/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_27/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_27/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_28/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_28/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_29/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_29/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_3/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_3/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_30/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_30/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_31/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_31/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_4/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_4/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_5/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_5/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_6/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_6/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_7/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_7/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_8/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_8/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_9/auto_advance` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_9/name` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`input_count` | -+-----------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`xfade_time` | -+-----------------------------+-----------------------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_0/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_0/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_1/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_1/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_10/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_10/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_11/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_11/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_12/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_12/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_13/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_13/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_14/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_14/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_15/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_15/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_16/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_16/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_17/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_17/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_18/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_18/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_19/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_19/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_2/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_2/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_20/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_20/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_21/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_21/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_22/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_22/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_23/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_23/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_24/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_24/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_25/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_25/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_26/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_26/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_27/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_27/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_28/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_28/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_29/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_29/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_3/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_3/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_30/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_30/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_31/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_31/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_4/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_4/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_5/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_5/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_6/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_6/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_7/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_7/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_8/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_8/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_9/auto_advance` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_9/name` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`input_count` | ++-----------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`xfade_time` | ++-----------------------------+--------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_AnimationNodeTransition_input_0/auto_advance: +.. _class_AnimationNodeTransition_property_input_0/auto_advance: - :ref:`bool` **input_0/auto_advance** @@ -166,7 +166,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_0/name: +.. _class_AnimationNodeTransition_property_input_0/name: - :ref:`String` **input_0/name** @@ -176,7 +176,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_1/auto_advance: +.. _class_AnimationNodeTransition_property_input_1/auto_advance: - :ref:`bool` **input_1/auto_advance** @@ -186,7 +186,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_1/name: +.. _class_AnimationNodeTransition_property_input_1/name: - :ref:`String` **input_1/name** @@ -196,7 +196,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_10/auto_advance: +.. _class_AnimationNodeTransition_property_input_10/auto_advance: - :ref:`bool` **input_10/auto_advance** @@ -206,7 +206,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_10/name: +.. _class_AnimationNodeTransition_property_input_10/name: - :ref:`String` **input_10/name** @@ -216,7 +216,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_11/auto_advance: +.. _class_AnimationNodeTransition_property_input_11/auto_advance: - :ref:`bool` **input_11/auto_advance** @@ -226,7 +226,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_11/name: +.. _class_AnimationNodeTransition_property_input_11/name: - :ref:`String` **input_11/name** @@ -236,7 +236,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_12/auto_advance: +.. _class_AnimationNodeTransition_property_input_12/auto_advance: - :ref:`bool` **input_12/auto_advance** @@ -246,7 +246,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_12/name: +.. _class_AnimationNodeTransition_property_input_12/name: - :ref:`String` **input_12/name** @@ -256,7 +256,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_13/auto_advance: +.. _class_AnimationNodeTransition_property_input_13/auto_advance: - :ref:`bool` **input_13/auto_advance** @@ -266,7 +266,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_13/name: +.. _class_AnimationNodeTransition_property_input_13/name: - :ref:`String` **input_13/name** @@ -276,7 +276,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_14/auto_advance: +.. _class_AnimationNodeTransition_property_input_14/auto_advance: - :ref:`bool` **input_14/auto_advance** @@ -286,7 +286,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_14/name: +.. _class_AnimationNodeTransition_property_input_14/name: - :ref:`String` **input_14/name** @@ -296,7 +296,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_15/auto_advance: +.. _class_AnimationNodeTransition_property_input_15/auto_advance: - :ref:`bool` **input_15/auto_advance** @@ -306,7 +306,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_15/name: +.. _class_AnimationNodeTransition_property_input_15/name: - :ref:`String` **input_15/name** @@ -316,7 +316,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_16/auto_advance: +.. _class_AnimationNodeTransition_property_input_16/auto_advance: - :ref:`bool` **input_16/auto_advance** @@ -326,7 +326,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_16/name: +.. _class_AnimationNodeTransition_property_input_16/name: - :ref:`String` **input_16/name** @@ -336,7 +336,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_17/auto_advance: +.. _class_AnimationNodeTransition_property_input_17/auto_advance: - :ref:`bool` **input_17/auto_advance** @@ -346,7 +346,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_17/name: +.. _class_AnimationNodeTransition_property_input_17/name: - :ref:`String` **input_17/name** @@ -356,7 +356,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_18/auto_advance: +.. _class_AnimationNodeTransition_property_input_18/auto_advance: - :ref:`bool` **input_18/auto_advance** @@ -366,7 +366,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_18/name: +.. _class_AnimationNodeTransition_property_input_18/name: - :ref:`String` **input_18/name** @@ -376,7 +376,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_19/auto_advance: +.. _class_AnimationNodeTransition_property_input_19/auto_advance: - :ref:`bool` **input_19/auto_advance** @@ -386,7 +386,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_19/name: +.. _class_AnimationNodeTransition_property_input_19/name: - :ref:`String` **input_19/name** @@ -396,7 +396,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_2/auto_advance: +.. _class_AnimationNodeTransition_property_input_2/auto_advance: - :ref:`bool` **input_2/auto_advance** @@ -406,7 +406,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_2/name: +.. _class_AnimationNodeTransition_property_input_2/name: - :ref:`String` **input_2/name** @@ -416,7 +416,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_20/auto_advance: +.. _class_AnimationNodeTransition_property_input_20/auto_advance: - :ref:`bool` **input_20/auto_advance** @@ -426,7 +426,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_20/name: +.. _class_AnimationNodeTransition_property_input_20/name: - :ref:`String` **input_20/name** @@ -436,7 +436,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_21/auto_advance: +.. _class_AnimationNodeTransition_property_input_21/auto_advance: - :ref:`bool` **input_21/auto_advance** @@ -446,7 +446,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_21/name: +.. _class_AnimationNodeTransition_property_input_21/name: - :ref:`String` **input_21/name** @@ -456,7 +456,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_22/auto_advance: +.. _class_AnimationNodeTransition_property_input_22/auto_advance: - :ref:`bool` **input_22/auto_advance** @@ -466,7 +466,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_22/name: +.. _class_AnimationNodeTransition_property_input_22/name: - :ref:`String` **input_22/name** @@ -476,7 +476,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_23/auto_advance: +.. _class_AnimationNodeTransition_property_input_23/auto_advance: - :ref:`bool` **input_23/auto_advance** @@ -486,7 +486,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_23/name: +.. _class_AnimationNodeTransition_property_input_23/name: - :ref:`String` **input_23/name** @@ -496,7 +496,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_24/auto_advance: +.. _class_AnimationNodeTransition_property_input_24/auto_advance: - :ref:`bool` **input_24/auto_advance** @@ -506,7 +506,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_24/name: +.. _class_AnimationNodeTransition_property_input_24/name: - :ref:`String` **input_24/name** @@ -516,7 +516,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_25/auto_advance: +.. _class_AnimationNodeTransition_property_input_25/auto_advance: - :ref:`bool` **input_25/auto_advance** @@ -526,7 +526,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_25/name: +.. _class_AnimationNodeTransition_property_input_25/name: - :ref:`String` **input_25/name** @@ -536,7 +536,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_26/auto_advance: +.. _class_AnimationNodeTransition_property_input_26/auto_advance: - :ref:`bool` **input_26/auto_advance** @@ -546,7 +546,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_26/name: +.. _class_AnimationNodeTransition_property_input_26/name: - :ref:`String` **input_26/name** @@ -556,7 +556,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_27/auto_advance: +.. _class_AnimationNodeTransition_property_input_27/auto_advance: - :ref:`bool` **input_27/auto_advance** @@ -566,7 +566,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_27/name: +.. _class_AnimationNodeTransition_property_input_27/name: - :ref:`String` **input_27/name** @@ -576,7 +576,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_28/auto_advance: +.. _class_AnimationNodeTransition_property_input_28/auto_advance: - :ref:`bool` **input_28/auto_advance** @@ -586,7 +586,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_28/name: +.. _class_AnimationNodeTransition_property_input_28/name: - :ref:`String` **input_28/name** @@ -596,7 +596,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_29/auto_advance: +.. _class_AnimationNodeTransition_property_input_29/auto_advance: - :ref:`bool` **input_29/auto_advance** @@ -606,7 +606,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_29/name: +.. _class_AnimationNodeTransition_property_input_29/name: - :ref:`String` **input_29/name** @@ -616,7 +616,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_3/auto_advance: +.. _class_AnimationNodeTransition_property_input_3/auto_advance: - :ref:`bool` **input_3/auto_advance** @@ -626,7 +626,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_3/name: +.. _class_AnimationNodeTransition_property_input_3/name: - :ref:`String` **input_3/name** @@ -636,7 +636,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_30/auto_advance: +.. _class_AnimationNodeTransition_property_input_30/auto_advance: - :ref:`bool` **input_30/auto_advance** @@ -646,7 +646,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_30/name: +.. _class_AnimationNodeTransition_property_input_30/name: - :ref:`String` **input_30/name** @@ -656,7 +656,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_31/auto_advance: +.. _class_AnimationNodeTransition_property_input_31/auto_advance: - :ref:`bool` **input_31/auto_advance** @@ -666,7 +666,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_31/name: +.. _class_AnimationNodeTransition_property_input_31/name: - :ref:`String` **input_31/name** @@ -676,7 +676,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_4/auto_advance: +.. _class_AnimationNodeTransition_property_input_4/auto_advance: - :ref:`bool` **input_4/auto_advance** @@ -686,7 +686,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_4/name: +.. _class_AnimationNodeTransition_property_input_4/name: - :ref:`String` **input_4/name** @@ -696,7 +696,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_5/auto_advance: +.. _class_AnimationNodeTransition_property_input_5/auto_advance: - :ref:`bool` **input_5/auto_advance** @@ -706,7 +706,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_5/name: +.. _class_AnimationNodeTransition_property_input_5/name: - :ref:`String` **input_5/name** @@ -716,7 +716,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_6/auto_advance: +.. _class_AnimationNodeTransition_property_input_6/auto_advance: - :ref:`bool` **input_6/auto_advance** @@ -726,7 +726,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_6/name: +.. _class_AnimationNodeTransition_property_input_6/name: - :ref:`String` **input_6/name** @@ -736,7 +736,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_7/auto_advance: +.. _class_AnimationNodeTransition_property_input_7/auto_advance: - :ref:`bool` **input_7/auto_advance** @@ -746,7 +746,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_7/name: +.. _class_AnimationNodeTransition_property_input_7/name: - :ref:`String` **input_7/name** @@ -756,7 +756,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_8/auto_advance: +.. _class_AnimationNodeTransition_property_input_8/auto_advance: - :ref:`bool` **input_8/auto_advance** @@ -766,7 +766,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_8/name: +.. _class_AnimationNodeTransition_property_input_8/name: - :ref:`String` **input_8/name** @@ -776,7 +776,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_9/auto_advance: +.. _class_AnimationNodeTransition_property_input_9/auto_advance: - :ref:`bool` **input_9/auto_advance** @@ -786,7 +786,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ -.. _class_AnimationNodeTransition_input_9/name: +.. _class_AnimationNodeTransition_property_input_9/name: - :ref:`String` **input_9/name** @@ -796,7 +796,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ -.. _class_AnimationNodeTransition_input_count: +.. _class_AnimationNodeTransition_property_input_count: - :ref:`int` **input_count** @@ -806,7 +806,7 @@ Property Descriptions | *Getter* | get_enabled_inputs() | +----------+---------------------------+ -.. _class_AnimationNodeTransition_xfade_time: +.. _class_AnimationNodeTransition_property_xfade_time: - :ref:`float` **xfade_time** diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 4bd6a0653..1866996cd 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -19,99 +19,99 @@ Container and player of :ref:`Animation` resources. Properties ---------- -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`assigned_animation` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`autoplay` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_animation` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`current_animation_length` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`current_animation_position` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`playback_active` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`playback_default_blend_time` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`playback_speed` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`root_node` | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`assigned_animation` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`autoplay` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`current_animation` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`current_animation_length` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`current_animation_position` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`playback_active` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`playback_default_blend_time` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`playback_speed` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`root_node` | ++------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ Methods ------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_caches` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_queue` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** 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_playing_speed` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_queue` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** 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 **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue` **(** :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_caches` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_queue` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** 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_playing_speed` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_queue` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** 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 **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue` **(** :ref:`String` name **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` name **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AnimationPlayer_animation_changed: +.. _class_AnimationPlayer_signal_animation_changed: - **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** If the currently being played animation changes, this signal will notify of such change. -.. _class_AnimationPlayer_animation_finished: +.. _class_AnimationPlayer_signal_animation_finished: - **animation_finished** **(** :ref:`String` anim_name **)** Notifies when an animation finished playing. -.. _class_AnimationPlayer_animation_started: +.. _class_AnimationPlayer_signal_animation_started: - **animation_started** **(** :ref:`String` anim_name **)** Notifies when an animation starts playing. -.. _class_AnimationPlayer_caches_cleared: +.. _class_AnimationPlayer_signal_caches_cleared: - **caches_cleared** **(** **)** @@ -120,6 +120,12 @@ Enumerations .. _enum_AnimationPlayer_AnimationProcessMode: +.. _class_AnimationPlayer_constant_ANIMATION_PROCESS_PHYSICS: + +.. _class_AnimationPlayer_constant_ANIMATION_PROCESS_IDLE: + +.. _class_AnimationPlayer_constant_ANIMATION_PROCESS_MANUAL: + enum **AnimationProcessMode**: - **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. @@ -143,7 +149,7 @@ Tutorials Property Descriptions --------------------- -.. _class_AnimationPlayer_assigned_animation: +.. _class_AnimationPlayer_property_assigned_animation: - :ref:`String` **assigned_animation** @@ -153,9 +159,9 @@ Property Descriptions | *Getter* | get_assigned_animation() | +----------+-------------------------------+ -If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation`. +If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation`. -.. _class_AnimationPlayer_autoplay: +.. _class_AnimationPlayer_property_autoplay: - :ref:`String` **autoplay** @@ -167,7 +173,7 @@ If playing, the current animation; otherwise, the animation last played. When se The name of the animation to play when the scene loads. Default value: ``""``. -.. _class_AnimationPlayer_current_animation: +.. _class_AnimationPlayer_property_current_animation: - :ref:`String` **current_animation** @@ -177,9 +183,9 @@ The name of the animation to play when the scene loads. Default value: ``""``. | *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`. Default value: ``""``. +The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play`. Default value: ``""``. -.. _class_AnimationPlayer_current_animation_length: +.. _class_AnimationPlayer_property_current_animation_length: - :ref:`float` **current_animation_length** @@ -189,7 +195,7 @@ The name of the current animation, "" if not playing anything. When being set, d The length (in seconds) of the currently being played animation. -.. _class_AnimationPlayer_current_animation_position: +.. _class_AnimationPlayer_property_current_animation_position: - :ref:`float` **current_animation_position** @@ -199,7 +205,7 @@ The length (in seconds) of the currently being played animation. The position (in seconds) of the currently playing animation. -.. _class_AnimationPlayer_playback_active: +.. _class_AnimationPlayer_property_playback_active: - :ref:`bool` **playback_active** @@ -211,7 +217,7 @@ The position (in seconds) of the currently playing animation. If ``true``, updates animations in response to process-related notifications. Default value: ``true``. -.. _class_AnimationPlayer_playback_default_blend_time: +.. _class_AnimationPlayer_property_playback_default_blend_time: - :ref:`float` **playback_default_blend_time** @@ -223,7 +229,7 @@ If ``true``, updates animations in response to process-related notifications. De The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``. -.. _class_AnimationPlayer_playback_process_mode: +.. _class_AnimationPlayer_property_playback_process_mode: - :ref:`AnimationProcessMode` **playback_process_mode** @@ -235,7 +241,7 @@ The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 p The process notification in which to update animations. Default value: ``ANIMATION_PROCESS_IDLE``. -.. _class_AnimationPlayer_playback_speed: +.. _class_AnimationPlayer_property_playback_speed: - :ref:`float` **playback_speed** @@ -247,7 +253,7 @@ The process notification in which to update animations. Default value: ``ANIMATI The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: ``1``. -.. _class_AnimationPlayer_root_node: +.. _class_AnimationPlayer_property_root_node: - :ref:`NodePath` **root_node** @@ -262,131 +268,131 @@ The node from which node path references will travel. Default value: ``".."``. Method Descriptions ------------------- -.. _class_AnimationPlayer_add_animation: +.. _class_AnimationPlayer_method_add_animation: - :ref:`Error` **add_animation** **(** :ref:`String` name, :ref:`Animation` animation **)** Adds ``animation`` to the player accessible with the key ``name``. -.. _class_AnimationPlayer_advance: +.. _class_AnimationPlayer_method_advance: - void **advance** **(** :ref:`float` delta **)** Shifts position in the animation timeline. Delta is the time in seconds to shift. -.. _class_AnimationPlayer_animation_get_next: +.. _class_AnimationPlayer_method_animation_get_next: - :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const Returns the name of the next animation in the queue. -.. _class_AnimationPlayer_animation_set_next: +.. _class_AnimationPlayer_method_animation_set_next: - void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** Triggers the ``anim_to`` animation when the ``anim_from`` animation completes. -.. _class_AnimationPlayer_clear_caches: +.. _class_AnimationPlayer_method_clear_caches: - void **clear_caches** **(** **)** ``AnimationPlayer`` caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again. -.. _class_AnimationPlayer_clear_queue: +.. _class_AnimationPlayer_method_clear_queue: - void **clear_queue** **(** **)** Clears all queued, unplayed animations. -.. _class_AnimationPlayer_find_animation: +.. _class_AnimationPlayer_method_find_animation: - :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const Returns the name of ``animation`` or empty string if not found. -.. _class_AnimationPlayer_get_animation: +.. _class_AnimationPlayer_method_get_animation: - :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const Returns the :ref:`Animation` with key ``name`` or ``null`` if not found. -.. _class_AnimationPlayer_get_animation_list: +.. _class_AnimationPlayer_method_get_animation_list: - :ref:`PoolStringArray` **get_animation_list** **(** **)** const Returns the list of stored animation names. -.. _class_AnimationPlayer_get_blend_time: +.. _class_AnimationPlayer_method_get_blend_time: - :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const Get the blend time (in seconds) between two animations, referenced by their names. -.. _class_AnimationPlayer_get_playing_speed: +.. _class_AnimationPlayer_method_get_playing_speed: - :ref:`float` **get_playing_speed** **(** **)** const Get the actual playing speed of current animation or 0 if not playing. This speed is the ``playback_speed`` property multiplied by ``custom_speed`` argument specified when calling the ``play`` method. -.. _class_AnimationPlayer_get_queue: +.. _class_AnimationPlayer_method_get_queue: - :ref:`PoolStringArray` **get_queue** **(** **)** -.. _class_AnimationPlayer_has_animation: +.. _class_AnimationPlayer_method_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` name **)** const Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation` with key ``name``. -.. _class_AnimationPlayer_is_playing: +.. _class_AnimationPlayer_method_is_playing: - :ref:`bool` **is_playing** **(** **)** const Returns ``true`` if playing an animation. -.. _class_AnimationPlayer_play: +.. _class_AnimationPlayer_method_play: - void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** Play the animation with key ``name``. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. -.. _class_AnimationPlayer_play_backwards: +.. _class_AnimationPlayer_method_play_backwards: - void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** Play the animation with key ``name`` in reverse. -.. _class_AnimationPlayer_queue: +.. _class_AnimationPlayer_method_queue: - void **queue** **(** :ref:`String` name **)** Queue an animation for playback once the current one is done. -.. _class_AnimationPlayer_remove_animation: +.. _class_AnimationPlayer_method_remove_animation: - void **remove_animation** **(** :ref:`String` name **)** Remove the animation with key ``name``. -.. _class_AnimationPlayer_rename_animation: +.. _class_AnimationPlayer_method_rename_animation: - void **rename_animation** **(** :ref:`String` name, :ref:`String` newname **)** Rename an existing animation with key ``name`` to ``newname``. -.. _class_AnimationPlayer_seek: +.. _class_AnimationPlayer_method_seek: - void **seek** **(** :ref:`float` seconds, :ref:`bool` update=false **)** Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time. -.. _class_AnimationPlayer_set_blend_time: +.. _class_AnimationPlayer_method_set_blend_time: - void **set_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** Specify a blend time (in seconds) between two animations, referenced by their names. -.. _class_AnimationPlayer_stop: +.. _class_AnimationPlayer_method_stop: - void **stop** **(** :ref:`bool` reset=true **)** diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 245041f08..0f1a7ed6b 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -19,34 +19,40 @@ Brief Description Properties ---------- -+----------------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`active` | -+----------------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`anim_player` | -+----------------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`AnimationProcessMode` | :ref:`process_mode` | -+----------------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`root_motion_track` | -+----------------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`tree_root` | -+----------------------------------------------------------------------+-----------------------------------------------------------------+ ++----------------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`active` | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`anim_player` | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`AnimationProcessMode` | :ref:`process_mode` | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`root_motion_track` | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`AnimationNode` | :ref:`tree_root` | ++----------------------------------------------------------------------+--------------------------------------------------------------------------+ Methods ------- -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_root_motion_transform` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_parameter` **(** :ref:`String` old_name, :ref:`String` new_name **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_root_motion_transform` **(** **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_parameter` **(** :ref:`String` old_name, :ref:`String` new_name **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_AnimationTree_AnimationProcessMode: +.. _class_AnimationTree_constant_ANIMATION_PROCESS_PHYSICS: + +.. _class_AnimationTree_constant_ANIMATION_PROCESS_IDLE: + +.. _class_AnimationTree_constant_ANIMATION_PROCESS_MANUAL: + enum **AnimationProcessMode**: - **ANIMATION_PROCESS_PHYSICS** = **0** @@ -58,7 +64,7 @@ enum **AnimationProcessMode**: Property Descriptions --------------------- -.. _class_AnimationTree_active: +.. _class_AnimationTree_property_active: - :ref:`bool` **active** @@ -68,7 +74,7 @@ Property Descriptions | *Getter* | is_active() | +----------+-------------------+ -.. _class_AnimationTree_anim_player: +.. _class_AnimationTree_property_anim_player: - :ref:`NodePath` **anim_player** @@ -78,7 +84,7 @@ Property Descriptions | *Getter* | get_animation_player() | +----------+-----------------------------+ -.. _class_AnimationTree_process_mode: +.. _class_AnimationTree_property_process_mode: - :ref:`AnimationProcessMode` **process_mode** @@ -88,7 +94,7 @@ Property Descriptions | *Getter* | get_process_mode() | +----------+-------------------------+ -.. _class_AnimationTree_root_motion_track: +.. _class_AnimationTree_property_root_motion_track: - :ref:`NodePath` **root_motion_track** @@ -98,7 +104,7 @@ Property Descriptions | *Getter* | get_root_motion_track() | +----------+------------------------------+ -.. _class_AnimationTree_tree_root: +.. _class_AnimationTree_property_tree_root: - :ref:`AnimationNode` **tree_root** @@ -111,15 +117,15 @@ Property Descriptions Method Descriptions ------------------- -.. _class_AnimationTree_advance: +.. _class_AnimationTree_method_advance: - void **advance** **(** :ref:`float` delta **)** -.. _class_AnimationTree_get_root_motion_transform: +.. _class_AnimationTree_method_get_root_motion_transform: - :ref:`Transform` **get_root_motion_transform** **(** **)** const -.. _class_AnimationTree_rename_parameter: +.. _class_AnimationTree_method_rename_parameter: - void **rename_parameter** **(** :ref:`String` old_name, :ref:`String` new_name **)** diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index f6d9307ed..0c9d16e94 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -19,140 +19,160 @@ Animation Player that uses a node graph for blending Animations. Properties ---------- -+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`active` | -+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`base_path` | -+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`master_player` | -+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | -+----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`active` | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`base_path` | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`master_player` | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | ++----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ Methods ------- -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`NodeType` type, :ref:`String` id **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`animation_node_get_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 | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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 | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`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:`Vector2` | :ref:`node_get_position` **(** :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_random_delay` **(** :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:`bool` | :ref:`oneshot_node_has_autorestart` **(** :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 **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_delay` **(** :ref:`String` id, :ref:`float` delay_sec **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_random_delay` **(** :ref:`String` id, :ref:`float` rand_sec **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadein_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadeout_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_start` **(** :ref:`String` id **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_stop` **(** :ref:`String` id **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`recompute_caches` **(** **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` id **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset` **(** **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` seconds **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_input_count` **(** :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 | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_count` **(** :ref:`String` id, :ref:`int` count **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_xfade_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`NodeType` type, :ref:`String` id **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`animation_node_get_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 | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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 | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`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:`Vector2` | :ref:`node_get_position` **(** :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_random_delay` **(** :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:`bool` | :ref:`oneshot_node_has_autorestart` **(** :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 **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_autorestart_delay` **(** :ref:`String` id, :ref:`float` delay_sec **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_autorestart_random_delay` **(** :ref:`String` id, :ref:`float` rand_sec **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_fadein_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_fadeout_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_start` **(** :ref:`String` id **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`oneshot_node_stop` **(** :ref:`String` id **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`recompute_caches` **(** **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` id **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset` **(** **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` seconds **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_input_count` **(** :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 | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_input_count` **(** :ref:`String` id, :ref:`int` count **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`transition_node_set_xfade_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_AnimationTreePlayer_NodeType: +.. _class_AnimationTreePlayer_constant_NODE_OUTPUT: + +.. _class_AnimationTreePlayer_constant_NODE_ANIMATION: + +.. _class_AnimationTreePlayer_constant_NODE_ONESHOT: + +.. _class_AnimationTreePlayer_constant_NODE_MIX: + +.. _class_AnimationTreePlayer_constant_NODE_BLEND2: + +.. _class_AnimationTreePlayer_constant_NODE_BLEND3: + +.. _class_AnimationTreePlayer_constant_NODE_BLEND4: + +.. _class_AnimationTreePlayer_constant_NODE_TIMESCALE: + +.. _class_AnimationTreePlayer_constant_NODE_TIMESEEK: + +.. _class_AnimationTreePlayer_constant_NODE_TRANSITION: + enum **NodeType**: - **NODE_OUTPUT** = **0** --- Output node. @@ -177,6 +197,10 @@ enum **NodeType**: .. _enum_AnimationTreePlayer_AnimationProcessMode: +.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_PHYSICS: + +.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_IDLE: + enum **AnimationProcessMode**: - **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. @@ -193,7 +217,7 @@ It takes :ref:`Animation`\ s from an :ref:`AnimationPlayer` **active** @@ -205,7 +229,7 @@ Property Descriptions If ``true``, the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. -.. _class_AnimationTreePlayer_base_path: +.. _class_AnimationTreePlayer_property_base_path: - :ref:`NodePath` **base_path** @@ -219,7 +243,7 @@ The node from which to relatively access other nodes. Default value: ``".."``. It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at. -.. _class_AnimationTreePlayer_master_player: +.. _class_AnimationTreePlayer_property_master_player: - :ref:`NodePath` **master_player** @@ -233,7 +257,7 @@ The path to the :ref:`AnimationPlayer` from which this `` Once set, Animation nodes can be added to the AnimationTreePlayer. -.. _class_AnimationTreePlayer_playback_process_mode: +.. _class_AnimationTreePlayer_property_playback_process_mode: - :ref:`AnimationProcessMode` **playback_process_mode** @@ -248,65 +272,65 @@ The thread in which to update animations. Default value: ``ANIMATION_PROCESS_IDL Method Descriptions ------------------- -.. _class_AnimationTreePlayer_add_node: +.. _class_AnimationTreePlayer_method_add_node: - void **add_node** **(** :ref:`NodeType` type, :ref:`String` id **)** Adds a ``type`` node to the graph with name ``id``. -.. _class_AnimationTreePlayer_advance: +.. _class_AnimationTreePlayer_method_advance: - void **advance** **(** :ref:`float` delta **)** Shifts position in the animation timeline. Delta is the time in seconds to shift. -.. _class_AnimationTreePlayer_animation_node_get_animation: +.. _class_AnimationTreePlayer_method_animation_node_get_animation: - :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``. -.. _class_AnimationTreePlayer_animation_node_get_master_animation: +.. _class_AnimationTreePlayer_method_animation_node_get_master_animation: - :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. +Returns the name of the :ref:`master_player`'s :ref:`Animation` bound to this animation node. -.. _class_AnimationTreePlayer_animation_node_get_position: +.. _class_AnimationTreePlayer_method_animation_node_get_position: - :ref:`float` **animation_node_get_position** **(** :ref:`String` id **)** const -.. _class_AnimationTreePlayer_animation_node_set_animation: +.. _class_AnimationTreePlayer_method_animation_node_set_animation: - void **animation_node_set_animation** **(** :ref:`String` id, :ref:`Animation` animation **)** -Binds a new :ref:`Animation` from the :ref:`master_player` to the ``AnimationTreePlayer``'s animation node with name ``id``. +Binds a new :ref:`Animation` from the :ref:`master_player` to the ``AnimationTreePlayer``'s animation node with name ``id``. -.. _class_AnimationTreePlayer_animation_node_set_filter_path: +.. _class_AnimationTreePlayer_method_animation_node_set_filter_path: - void **animation_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. -.. _class_AnimationTreePlayer_animation_node_set_master_animation: +.. _class_AnimationTreePlayer_method_animation_node_set_master_animation: - void **animation_node_set_master_animation** **(** :ref:`String` id, :ref:`String` source **)** -Binds the :ref:`Animation` named ``source`` from :ref:`master_player` to the animation node ``id``. Recalculates caches. +Binds the :ref:`Animation` named ``source`` from :ref:`master_player` to the animation node ``id``. Recalculates caches. -.. _class_AnimationTreePlayer_are_nodes_connected: +.. _class_AnimationTreePlayer_method_are_nodes_connected: - :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. -.. _class_AnimationTreePlayer_blend2_node_get_amount: +.. _class_AnimationTreePlayer_method_blend2_node_get_amount: - :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend2 node given its name. -.. _class_AnimationTreePlayer_blend2_node_set_amount: +.. _class_AnimationTreePlayer_method_blend2_node_set_amount: - void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** @@ -320,19 +344,19 @@ Towards 1, the influence of a gets lessened, the influence of b gets raised. At 1, Output is input b. -.. _class_AnimationTreePlayer_blend2_node_set_filter_path: +.. _class_AnimationTreePlayer_method_blend2_node_set_filter_path: - void **blend2_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** If ``enable`` is ``true``, the blend2 node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. -.. _class_AnimationTreePlayer_blend3_node_get_amount: +.. _class_AnimationTreePlayer_method_blend3_node_get_amount: - :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend3 node given its name. -.. _class_AnimationTreePlayer_blend3_node_set_amount: +.. _class_AnimationTreePlayer_method_blend3_node_set_amount: - void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** @@ -350,13 +374,13 @@ From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised a At 1, Output is input b+. -.. _class_AnimationTreePlayer_blend4_node_get_amount: +.. _class_AnimationTreePlayer_method_blend4_node_get_amount: - :ref:`Vector2` **blend4_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend4 node given its name. -.. _class_AnimationTreePlayer_blend4_node_set_amount: +.. _class_AnimationTreePlayer_method_blend4_node_set_amount: - void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** @@ -366,31 +390,31 @@ A Blend4 Node blends two pairs of animations. The two pairs are blended like blend2 and then added together. -.. _class_AnimationTreePlayer_connect_nodes: +.. _class_AnimationTreePlayer_method_connect_nodes: - :ref:`Error` **connect_nodes** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** Connects node ``id`` to ``dst_id`` at the specified input slot. -.. _class_AnimationTreePlayer_disconnect_nodes: +.. _class_AnimationTreePlayer_method_disconnect_nodes: - void **disconnect_nodes** **(** :ref:`String` id, :ref:`int` dst_input_idx **)** Disconnects nodes connected to ``id`` at the specified input slot. -.. _class_AnimationTreePlayer_get_node_list: +.. _class_AnimationTreePlayer_method_get_node_list: - :ref:`PoolStringArray` **get_node_list** **(** **)** Returns a :ref:`PoolStringArray` containing the name of all nodes. -.. _class_AnimationTreePlayer_mix_node_get_amount: +.. _class_AnimationTreePlayer_method_mix_node_get_amount: - :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const Returns mix amount of a Mix node given its name. -.. _class_AnimationTreePlayer_mix_node_set_amount: +.. _class_AnimationTreePlayer_method_mix_node_set_amount: - void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** @@ -398,157 +422,157 @@ Sets mix amount of a Mix node given its name and value. A Mix node adds input b to input a by a the amount given by ratio. -.. _class_AnimationTreePlayer_node_exists: +.. _class_AnimationTreePlayer_method_node_exists: - :ref:`bool` **node_exists** **(** :ref:`String` node **)** const Check if a node exists (by name). -.. _class_AnimationTreePlayer_node_get_input_count: +.. _class_AnimationTreePlayer_method_node_get_input_count: - :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** const Return the input count for a given node. Different types of nodes have different amount of inputs. -.. _class_AnimationTreePlayer_node_get_input_source: +.. _class_AnimationTreePlayer_method_node_get_input_source: - :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** const Return the input source for a given node input. -.. _class_AnimationTreePlayer_node_get_position: +.. _class_AnimationTreePlayer_method_node_get_position: - :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** const Returns position of a node in the graph given its name. -.. _class_AnimationTreePlayer_node_get_type: +.. _class_AnimationTreePlayer_method_node_get_type: - :ref:`NodeType` **node_get_type** **(** :ref:`String` id **)** const Get the node type, will return from NODE\_\* enum. -.. _class_AnimationTreePlayer_node_rename: +.. _class_AnimationTreePlayer_method_node_rename: - :ref:`Error` **node_rename** **(** :ref:`String` node, :ref:`String` new_name **)** Rename a node in the graph. -.. _class_AnimationTreePlayer_node_set_position: +.. _class_AnimationTreePlayer_method_node_set_position: - void **node_set_position** **(** :ref:`String` id, :ref:`Vector2` screen_position **)** Sets position of a node in the graph given its name and position. -.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay: +.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay: - :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** const Returns autostart delay of a OneShot node given its name. -.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay: +.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay: - :ref:`float` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String` id **)** const Returns autostart random delay of a OneShot node given its name. -.. _class_AnimationTreePlayer_oneshot_node_get_fadein_time: +.. _class_AnimationTreePlayer_method_oneshot_node_get_fadein_time: - :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** const Returns fade in time of a OneShot node given its name. -.. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time: +.. _class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time: - :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** const Returns fade out time of a OneShot node given its name. -.. _class_AnimationTreePlayer_oneshot_node_has_autorestart: +.. _class_AnimationTreePlayer_method_oneshot_node_has_autorestart: - :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** const Returns whether a OneShot node will auto restart given its name. -.. _class_AnimationTreePlayer_oneshot_node_is_active: +.. _class_AnimationTreePlayer_method_oneshot_node_is_active: - :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** const Returns whether a OneShot node is active given its name. -.. _class_AnimationTreePlayer_oneshot_node_set_autorestart: +.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart: - void **oneshot_node_set_autorestart** **(** :ref:`String` id, :ref:`bool` enable **)** Sets autorestart property of a OneShot node given its name and value. -.. _class_AnimationTreePlayer_oneshot_node_set_autorestart_delay: +.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay: - void **oneshot_node_set_autorestart_delay** **(** :ref:`String` id, :ref:`float` delay_sec **)** Sets autorestart delay of a OneShot node given its name and value in seconds. -.. _class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay: +.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay: - void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String` id, :ref:`float` rand_sec **)** Sets autorestart random delay of a OneShot node given its name and value in seconds. -.. _class_AnimationTreePlayer_oneshot_node_set_fadein_time: +.. _class_AnimationTreePlayer_method_oneshot_node_set_fadein_time: - void **oneshot_node_set_fadein_time** **(** :ref:`String` id, :ref:`float` time_sec **)** Sets fade in time of a OneShot node given its name and value in seconds. -.. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time: +.. _class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time: - void **oneshot_node_set_fadeout_time** **(** :ref:`String` id, :ref:`float` time_sec **)** Sets fade out time of a OneShot node given its name and value in seconds. -.. _class_AnimationTreePlayer_oneshot_node_set_filter_path: +.. _class_AnimationTreePlayer_method_oneshot_node_set_filter_path: - void **oneshot_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** If ``enable`` is ``true``, the oneshot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. -.. _class_AnimationTreePlayer_oneshot_node_start: +.. _class_AnimationTreePlayer_method_oneshot_node_start: - void **oneshot_node_start** **(** :ref:`String` id **)** Starts a OneShot node given its name. -.. _class_AnimationTreePlayer_oneshot_node_stop: +.. _class_AnimationTreePlayer_method_oneshot_node_stop: - void **oneshot_node_stop** **(** :ref:`String` id **)** Stops the OneShot node with name ``id``. -.. _class_AnimationTreePlayer_recompute_caches: +.. _class_AnimationTreePlayer_method_recompute_caches: - void **recompute_caches** **(** **)** Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state. -.. _class_AnimationTreePlayer_remove_node: +.. _class_AnimationTreePlayer_method_remove_node: - void **remove_node** **(** :ref:`String` id **)** Removes the animation node with name ``id``. -.. _class_AnimationTreePlayer_reset: +.. _class_AnimationTreePlayer_method_reset: - void **reset** **(** **)** Resets this ``AnimationTreePlayer``. -.. _class_AnimationTreePlayer_timescale_node_get_scale: +.. _class_AnimationTreePlayer_method_timescale_node_get_scale: - :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const Returns time scale value of the TimeScale node with name ``id``. -.. _class_AnimationTreePlayer_timescale_node_set_scale: +.. _class_AnimationTreePlayer_method_timescale_node_set_scale: - void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** @@ -558,7 +582,7 @@ The timescale node is used to speed :ref:`Animation`\ s up if t If applied after a blend or mix, affects all input animations to that blend or mix. -.. _class_AnimationTreePlayer_timeseek_node_seek: +.. _class_AnimationTreePlayer_method_timeseek_node_seek: - void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** @@ -566,55 +590,55 @@ Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds`` This functions as a seek in the :ref:`Animation` or the blend or mix of :ref:`Animation`\ s input in it. -.. _class_AnimationTreePlayer_transition_node_delete_input: +.. _class_AnimationTreePlayer_method_transition_node_delete_input: - void **transition_node_delete_input** **(** :ref:`String` id, :ref:`int` input_idx **)** Deletes the input at ``input_idx`` for the transition node with name ``id``. -.. _class_AnimationTreePlayer_transition_node_get_current: +.. _class_AnimationTreePlayer_method_transition_node_get_current: - :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``. -.. _class_AnimationTreePlayer_transition_node_get_input_count: +.. _class_AnimationTreePlayer_method_transition_node_get_input_count: - :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 rightclicking on the transition node. -.. _class_AnimationTreePlayer_transition_node_get_xfade_time: +.. _class_AnimationTreePlayer_method_transition_node_get_xfade_time: - :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** const Returns the cross fade time for the transition node with name ``id``. -.. _class_AnimationTreePlayer_transition_node_has_input_auto_advance: +.. _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 Returns ``true`` if the input at ``input_idx`` on transition node with name ``id`` is set to automatically advance to the next input upon completion. -.. _class_AnimationTreePlayer_transition_node_set_current: +.. _class_AnimationTreePlayer_method_transition_node_set_current: - void **transition_node_set_current** **(** :ref:`String` id, :ref:`int` input_idx **)** The transition node with name ``id`` sets its current input at ``input_idx``. -.. _class_AnimationTreePlayer_transition_node_set_input_auto_advance: +.. _class_AnimationTreePlayer_method_transition_node_set_input_auto_advance: - void **transition_node_set_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes. -.. _class_AnimationTreePlayer_transition_node_set_input_count: +.. _class_AnimationTreePlayer_method_transition_node_set_input_count: - void **transition_node_set_input_count** **(** :ref:`String` id, :ref:`int` count **)** Resizes the number of inputs available for the transition node with name ``id``. -.. _class_AnimationTreePlayer_transition_node_set_xfade_time: +.. _class_AnimationTreePlayer_method_transition_node_set_xfade_time: - void **transition_node_set_xfade_time** **(** :ref:`String` id, :ref:`float` time_sec **)** diff --git a/classes/class_area.rst b/classes/class_area.rst index 1057f409e..9619703f1 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -19,111 +19,111 @@ General purpose area node for detection and 3D physics influence. Properties ---------- -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_damp` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio_bus_name` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio_bus_override` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_distance_scale` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gravity_point` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`gravity_vec` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_damp` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`monitorable` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`monitoring` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`priority` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`reverb_bus_amount` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reverb_bus_enable` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`String` | :ref:`reverb_bus_name` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`reverb_bus_uniformity` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`SpaceOverride` | :ref:`space_override` | -+-----------------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_damp` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio_bus_name` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio_bus_override` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gravity` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gravity_distance_scale` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gravity_point` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`gravity_vec` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_damp` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`monitorable` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`monitoring` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`priority` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`reverb_bus_amount` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reverb_bus_enable` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`String` | :ref:`reverb_bus_name` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`reverb_bus_uniformity` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`SpaceOverride` | :ref:`space_override` | ++-----------------------------------------------+---------------------------------------------------------------------------+ Methods ------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Area_area_entered: +.. _class_Area_signal_area_entered: - **area_entered** **(** :ref:`Area` area **)** Emitted when another area enters. -.. _class_Area_area_exited: +.. _class_Area_signal_area_exited: - **area_exited** **(** :ref:`Area` area **)** Emitted when another area exits. -.. _class_Area_area_shape_entered: +.. _class_Area_signal_area_shape_entered: - **area_shape_entered** **(** :ref:`int` area_id, :ref:`Area` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which areas overlapped. -.. _class_Area_area_shape_exited: +.. _class_Area_signal_area_shape_exited: - **area_shape_exited** **(** :ref:`int` area_id, :ref:`Area` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which areas were overlapping. -.. _class_Area_body_entered: +.. _class_Area_signal_body_entered: - **body_entered** **(** :ref:`Node` body **)** Emitted when a :ref:`PhysicsBody` object enters. -.. _class_Area_body_exited: +.. _class_Area_signal_body_exited: - **body_exited** **(** :ref:`Node` body **)** Emitted when a :ref:`PhysicsBody` object exits. -.. _class_Area_body_shape_entered: +.. _class_Area_signal_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody` object enters, reporting which shapes overlapped. -.. _class_Area_body_shape_exited: +.. _class_Area_signal_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** @@ -134,17 +134,27 @@ Enumerations .. _enum_Area_SpaceOverride: +.. _class_Area_constant_SPACE_OVERRIDE_DISABLED: + +.. _class_Area_constant_SPACE_OVERRIDE_COMBINE: + +.. _class_Area_constant_SPACE_OVERRIDE_COMBINE_REPLACE: + +.. _class_Area_constant_SPACE_OVERRIDE_REPLACE: + +.. _class_Area_constant_SPACE_OVERRIDE_REPLACE_COMBINE: + enum **SpaceOverride**: - **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damping. -- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority` order). +- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority` order). -- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority` order), ignoring any lower priority areas. +- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority` order), ignoring any lower priority areas. - **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. -- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in :ref:`priority` order), but keeps calculating the rest of the areas. +- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in :ref:`priority` order), but keeps calculating the rest of the areas. Description ----------- @@ -154,7 +164,7 @@ Description Property Descriptions --------------------- -.. _class_Area_angular_damp: +.. _class_Area_property_angular_damp: - :ref:`float` **angular_damp** @@ -166,7 +176,7 @@ Property Descriptions The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). -.. _class_Area_audio_bus_name: +.. _class_Area_property_audio_bus_name: - :ref:`String` **audio_bus_name** @@ -178,7 +188,7 @@ The rate at which objects stop spinning in this area. Represents the angular vel The name of the area's audio bus. -.. _class_Area_audio_bus_override: +.. _class_Area_property_audio_bus_override: - :ref:`bool` **audio_bus_override** @@ -190,7 +200,7 @@ The name of the area's audio bus. If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``. -.. _class_Area_collision_layer: +.. _class_Area_property_collision_layer: - :ref:`int` **collision_layer** @@ -200,9 +210,9 @@ If ``true``, the area's audio bus overrides the default audio bus. Default value | *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`. -.. _class_Area_collision_mask: +.. _class_Area_property_collision_mask: - :ref:`int` **collision_mask** @@ -214,7 +224,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different The physics layers this area scans to determine collision detection. -.. _class_Area_gravity: +.. _class_Area_property_gravity: - :ref:`float` **gravity** @@ -226,7 +236,7 @@ The physics layers this area scans to determine collision detection. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. -.. _class_Area_gravity_distance_scale: +.. _class_Area_property_gravity_distance_scale: - :ref:`float` **gravity_distance_scale** @@ -238,7 +248,7 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. -.. _class_Area_gravity_point: +.. _class_Area_property_gravity_point: - :ref:`bool` **gravity_point** @@ -248,9 +258,9 @@ The falloff factor for point gravity. The greater the value, the faster gravity | *Getter* | is_gravity_a_point() | +----------+-----------------------------+ -If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). Also see :ref:`space_override`. Default value: ``false``. +If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). Also see :ref:`space_override`. Default value: ``false``. -.. _class_Area_gravity_vec: +.. _class_Area_property_gravity_vec: - :ref:`Vector3` **gravity_vec** @@ -260,9 +270,9 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`), this will be the point of attraction. +The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point`), this will be the point of attraction. -.. _class_Area_linear_damp: +.. _class_Area_property_linear_damp: - :ref:`float` **linear_damp** @@ -274,7 +284,7 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). -.. _class_Area_monitorable: +.. _class_Area_property_monitorable: - :ref:`bool` **monitorable** @@ -286,7 +296,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci If ``true``, other monitoring areas can detect this area. Default value: ``true``. -.. _class_Area_monitoring: +.. _class_Area_property_monitoring: - :ref:`bool` **monitoring** @@ -298,7 +308,7 @@ If ``true``, other monitoring areas can detect this area. Default value: ``true` If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``. -.. _class_Area_priority: +.. _class_Area_property_priority: - :ref:`float` **priority** @@ -310,7 +320,7 @@ If ``true``, the area detects bodies or areas entering and exiting it. Default v The area's priority. Higher priority areas are processed first. Default value: 0. -.. _class_Area_reverb_bus_amount: +.. _class_Area_property_reverb_bus_amount: - :ref:`float` **reverb_bus_amount** @@ -322,7 +332,7 @@ The area's priority. Higher priority areas are processed first. Default value: 0 The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision. -.. _class_Area_reverb_bus_enable: +.. _class_Area_property_reverb_bus_enable: - :ref:`bool` **reverb_bus_enable** @@ -334,7 +344,7 @@ The degree to which this area applies reverb to its associated audio. Ranges fro If ``true``, the area applies reverb to its associated audio. -.. _class_Area_reverb_bus_name: +.. _class_Area_property_reverb_bus_name: - :ref:`String` **reverb_bus_name** @@ -346,7 +356,7 @@ If ``true``, the area applies reverb to its associated audio. The reverb bus name to use for this area's associated audio. -.. _class_Area_reverb_bus_uniformity: +.. _class_Area_property_reverb_bus_uniformity: - :ref:`float` **reverb_bus_uniformity** @@ -358,7 +368,7 @@ The reverb bus name to use for this area's associated audio. The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision. -.. _class_Area_space_override: +.. _class_Area_property_space_override: - :ref:`SpaceOverride` **space_override** @@ -373,49 +383,49 @@ Override mode for gravity and damping calculations within this area. See :ref:`S Method Descriptions ------------------- -.. _class_Area_get_collision_layer_bit: +.. _class_Area_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the layer mask. -.. _class_Area_get_collision_mask_bit: +.. _class_Area_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. -.. _class_Area_get_overlapping_areas: +.. _class_Area_method_get_overlapping_areas: - :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. -.. _class_Area_get_overlapping_bodies: +.. _class_Area_method_get_overlapping_bodies: - :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. -.. _class_Area_overlaps_area: +.. _class_Area_method_overlaps_area: - :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const If ``true``, the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. -.. _class_Area_overlaps_body: +.. _class_Area_method_overlaps_body: - :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const If ``true``, the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. -.. _class_Area_set_collision_layer_bit: +.. _class_Area_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This simplifies editing this ``Area[code]'s layers. -.. _class_Area_set_collision_mask_bit: +.. _class_Area_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index a939570cb..42f92aa9d 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -19,103 +19,103 @@ Brief Description Properties ---------- -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_damp` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio_bus_name` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio_bus_override` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_distance_scale` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gravity_point` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`gravity_vec` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_damp` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`monitorable` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`monitoring` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`priority` | -+-------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`SpaceOverride` | :ref:`space_override` | -+-------------------------------------------------+--------------------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_damp` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio_bus_name` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio_bus_override` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gravity` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gravity_distance_scale` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gravity_point` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`gravity_vec` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_damp` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`monitorable` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`monitoring` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`priority` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`SpaceOverride` | :ref:`space_override` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ Methods ------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Area2D_area_entered: +.. _class_Area2D_signal_area_entered: - **area_entered** **(** :ref:`Area2D` area **)** Emitted when another area enters. -.. _class_Area2D_area_exited: +.. _class_Area2D_signal_area_exited: - **area_exited** **(** :ref:`Area2D` area **)** Emitted when another area exits. -.. _class_Area2D_area_shape_entered: +.. _class_Area2D_signal_area_shape_entered: - **area_shape_entered** **(** :ref:`int` area_id, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which shapes overlapped. -.. _class_Area2D_area_shape_exited: +.. _class_Area2D_signal_area_shape_exited: - **area_shape_exited** **(** :ref:`int` area_id, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which shapes were overlapping. -.. _class_Area2D_body_entered: +.. _class_Area2D_signal_body_entered: - **body_entered** **(** :ref:`PhysicsBody2D` body **)** Emitted when a :ref:`PhysicsBody2D` object enters. -.. _class_Area2D_body_exited: +.. _class_Area2D_signal_body_exited: - **body_exited** **(** :ref:`PhysicsBody2D` body **)** Emitted when a :ref:`PhysicsBody2D` object exits. -.. _class_Area2D_body_shape_entered: +.. _class_Area2D_signal_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object enters, reporting which shapes overlapped. -.. _class_Area2D_body_shape_exited: +.. _class_Area2D_signal_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** @@ -126,17 +126,27 @@ Enumerations .. _enum_Area2D_SpaceOverride: +.. _class_Area2D_constant_SPACE_OVERRIDE_DISABLED: + +.. _class_Area2D_constant_SPACE_OVERRIDE_COMBINE: + +.. _class_Area2D_constant_SPACE_OVERRIDE_COMBINE_REPLACE: + +.. _class_Area2D_constant_SPACE_OVERRIDE_REPLACE: + +.. _class_Area2D_constant_SPACE_OVERRIDE_REPLACE_COMBINE: + enum **SpaceOverride**: - **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damping. -- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority` order). +- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority` order). -- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority` order), ignoring any lower priority areas. +- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority` order), ignoring any lower priority areas. - **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. -- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in :ref:`priority` order), but keeps calculating the rest of the areas. +- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in :ref:`priority` order), but keeps calculating the rest of the areas. Description ----------- @@ -146,7 +156,7 @@ Description Property Descriptions --------------------- -.. _class_Area2D_angular_damp: +.. _class_Area2D_property_angular_damp: - :ref:`float` **angular_damp** @@ -158,7 +168,7 @@ Property Descriptions The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). -.. _class_Area2D_audio_bus_name: +.. _class_Area2D_property_audio_bus_name: - :ref:`String` **audio_bus_name** @@ -170,7 +180,7 @@ The rate at which objects stop spinning in this area. Represents the angular vel The name of the area's audio bus. -.. _class_Area2D_audio_bus_override: +.. _class_Area2D_property_audio_bus_override: - :ref:`bool` **audio_bus_override** @@ -182,7 +192,7 @@ The name of the area's audio bus. If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``. -.. _class_Area2D_collision_layer: +.. _class_Area2D_property_collision_layer: - :ref:`int` **collision_layer** @@ -192,9 +202,9 @@ If ``true``, the area's audio bus overrides the default audio bus. Default value | *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`. -.. _class_Area2D_collision_mask: +.. _class_Area2D_property_collision_mask: - :ref:`int` **collision_mask** @@ -206,7 +216,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different The physics layers this area scans to determine collision detection. -.. _class_Area2D_gravity: +.. _class_Area2D_property_gravity: - :ref:`float` **gravity** @@ -218,7 +228,7 @@ The physics layers this area scans to determine collision detection. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. -.. _class_Area2D_gravity_distance_scale: +.. _class_Area2D_property_gravity_distance_scale: - :ref:`float` **gravity_distance_scale** @@ -230,7 +240,7 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. -.. _class_Area2D_gravity_point: +.. _class_Area2D_property_gravity_point: - :ref:`bool` **gravity_point** @@ -240,9 +250,9 @@ The falloff factor for point gravity. The greater the value, the faster gravity | *Getter* | is_gravity_a_point() | +----------+-----------------------------+ -If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). Also see :ref:`space_override`. Default value: ``false``. +If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`). Also see :ref:`space_override`. Default value: ``false``. -.. _class_Area2D_gravity_vec: +.. _class_Area2D_property_gravity_vec: - :ref:`Vector2` **gravity_vec** @@ -252,9 +262,9 @@ If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec`), this will be the point of attraction. +The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point`), this will be the point of attraction. -.. _class_Area2D_linear_damp: +.. _class_Area2D_property_linear_damp: - :ref:`float` **linear_damp** @@ -266,7 +276,7 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`gra The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). -.. _class_Area2D_monitorable: +.. _class_Area2D_property_monitorable: - :ref:`bool` **monitorable** @@ -278,7 +288,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci If ``true``, other monitoring areas can detect this area. Default value: ``true``. -.. _class_Area2D_monitoring: +.. _class_Area2D_property_monitoring: - :ref:`bool` **monitoring** @@ -290,7 +300,7 @@ If ``true``, other monitoring areas can detect this area. Default value: ``true` If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``. -.. _class_Area2D_priority: +.. _class_Area2D_property_priority: - :ref:`float` **priority** @@ -302,7 +312,7 @@ If ``true``, the area detects bodies or areas entering and exiting it. Default v The area's priority. Higher priority areas are processed first. Default value: 0. -.. _class_Area2D_space_override: +.. _class_Area2D_property_space_override: - :ref:`SpaceOverride` **space_override** @@ -317,49 +327,49 @@ Override mode for gravity and damping calculations within this area. See :ref:`S Method Descriptions ------------------- -.. _class_Area2D_get_collision_layer_bit: +.. _class_Area2D_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. -.. _class_Area2D_get_collision_mask_bit: +.. _class_Area2D_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. -.. _class_Area2D_get_overlapping_areas: +.. _class_Area2D_method_get_overlapping_areas: - :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. -.. _class_Area2D_get_overlapping_bodies: +.. _class_Area2D_method_get_overlapping_bodies: - :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. -.. _class_Area2D_overlaps_area: +.. _class_Area2D_method_overlaps_area: - :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const If ``true``, the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. -.. _class_Area2D_overlaps_body: +.. _class_Area2D_method_overlaps_body: - :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const If ``true``, the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. -.. _class_Area2D_set_collision_layer_bit: +.. _class_Area2D_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. -.. _class_Area2D_set_collision_mask_bit: +.. _class_Area2D_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_array.rst b/classes/class_array.rst index a5faf105c..474c2d58c 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -17,79 +17,79 @@ Generic array datatype. Methods ------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`back` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bsearch` **(** :ref:`Variant` value, :ref:`bool` before=True **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bsearch_custom` **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`count` **(** :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** :ref:`Variant` what, :ref:`int` from=0 **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`front` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert` **(** :ref:`int` position, :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`max` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`min` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`pop_back` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`pop_front` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_front` **(** :ref:`Variant` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` position **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` size **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** :ref:`Variant` what, :ref:`int` from=-1 **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shuffle` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Variant` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`back` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bsearch` **(** :ref:`Variant` value, :ref:`bool` before=True **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bsearch_custom` **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`count` **(** :ref:`Variant` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`Variant` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** :ref:`Variant` what, :ref:`int` from=0 **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** :ref:`Variant` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`front` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`Variant` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert` **(** :ref:`int` position, :ref:`Variant` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`max` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`min` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`pop_back` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`pop_front` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Variant` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_front` **(** :ref:`Variant` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` position **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` size **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** :ref:`Variant` what, :ref:`int` from=-1 **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shuffle` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -110,85 +110,73 @@ Arrays are always passed by reference. Method Descriptions ------------------- -.. _class_Array_Array: +.. _class_Array_method_Array: - :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** Construct an array from a :ref:`PoolColorArray`. -.. _class_Array_Array: - - :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** Construct an array from a :ref:`PoolVector3Array`. -.. _class_Array_Array: - - :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** Construct an array from a :ref:`PoolVector2Array`. -.. _class_Array_Array: - - :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** Construct an array from a :ref:`PoolStringArray`. -.. _class_Array_Array: - - :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** Construct an array from a :ref:`PoolRealArray`. -.. _class_Array_Array: - - :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** Construct an array from a :ref:`PoolIntArray`. -.. _class_Array_Array: - - :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** Construct an array from a :ref:`PoolByteArray`. -.. _class_Array_append: +.. _class_Array_method_append: - void **append** **(** :ref:`Variant` value **)** -Append an element at the end of the array (alias of :ref:`push_back`). +Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_Array_back: +.. _class_Array_method_back: - :ref:`Variant` **back** **(** **)** Returns the last element of the array if the array is not empty (size>0). -.. _class_Array_bsearch: +.. _class_Array_method_bsearch: - :ref:`int` **bsearch** **(** :ref:`Variant` value, :ref:`bool` before=True **)** Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. -.. _class_Array_bsearch_custom: +.. _class_Array_method_bsearch_custom: - :ref:`int` **bsearch_custom** **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. -.. _class_Array_clear: +.. _class_Array_method_clear: - void **clear** **(** **)** Clear the array (resize to 0). -.. _class_Array_count: +.. _class_Array_method_count: - :ref:`int` **count** **(** :ref:`Variant` value **)** Return the amount of times an element is in the array. -.. _class_Array_duplicate: +.. _class_Array_method_duplicate: - :ref:`Array` **duplicate** **(** :ref:`bool` deep=False **)** @@ -196,37 +184,37 @@ Returns a copy of the array. If ``deep`` is ``true``, a deep copy is be performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If ``false``, a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. -.. _class_Array_empty: +.. _class_Array_method_empty: - :ref:`bool` **empty** **(** **)** Return true if the array is empty (size==0). -.. _class_Array_erase: +.. _class_Array_method_erase: - void **erase** **(** :ref:`Variant` value **)** Remove the first occurrence of a value from the array. -.. _class_Array_find: +.. _class_Array_method_find: - :ref:`int` **find** **(** :ref:`Variant` what, :ref:`int` from=0 **)** Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed. -.. _class_Array_find_last: +.. _class_Array_method_find_last: - :ref:`int` **find_last** **(** :ref:`Variant` value **)** Searches the array in reverse order for a value and returns its index or -1 if not found. -.. _class_Array_front: +.. _class_Array_method_front: - :ref:`Variant` **front** **(** **)** Returns the first element of the array if the array is not empty (size>0). -.. _class_Array_has: +.. _class_Array_method_has: - :ref:`bool` **has** **(** :ref:`Variant` value **)** @@ -239,97 +227,97 @@ Return true if the array contains given value. ["inside", 7].has(7) == true ["inside", 7].has("7") == false -.. _class_Array_hash: +.. _class_Array_method_hash: - :ref:`int` **hash** **(** **)** Return a hashed integer value representing the array contents. -.. _class_Array_insert: +.. _class_Array_method_insert: - void **insert** **(** :ref:`int` position, :ref:`Variant` value **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (``pos == size()``). -.. _class_Array_invert: +.. _class_Array_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_Array_max: +.. _class_Array_method_max: - :ref:`Variant` **max** **(** **)** Return maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. -.. _class_Array_min: +.. _class_Array_method_min: - :ref:`Variant` **min** **(** **)** Return minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. -.. _class_Array_pop_back: +.. _class_Array_method_pop_back: - :ref:`Variant` **pop_back** **(** **)** Remove the last element of the array. -.. _class_Array_pop_front: +.. _class_Array_method_pop_front: - :ref:`Variant` **pop_front** **(** **)** Remove the first element of the array. -.. _class_Array_push_back: +.. _class_Array_method_push_back: - void **push_back** **(** :ref:`Variant` value **)** Append an element at the end of the array. -.. _class_Array_push_front: +.. _class_Array_method_push_front: - void **push_front** **(** :ref:`Variant` value **)** Add an element at the beginning of the array. -.. _class_Array_remove: +.. _class_Array_method_remove: - void **remove** **(** :ref:`int` position **)** Remove an element from the array by index. -.. _class_Array_resize: +.. _class_Array_method_resize: - void **resize** **(** :ref:`int` size **)** Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null. -.. _class_Array_rfind: +.. _class_Array_method_rfind: - :ref:`int` **rfind** **(** :ref:`Variant` what, :ref:`int` from=-1 **)** Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. -.. _class_Array_shuffle: +.. _class_Array_method_shuffle: - void **shuffle** **(** **)** Shuffle the array such that the items will have a random order. -.. _class_Array_size: +.. _class_Array_method_size: - :ref:`int` **size** **(** **)** Return the amount of elements in the array. -.. _class_Array_sort: +.. _class_Array_method_sort: - void **sort** **(** **)** Sort the array using natural order. -.. _class_Array_sort_custom: +.. _class_Array_method_sort_custom: - void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index d5feeb2b2..a0db5606b 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -19,58 +19,78 @@ Brief Description Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------+ -| :ref:`BlendShapeMode` | :ref:`blend_shape_mode` | -+-------------------------------------------------+-----------------------------------------------------------+ -| :ref:`AABB` | :ref:`custom_aabb` | -+-------------------------------------------------+-----------------------------------------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`BlendShapeMode` | :ref:`blend_shape_mode` | ++-------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`custom_aabb` | ++-------------------------------------------------+--------------------------------------------------------------------+ Methods ------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_geometry` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_blend_shapes` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** 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_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_format` **(** :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 | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_update_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_geometry` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_blend_shapes` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** 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_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_format` **(** :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 | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_update_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_ArrayMesh_ArrayType: +.. _class_ArrayMesh_constant_ARRAY_VERTEX: + +.. _class_ArrayMesh_constant_ARRAY_NORMAL: + +.. _class_ArrayMesh_constant_ARRAY_TANGENT: + +.. _class_ArrayMesh_constant_ARRAY_COLOR: + +.. _class_ArrayMesh_constant_ARRAY_TEX_UV: + +.. _class_ArrayMesh_constant_ARRAY_TEX_UV2: + +.. _class_ArrayMesh_constant_ARRAY_BONES: + +.. _class_ArrayMesh_constant_ARRAY_WEIGHTS: + +.. _class_ArrayMesh_constant_ARRAY_INDEX: + +.. _class_ArrayMesh_constant_ARRAY_MAX: + enum **ArrayType**: - **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3` vertices). @@ -97,6 +117,24 @@ For triangles, the index array is interpreted as triples, referring to the verti .. _enum_ArrayMesh_ArrayFormat: +.. _class_ArrayMesh_constant_ARRAY_FORMAT_VERTEX: + +.. _class_ArrayMesh_constant_ARRAY_FORMAT_NORMAL: + +.. _class_ArrayMesh_constant_ARRAY_FORMAT_TANGENT: + +.. _class_ArrayMesh_constant_ARRAY_FORMAT_COLOR: + +.. _class_ArrayMesh_constant_ARRAY_FORMAT_TEX_UV: + +.. _class_ArrayMesh_constant_ARRAY_FORMAT_TEX_UV2: + +.. _class_ArrayMesh_constant_ARRAY_FORMAT_BONES: + +.. _class_ArrayMesh_constant_ARRAY_FORMAT_WEIGHTS: + +.. _class_ArrayMesh_constant_ARRAY_FORMAT_INDEX: + enum **ArrayFormat**: - **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory). @@ -120,6 +158,10 @@ enum **ArrayFormat**: Constants --------- +.. _class_ArrayMesh_constant_NO_INDEX_ARRAY: + +.. _class_ArrayMesh_constant_ARRAY_WEIGHTS_SIZE: + - **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present. - **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4). @@ -150,7 +192,7 @@ The ``MeshInstance`` is ready to be added to the SceneTree to be shown. Property Descriptions --------------------- -.. _class_ArrayMesh_blend_shape_mode: +.. _class_ArrayMesh_property_blend_shape_mode: - :ref:`BlendShapeMode` **blend_shape_mode** @@ -160,7 +202,7 @@ Property Descriptions | *Getter* | get_blend_shape_mode() | +----------+-----------------------------+ -.. _class_ArrayMesh_custom_aabb: +.. _class_ArrayMesh_property_custom_aabb: - :ref:`AABB` **custom_aabb** @@ -175,115 +217,115 @@ An overriding bounding box for this mesh. Method Descriptions ------------------- -.. _class_ArrayMesh_add_blend_shape: +.. _class_ArrayMesh_method_add_blend_shape: - void **add_blend_shape** **(** :ref:`String` name **)** -.. _class_ArrayMesh_add_surface_from_arrays: +.. _class_ArrayMesh_method_add_surface_from_arrays: - void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** Creates a new surface. -Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See :ref:`Mesh` for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). :ref:`Mesh.get_surface_count` will become the ``surf_idx`` for this new surface. +Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See :ref:`Mesh` for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). :ref:`Mesh.get_surface_count` will become the ``surf_idx`` for this new surface. -The ``arrays`` argument is an array of arrays. See :ref:`ArrayType` for the values used in this array. For example, ``arrays[0]`` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for ``ARRAY_INDEX`` if it is used. +The ``arrays`` argument is an array of arrays. See :ref:`ArrayType` for the values used in this array. For example, ``arrays[0]`` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for ``ARRAY_INDEX`` if it is used. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices. Godot uses clockwise winding order for front faces of triangle primitive modes. -.. _class_ArrayMesh_center_geometry: +.. _class_ArrayMesh_method_center_geometry: - void **center_geometry** **(** **)** Centers the geometry. -.. _class_ArrayMesh_clear_blend_shapes: +.. _class_ArrayMesh_method_clear_blend_shapes: - void **clear_blend_shapes** **(** **)** Remove all blend shapes from this ``ArrayMesh``. -.. _class_ArrayMesh_get_blend_shape_count: +.. _class_ArrayMesh_method_get_blend_shape_count: - :ref:`int` **get_blend_shape_count** **(** **)** const Returns the number of blend shapes that the ``ArrayMesh`` holds. -.. _class_ArrayMesh_get_blend_shape_name: +.. _class_ArrayMesh_method_get_blend_shape_name: - :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const Returns the name of the blend shape at this index. -.. _class_ArrayMesh_lightmap_unwrap: +.. _class_ArrayMesh_method_lightmap_unwrap: - :ref:`Error` **lightmap_unwrap** **(** :ref:`Transform` transform, :ref:`float` texel_size **)** Will perform a UV unwrap on the ``ArrayMesh`` to prepare the mesh for lightmapping. -.. _class_ArrayMesh_regen_normalmaps: +.. _class_ArrayMesh_method_regen_normalmaps: - void **regen_normalmaps** **(** **)** Will regenerate normal maps for the ``ArrayMesh``. -.. _class_ArrayMesh_surface_find_by_name: +.. _class_ArrayMesh_method_surface_find_by_name: - :ref:`int` **surface_find_by_name** **(** :ref:`String` name **)** const Return the index of the first surface with this name held within this ``ArrayMesh``. If none are found -1 is returned. -.. _class_ArrayMesh_surface_get_array_index_len: +.. _class_ArrayMesh_method_surface_get_array_index_len: - :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const -Return the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays`). +Return the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays`). -.. _class_ArrayMesh_surface_get_array_len: +.. _class_ArrayMesh_method_surface_get_array_len: - :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const -Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). +Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). -.. _class_ArrayMesh_surface_get_format: +.. _class_ArrayMesh_method_surface_get_format: - :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const -Return the format mask of the requested surface (see :ref:`add_surface_from_arrays`). +Return the format mask of the requested surface (see :ref:`add_surface_from_arrays`). -.. _class_ArrayMesh_surface_get_name: +.. _class_ArrayMesh_method_surface_get_name: - :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const Get the name assigned to this surface. -.. _class_ArrayMesh_surface_get_primitive_type: +.. _class_ArrayMesh_method_surface_get_primitive_type: - :ref:`PrimitiveType` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const -Return the primitive type of the requested surface (see :ref:`add_surface_from_arrays`). +Return the primitive type of the requested surface (see :ref:`add_surface_from_arrays`). -.. _class_ArrayMesh_surface_remove: +.. _class_ArrayMesh_method_surface_remove: - void **surface_remove** **(** :ref:`int` surf_idx **)** Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. -.. _class_ArrayMesh_surface_set_material: +.. _class_ArrayMesh_method_surface_set_material: - void **surface_set_material** **(** :ref:`int` surf_idx, :ref:`Material` material **)** Set a :ref:`Material` for a given surface. Surface will be rendered using this material. -.. _class_ArrayMesh_surface_set_name: +.. _class_ArrayMesh_method_surface_set_name: - void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** Set a name for a given surface. -.. _class_ArrayMesh_surface_update_region: +.. _class_ArrayMesh_method_surface_update_region: - void **surface_update_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index b73096cef..abe0b9caf 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -19,22 +19,22 @@ Anchor point in AR Space. Properties ---------- -+-----------------------+----------------------------------------------+ -| :ref:`int` | :ref:`anchor_id` | -+-----------------------+----------------------------------------------+ ++-----------------------+-------------------------------------------------------+ +| :ref:`int` | :ref:`anchor_id` | ++-----------------------+-------------------------------------------------------+ Methods ------- -+--------------------------------+----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_is_active` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_plane` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_active` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`get_plane` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------+ Description ----------- @@ -48,7 +48,7 @@ Keep in mind that as long as plane detection is enable the size, placing and ori Property Descriptions --------------------- -.. _class_ARVRAnchor_anchor_id: +.. _class_ARVRAnchor_property_anchor_id: - :ref:`int` **anchor_id** @@ -63,25 +63,25 @@ The anchor's id. You can set this before the anchor itself exists. The first anc Method Descriptions ------------------- -.. _class_ARVRAnchor_get_anchor_name: +.. _class_ARVRAnchor_method_get_anchor_name: - :ref:`String` **get_anchor_name** **(** **)** const Returns the name given to this anchor. -.. _class_ARVRAnchor_get_is_active: +.. _class_ARVRAnchor_method_get_is_active: - :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. -.. _class_ARVRAnchor_get_plane: +.. _class_ARVRAnchor_method_get_plane: - :ref:`Plane` **get_plane** **(** **)** const Returns a plane aligned with our anchor, handy for intersection testing -.. _class_ARVRAnchor_get_size: +.. _class_ARVRAnchor_method_get_size: - :ref:`Vector3` **get_size** **(** **)** const diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index d29f94486..68a9b4fc2 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -19,39 +19,39 @@ A spatial node representing a spatially tracked controller. Properties ---------- -+---------------------------+----------------------------------------------------------+ -| :ref:`int` | :ref:`controller_id` | -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`rumble` | -+---------------------------+----------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------+ +| :ref:`int` | :ref:`controller_id` | ++---------------------------+-------------------------------------------------------------------+ +| :ref:`float` | :ref:`rumble` | ++---------------------------+-------------------------------------------------------------------+ 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:`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:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_ARVRController_button_pressed: +.. _class_ARVRController_signal_button_pressed: - **button_pressed** **(** :ref:`int` button **)** Emitted when a button on this controller is pressed. -.. _class_ARVRController_button_release: +.. _class_ARVRController_signal_button_release: - **button_release** **(** :ref:`int` button **)** @@ -69,7 +69,7 @@ The position of the controller node is automatically updated by the ARVR Server. Property Descriptions --------------------- -.. _class_ARVRController_controller_id: +.. _class_ARVRController_property_controller_id: - :ref:`int` **controller_id** @@ -87,7 +87,7 @@ For any other controller that the :ref:`ARVRServer` detects we When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. -.. _class_ARVRController_rumble: +.. _class_ARVRController_property_rumble: - :ref:`float` **rumble** @@ -97,42 +97,42 @@ When a controller is turned off, its slot is freed. This ensures controllers wil | *Getter* | get_rumble() | +----------+-------------------+ -The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble` accordingly. +The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble` accordingly. Method Descriptions ------------------- -.. _class_ARVRController_get_controller_name: +.. _class_ARVRController_method_get_controller_name: - :ref:`String` **get_controller_name** **(** **)** const If active, returns the name of the associated controller if provided by the AR/VR SDK used. -.. _class_ARVRController_get_hand: +.. _class_ARVRController_method_get_hand: - :ref:`TrackerHand` **get_hand** **(** **)** const Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker`. -.. _class_ARVRController_get_is_active: +.. _class_ARVRController_method_get_is_active: - :ref:`bool` **get_is_active** **(** **)** const Returns ``true`` if the bound controller is active. ARVR systems attempt to track active controllers. -.. _class_ARVRController_get_joystick_axis: +.. _class_ARVRController_method_get_joystick_axis: - :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. -.. _class_ARVRController_get_joystick_id: +.. _class_ARVRController_method_get_joystick_id: - :ref:`int` **get_joystick_id** **(** **)** const Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. -.. _class_ARVRController_is_button_pressed: +.. _class_ARVRController_method_is_button_pressed: - :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 7c9c4afea..1fb285a8a 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -21,38 +21,48 @@ Base class for ARVR interface implementation. Properties ---------- -+-------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ar_is_anchor_detection_enabled` | -+-------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interface_is_initialized` | -+-------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interface_is_primary` | -+-------------------------+-------------------------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ar_is_anchor_detection_enabled` | ++-------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interface_is_initialized` | ++-------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interface_is_primary` | ++-------------------------+----------------------------------------------------------------------------------------------------+ Methods ------- -+-------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :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_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 ------------ .. _enum_ARVRInterface_Capabilities: +.. _class_ARVRInterface_constant_ARVR_NONE: + +.. _class_ARVRInterface_constant_ARVR_MONO: + +.. _class_ARVRInterface_constant_ARVR_STEREO: + +.. _class_ARVRInterface_constant_ARVR_AR: + +.. _class_ARVRInterface_constant_ARVR_EXTERNAL: + enum **Capabilities**: - **ARVR_NONE** = **0** --- No ARVR capabilities. @@ -67,6 +77,12 @@ enum **Capabilities**: .. _enum_ARVRInterface_Eyes: +.. _class_ARVRInterface_constant_EYE_MONO: + +.. _class_ARVRInterface_constant_EYE_LEFT: + +.. _class_ARVRInterface_constant_EYE_RIGHT: + enum **Eyes**: - **EYE_MONO** = **0** --- Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported. @@ -77,6 +93,16 @@ enum **Eyes**: .. _enum_ARVRInterface_Tracking_status: +.. _class_ARVRInterface_constant_ARVR_NORMAL_TRACKING: + +.. _class_ARVRInterface_constant_ARVR_EXCESSIVE_MOTION: + +.. _class_ARVRInterface_constant_ARVR_INSUFFICIENT_FEATURES: + +.. _class_ARVRInterface_constant_ARVR_UNKNOWN_TRACKING: + +.. _class_ARVRInterface_constant_ARVR_NOT_TRACKING: + enum **Tracking_status**: - **ARVR_NORMAL_TRACKING** = **0** --- Tracking is behaving as expected. @@ -99,7 +125,7 @@ Interfaces should be written in such a way that simply enabling them will give u Property Descriptions --------------------- -.. _class_ARVRInterface_ar_is_anchor_detection_enabled: +.. _class_ARVRInterface_property_ar_is_anchor_detection_enabled: - :ref:`bool` **ar_is_anchor_detection_enabled** @@ -111,7 +137,7 @@ Property Descriptions On an AR interface, is our anchor detection enabled? -.. _class_ARVRInterface_interface_is_initialized: +.. _class_ARVRInterface_property_interface_is_initialized: - :ref:`bool` **interface_is_initialized** @@ -123,7 +149,7 @@ On an AR interface, is our anchor detection enabled? Has this interface been initialized? -.. _class_ARVRInterface_interface_is_primary: +.. _class_ARVRInterface_property_interface_is_primary: - :ref:`bool` **interface_is_primary** @@ -138,31 +164,31 @@ Is this our primary interface? Method Descriptions ------------------- -.. _class_ARVRInterface_get_capabilities: +.. _class_ARVRInterface_method_get_capabilities: - :ref:`int` **get_capabilities** **(** **)** const Returns a combination of flags providing information about the capabilities of this interface. -.. _class_ARVRInterface_get_name: +.. _class_ARVRInterface_method_get_name: - :ref:`String` **get_name** **(** **)** const Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). -.. _class_ARVRInterface_get_render_targetsize: +.. _class_ARVRInterface_method_get_render_targetsize: - :ref:`Vector2` **get_render_targetsize** **(** **)** Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform. -.. _class_ARVRInterface_get_tracking_status: +.. _class_ARVRInterface_method_get_tracking_status: - :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. -.. _class_ARVRInterface_initialize: +.. _class_ARVRInterface_method_initialize: - :ref:`bool` **initialize** **(** **)** @@ -176,13 +202,13 @@ If you do this for a platform that handles its own output (such as OpenVR) Godot While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD. -.. _class_ARVRInterface_is_stereo: +.. _class_ARVRInterface_method_is_stereo: - :ref:`bool` **is_stereo** **(** **)** Returns true if the current output of this interface is in stereo. -.. _class_ARVRInterface_uninitialize: +.. _class_ARVRInterface_method_uninitialize: - void **uninitialize** **(** **)** diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index d593e2035..1278a85e9 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -19,9 +19,9 @@ Our origin point in AR/VR. Properties ---------- -+---------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`world_scale` | -+---------------------------+--------------------------------------------------+ ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`world_scale` | ++---------------------------+-----------------------------------------------------------+ Description ----------- @@ -37,7 +37,7 @@ So say that your character is driving a car, the ARVROrigin node should be a chi Property Descriptions --------------------- -.. _class_ARVROrigin_world_scale: +.. _class_ARVROrigin_property_world_scale: - :ref:`float` **world_scale** diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 5752735fb..9b38fc186 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -19,38 +19,44 @@ A tracked object Properties ---------- -+---------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`rumble` | -+---------------------------+---------------------------------------------------+ ++---------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`rumble` | ++---------------------------+------------------------------------------------------------+ Methods ------- -+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerHand` | :ref:`get_hand` **(** **)** const | -+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_id` **(** **)** const | -+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`get_orientation` **(** **)** const | -+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_position` **(** **)** 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:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`get_orientation` **(** **)** const | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_position` **(** **)** 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 ------------ .. _enum_ARVRPositionalTracker_TrackerHand: +.. _class_ARVRPositionalTracker_constant_TRACKER_HAND_UNKNOWN: + +.. _class_ARVRPositionalTracker_constant_TRACKER_LEFT_HAND: + +.. _class_ARVRPositionalTracker_constant_TRACKER_RIGHT_HAND: + enum **TrackerHand**: - **TRACKER_HAND_UNKNOWN** = **0** --- The hand this tracker is held in is unknown or not applicable. @@ -71,7 +77,7 @@ The ARVRController and ARVRAnchor both consume objects of this type and should b Property Descriptions --------------------- -.. _class_ARVRPositionalTracker_rumble: +.. _class_ARVRPositionalTracker_property_rumble: - :ref:`float` **rumble** @@ -86,55 +92,55 @@ The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with pre Method Descriptions ------------------- -.. _class_ARVRPositionalTracker_get_hand: +.. _class_ARVRPositionalTracker_method_get_hand: - :ref:`TrackerHand` **get_hand** **(** **)** const Returns the hand holding this tracker, if known. See TRACKER\_\* constants. -.. _class_ARVRPositionalTracker_get_joy_id: +.. _class_ARVRPositionalTracker_method_get_joy_id: - :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. -.. _class_ARVRPositionalTracker_get_name: +.. _class_ARVRPositionalTracker_method_get_name: - :ref:`String` **get_name** **(** **)** const Returns the controller or anchor point's name if available. -.. _class_ARVRPositionalTracker_get_orientation: +.. _class_ARVRPositionalTracker_method_get_orientation: - :ref:`Basis` **get_orientation** **(** **)** const Returns the controller's orientation matrix. -.. _class_ARVRPositionalTracker_get_position: +.. _class_ARVRPositionalTracker_method_get_position: - :ref:`Vector3` **get_position** **(** **)** const Returns the world-space controller position. -.. _class_ARVRPositionalTracker_get_tracks_orientation: +.. _class_ARVRPositionalTracker_method_get_tracks_orientation: - :ref:`bool` **get_tracks_orientation** **(** **)** const Returns ``true`` if this device tracks orientation. -.. _class_ARVRPositionalTracker_get_tracks_position: +.. _class_ARVRPositionalTracker_method_get_tracks_position: - :ref:`bool` **get_tracks_position** **(** **)** const Returns ``true`` if this device tracks position. -.. _class_ARVRPositionalTracker_get_transform: +.. _class_ARVRPositionalTracker_method_get_transform: - :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const Returns the transform combining this device's orientation and position. -.. _class_ARVRPositionalTracker_get_type: +.. _class_ARVRPositionalTracker_method_get_type: - :ref:`TrackerType` **get_type** **(** **)** const diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index bc4de6bdc..bb1a1668a 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -19,63 +19,63 @@ This is our AR/VR Server. Properties ---------- -+-------------------------------------------+--------------------------------------------------------------+ -| :ref:`ARVRInterface` | :ref:`primary_interface` | -+-------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`world_scale` | -+-------------------------------------------+--------------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`ARVRInterface` | :ref:`primary_interface` | ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`world_scale` | ++-------------------------------------------+-----------------------------------------------------------------------+ Methods ------- -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_on_hmd` **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`int` | :ref:`get_interface_count` **(** **)** const | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_interfaces` **(** **)** const | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_commit_usec` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_frame_usec` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_process_usec` **(** **)** | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_reference_frame` **(** **)** const | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** const | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tracker_count` **(** **)** const | -+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_on_hmd` **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** | ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`int` | :ref:`get_interface_count` **(** **)** const | ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_interfaces` **(** **)** const | ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_commit_usec` **(** **)** | ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_frame_usec` **(** **)** | ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_process_usec` **(** **)** | ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_reference_frame` **(** **)** const | ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tracker_count` **(** **)** const | ++-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_ARVRServer_interface_added: +.. _class_ARVRServer_signal_interface_added: - **interface_added** **(** :ref:`String` interface_name **)** Signal send when a new interface has been added. -.. _class_ARVRServer_interface_removed: +.. _class_ARVRServer_signal_interface_removed: - **interface_removed** **(** :ref:`String` interface_name **)** Signal send when an interface is removed. -.. _class_ARVRServer_tracker_added: +.. _class_ARVRServer_signal_tracker_added: - **tracker_added** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker. -.. _class_ARVRServer_tracker_removed: +.. _class_ARVRServer_signal_tracker_removed: - **tracker_removed** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** @@ -86,6 +86,18 @@ Enumerations .. _enum_ARVRServer_TrackerType: +.. _class_ARVRServer_constant_TRACKER_CONTROLLER: + +.. _class_ARVRServer_constant_TRACKER_BASESTATION: + +.. _class_ARVRServer_constant_TRACKER_ANCHOR: + +.. _class_ARVRServer_constant_TRACKER_ANY_KNOWN: + +.. _class_ARVRServer_constant_TRACKER_UNKNOWN: + +.. _class_ARVRServer_constant_TRACKER_ANY: + enum **TrackerType**: - **TRACKER_CONTROLLER** = **1** --- Our tracker tracks the location of a controller. @@ -102,6 +114,12 @@ enum **TrackerType**: .. _enum_ARVRServer_RotationMode: +.. _class_ARVRServer_constant_RESET_FULL_ROTATION: + +.. _class_ARVRServer_constant_RESET_BUT_KEEP_TILT: + +.. _class_ARVRServer_constant_DONT_RESET_ROTATION: + enum **RotationMode**: - **RESET_FULL_ROTATION** = **0** --- Fully reset the orientation of the HMD. Regardless of what direction the user is looking to in the real world. The user will look dead ahead in the virtual world. @@ -118,7 +136,7 @@ The AR/VR Server is the heart of our AR/VR solution and handles all the processi Property Descriptions --------------------- -.. _class_ARVRServer_primary_interface: +.. _class_ARVRServer_property_primary_interface: - :ref:`ARVRInterface` **primary_interface** @@ -128,7 +146,7 @@ Property Descriptions | *Getter* | get_primary_interface() | +----------+------------------------------+ -.. _class_ARVRServer_world_scale: +.. _class_ARVRServer_property_world_scale: - :ref:`float` **world_scale** @@ -143,7 +161,7 @@ Allows you to adjust the scale to your game's units. Most AR/VR platforms assume Method Descriptions ------------------- -.. _class_ARVRServer_center_on_hmd: +.. _class_ARVRServer_method_center_on_hmd: - void **center_on_hmd** **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** @@ -159,61 +177,61 @@ For this method to produce usable results tracking information should be availab You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism. -.. _class_ARVRServer_find_interface: +.. _class_ARVRServer_method_find_interface: - :ref:`ARVRInterface` **find_interface** **(** :ref:`String` name **)** const Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it. -.. _class_ARVRServer_get_hmd_transform: +.. _class_ARVRServer_method_get_hmd_transform: - :ref:`Transform` **get_hmd_transform** **(** **)** Returns the primary interface's transformation. -.. _class_ARVRServer_get_interface: +.. _class_ARVRServer_method_get_interface: - :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** const Get the interface registered at a given index in our list of interfaces. -.. _class_ARVRServer_get_interface_count: +.. _class_ARVRServer_method_get_interface_count: - :ref:`int` **get_interface_count** **(** **)** const Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look through the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. -.. _class_ARVRServer_get_interfaces: +.. _class_ARVRServer_method_get_interfaces: - :ref:`Array` **get_interfaces** **(** **)** const Returns a list of available interfaces with both id and name of the interface. -.. _class_ARVRServer_get_last_commit_usec: +.. _class_ARVRServer_method_get_last_commit_usec: - :ref:`int` **get_last_commit_usec** **(** **)** -.. _class_ARVRServer_get_last_frame_usec: +.. _class_ARVRServer_method_get_last_frame_usec: - :ref:`int` **get_last_frame_usec** **(** **)** -.. _class_ARVRServer_get_last_process_usec: +.. _class_ARVRServer_method_get_last_process_usec: - :ref:`int` **get_last_process_usec** **(** **)** -.. _class_ARVRServer_get_reference_frame: +.. _class_ARVRServer_method_get_reference_frame: - :ref:`Transform` **get_reference_frame** **(** **)** const Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces. -.. _class_ARVRServer_get_tracker: +.. _class_ARVRServer_method_get_tracker: - :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const Get the positional tracker at the given ID. -.. _class_ARVRServer_get_tracker_count: +.. _class_ARVRServer_method_get_tracker_count: - :ref:`int` **get_tracker_count** **(** **)** const diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 6e12cf9b3..50dec7125 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -19,71 +19,71 @@ AStar class representation that uses vectors as edges. 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 **)** 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:`Vector3` to_position **)** 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:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 **)** 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:`Vector3` to_position **)** 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:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector3` position **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- A\* (A star) is a computer algorithm that is widely used in pathfinding and graph traversal, the process of plotting an efficiently directed path between multiple points. It enjoys widespread use due to its performance and accuracy. Godot's A\* implementation make use of vectors as points. -You must add points manually with :ref:`AStar.add_point` and create segments manually with :ref:`AStar.connect_points`. So you can test if there is a path between two points with the :ref:`AStar.are_points_connected` function, get the list of existing ids in the found path with :ref:`AStar.get_id_path`, or the points list with :ref:`AStar.get_point_path`. +You must add points manually with :ref:`add_point` and create segments manually with :ref:`connect_points`. So you can test if there is a path between two points with the :ref:`are_points_connected` function, get the list of existing ids in the found path with :ref:`get_id_path`, or the points list with :ref:`get_point_path`. Method Descriptions ------------------- -.. _class_AStar__compute_cost: +.. _class_AStar_method__compute_cost: - :ref:`float` **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual Called when computing the cost between two connected points. -.. _class_AStar__estimate_cost: +.. _class_AStar_method__estimate_cost: - :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. -.. _class_AStar_add_point: +.. _class_AStar_method_add_point: - void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** @@ -96,19 +96,19 @@ Adds a new point at the given position with the given identifier. The algorithm If there already exists a point for the given id, its position and weight scale are updated to the given values. -.. _class_AStar_are_points_connected: +.. _class_AStar_method_are_points_connected: - :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const Returns whether there is a connection/segment between the given points. -.. _class_AStar_clear: +.. _class_AStar_method_clear: - void **clear** **(** **)** Clears all the points and segments. -.. _class_AStar_connect_points: +.. _class_AStar_method_connect_points: - void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** @@ -121,25 +121,25 @@ Creates a segment between the given points. If ``bidirectional`` is ``false``, o as.add_point(2, Vector3(0, 5, 0)) as.connect_points(1, 2, false) -.. _class_AStar_disconnect_points: +.. _class_AStar_method_disconnect_points: - void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** Deletes the segment between the given points. -.. _class_AStar_get_available_point_id: +.. _class_AStar_method_get_available_point_id: - :ref:`int` **get_available_point_id** **(** **)** const Returns the next available point id with no point associated to it. -.. _class_AStar_get_closest_point: +.. _class_AStar_method_get_closest_point: - :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_position **)** const Returns the id of the closest point to ``to_position``. Returns -1 if there are no points in the points pool. -.. _class_AStar_get_closest_position_in_segment: +.. _class_AStar_method_get_closest_position_in_segment: - :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const @@ -155,7 +155,7 @@ Returns the closest position to ``to_position`` that resides inside a segment be The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the closest position in the segment to the given point. -.. _class_AStar_get_id_path: +.. _class_AStar_method_get_id_path: - :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** @@ -179,7 +179,7 @@ Returns an array with the ids of the points that form the path found by AStar be If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. -.. _class_AStar_get_point_connections: +.. _class_AStar_method_get_point_connections: - :ref:`PoolIntArray` **get_point_connections** **(** :ref:`int` id **)** @@ -198,49 +198,49 @@ Returns an array with the ids of the points that form the connect with the given var neighbors = as.get_point_connections(1) # returns [2, 3] -.. _class_AStar_get_point_path: +.. _class_AStar_method_get_point_path: - :ref:`PoolVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. -.. _class_AStar_get_point_position: +.. _class_AStar_method_get_point_position: - :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** const Returns the position of the point associated with the given id. -.. _class_AStar_get_point_weight_scale: +.. _class_AStar_method_get_point_weight_scale: - :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const Returns the weight scale of the point associated with the given id. -.. _class_AStar_get_points: +.. _class_AStar_method_get_points: - :ref:`Array` **get_points** **(** **)** Returns an array of all points. -.. _class_AStar_has_point: +.. _class_AStar_method_has_point: - :ref:`bool` **has_point** **(** :ref:`int` id **)** const Returns whether a point associated with the given id exists. -.. _class_AStar_remove_point: +.. _class_AStar_method_remove_point: - void **remove_point** **(** :ref:`int` id **)** Removes the point associated with the given id from the points pool. -.. _class_AStar_set_point_position: +.. _class_AStar_method_set_point_position: - void **set_point_position** **(** :ref:`int` id, :ref:`Vector3` position **)** Sets the position for the point with the given id. -.. _class_AStar_set_point_weight_scale: +.. _class_AStar_method_set_point_weight_scale: - void **set_point_weight_scale** **(** :ref:`int` id, :ref:`float` weight_scale **)** diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 478f8e461..8ffa94c2b 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -19,15 +19,15 @@ Packs multiple small textures in a single, bigger one. Helps to optimize video m Properties ---------- -+-------------------------------+----------------------------------------------------+ -| :ref:`Texture` | :ref:`atlas` | -+-------------------------------+----------------------------------------------------+ -| :ref:`bool` | :ref:`filter_clip` | -+-------------------------------+----------------------------------------------------+ -| :ref:`Rect2` | :ref:`margin` | -+-------------------------------+----------------------------------------------------+ -| :ref:`Rect2` | :ref:`region` | -+-------------------------------+----------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------+ +| :ref:`Texture` | :ref:`atlas` | ++-------------------------------+-------------------------------------------------------------+ +| :ref:`bool` | :ref:`filter_clip` | ++-------------------------------+-------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`margin` | ++-------------------------------+-------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`region` | ++-------------------------------+-------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ and a region that defines the actual area of the AtlasTexture. Property Descriptions --------------------- -.. _class_AtlasTexture_atlas: +.. _class_AtlasTexture_property_atlas: - :ref:`Texture` **atlas** @@ -51,7 +51,7 @@ Property Descriptions The texture that contains the atlas. Can be any :ref:`Texture` subtype. -.. _class_AtlasTexture_filter_clip: +.. _class_AtlasTexture_property_filter_clip: - :ref:`bool` **filter_clip** @@ -63,7 +63,7 @@ The texture that contains the atlas. Can be any :ref:`Texture` su If ``true``, clips the area outside of the region to avoid bleeding of the surrounding texture pixels. -.. _class_AtlasTexture_margin: +.. _class_AtlasTexture_property_margin: - :ref:`Rect2` **margin** @@ -75,7 +75,7 @@ If ``true``, clips the area outside of the region to avoid bleeding of the surro The margin around the region. The :ref:`Rect2`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. -.. _class_AtlasTexture_region: +.. _class_AtlasTexture_property_region: - :ref:`Rect2` **region** diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index f66b80d74..188218732 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -21,9 +21,9 @@ Increases or decreases the volume of the selected audio bus. Properties ---------- -+---------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`volume_db` | -+---------------------------+------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`volume_db` | ++---------------------------+---------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Increases or decreases the volume being routed through the audio bus. Property Descriptions --------------------- -.. _class_AudioEffectAmplify_volume_db: +.. _class_AudioEffectAmplify_property_volume_db: - :ref:`float` **volume_db** diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index 05ee15d9d..b9dcb56a8 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -19,5 +19,5 @@ Adds a band limit filter to the Audio Bus. Description ----------- -Limits the frequencies in a range around the :ref:`AudioEffectFilter.cutoff_hz` and allows frequencies outside of this range to pass. +Limits the frequencies in a range around the :ref:`AudioEffectFilter.cutoff_hz` and allows frequencies outside of this range to pass. diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index 877032e1d..3ec331750 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -19,5 +19,5 @@ Adds a band pass filter to the Audio Bus. Description ----------- -Attenuates the frequencies inside of a range around the :ref:`AudioEffectFilter.cutoff_hz` and cuts frequencies outside of this band. +Attenuates the frequencies inside of a range around the :ref:`AudioEffectFilter.cutoff_hz` and cuts frequencies outside of this band. diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index c53ac6a77..088a299b8 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -19,61 +19,61 @@ Adds a chorus audio effect. Properties ---------- -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`dry` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/cutoff_hz` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/delay_ms` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/depth_ms` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/level_db` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/pan` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/1/rate_hz` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/cutoff_hz` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/delay_ms` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/depth_ms` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/level_db` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/pan` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/2/rate_hz` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/cutoff_hz` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/delay_ms` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/depth_ms` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/level_db` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/pan` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/3/rate_hz` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/cutoff_hz` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/delay_ms` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/depth_ms` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/level_db` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/pan` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`voice/4/rate_hz` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`voice_count` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`wet` | -+---------------------------+---------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dry` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/1/cutoff_hz` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/1/delay_ms` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/1/depth_ms` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/1/level_db` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/1/pan` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/1/rate_hz` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/2/cutoff_hz` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/2/delay_ms` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/2/depth_ms` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/2/level_db` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/2/pan` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/2/rate_hz` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/3/cutoff_hz` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/3/delay_ms` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/3/depth_ms` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/3/level_db` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/3/pan` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/3/rate_hz` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/4/cutoff_hz` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/4/delay_ms` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/4/depth_ms` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/4/level_db` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/4/pan` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`voice/4/rate_hz` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`voice_count` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`wet` | ++---------------------------+------------------------------------------------------------------------------+ Description ----------- @@ -83,7 +83,7 @@ Adds a chorus audio effect. The effect applies a filter with voices to duplicate Property Descriptions --------------------- -.. _class_AudioEffectChorus_dry: +.. _class_AudioEffectChorus_property_dry: - :ref:`float` **dry** @@ -95,7 +95,7 @@ Property Descriptions The effect's raw signal. -.. _class_AudioEffectChorus_voice/1/cutoff_hz: +.. _class_AudioEffectChorus_property_voice/1/cutoff_hz: - :ref:`float` **voice/1/cutoff_hz** @@ -107,7 +107,7 @@ The effect's raw signal. The voice's cutoff frequency. -.. _class_AudioEffectChorus_voice/1/delay_ms: +.. _class_AudioEffectChorus_property_voice/1/delay_ms: - :ref:`float` **voice/1/delay_ms** @@ -119,7 +119,7 @@ The voice's cutoff frequency. The voice's signal delay. -.. _class_AudioEffectChorus_voice/1/depth_ms: +.. _class_AudioEffectChorus_property_voice/1/depth_ms: - :ref:`float` **voice/1/depth_ms** @@ -131,7 +131,7 @@ The voice's signal delay. The voice filter's depth. -.. _class_AudioEffectChorus_voice/1/level_db: +.. _class_AudioEffectChorus_property_voice/1/level_db: - :ref:`float` **voice/1/level_db** @@ -143,7 +143,7 @@ The voice filter's depth. The voice's volume. -.. _class_AudioEffectChorus_voice/1/pan: +.. _class_AudioEffectChorus_property_voice/1/pan: - :ref:`float` **voice/1/pan** @@ -155,7 +155,7 @@ The voice's volume. The voice's pan level. -.. _class_AudioEffectChorus_voice/1/rate_hz: +.. _class_AudioEffectChorus_property_voice/1/rate_hz: - :ref:`float` **voice/1/rate_hz** @@ -167,7 +167,7 @@ The voice's pan level. The voice's filter rate. -.. _class_AudioEffectChorus_voice/2/cutoff_hz: +.. _class_AudioEffectChorus_property_voice/2/cutoff_hz: - :ref:`float` **voice/2/cutoff_hz** @@ -179,7 +179,7 @@ The voice's filter rate. The voice's cutoff frequency. -.. _class_AudioEffectChorus_voice/2/delay_ms: +.. _class_AudioEffectChorus_property_voice/2/delay_ms: - :ref:`float` **voice/2/delay_ms** @@ -191,7 +191,7 @@ The voice's cutoff frequency. The voice's signal delay. -.. _class_AudioEffectChorus_voice/2/depth_ms: +.. _class_AudioEffectChorus_property_voice/2/depth_ms: - :ref:`float` **voice/2/depth_ms** @@ -203,7 +203,7 @@ The voice's signal delay. The voice filter's depth. -.. _class_AudioEffectChorus_voice/2/level_db: +.. _class_AudioEffectChorus_property_voice/2/level_db: - :ref:`float` **voice/2/level_db** @@ -215,7 +215,7 @@ The voice filter's depth. The voice's volume. -.. _class_AudioEffectChorus_voice/2/pan: +.. _class_AudioEffectChorus_property_voice/2/pan: - :ref:`float` **voice/2/pan** @@ -227,7 +227,7 @@ The voice's volume. The voice's pan level. -.. _class_AudioEffectChorus_voice/2/rate_hz: +.. _class_AudioEffectChorus_property_voice/2/rate_hz: - :ref:`float` **voice/2/rate_hz** @@ -239,7 +239,7 @@ The voice's pan level. The voice's filter rate. -.. _class_AudioEffectChorus_voice/3/cutoff_hz: +.. _class_AudioEffectChorus_property_voice/3/cutoff_hz: - :ref:`float` **voice/3/cutoff_hz** @@ -251,7 +251,7 @@ The voice's filter rate. The voice's cutoff frequency. -.. _class_AudioEffectChorus_voice/3/delay_ms: +.. _class_AudioEffectChorus_property_voice/3/delay_ms: - :ref:`float` **voice/3/delay_ms** @@ -263,7 +263,7 @@ The voice's cutoff frequency. The voice's signal delay. -.. _class_AudioEffectChorus_voice/3/depth_ms: +.. _class_AudioEffectChorus_property_voice/3/depth_ms: - :ref:`float` **voice/3/depth_ms** @@ -275,7 +275,7 @@ The voice's signal delay. The voice filter's depth. -.. _class_AudioEffectChorus_voice/3/level_db: +.. _class_AudioEffectChorus_property_voice/3/level_db: - :ref:`float` **voice/3/level_db** @@ -287,7 +287,7 @@ The voice filter's depth. The voice's volume. -.. _class_AudioEffectChorus_voice/3/pan: +.. _class_AudioEffectChorus_property_voice/3/pan: - :ref:`float` **voice/3/pan** @@ -299,7 +299,7 @@ The voice's volume. The voice's pan level. -.. _class_AudioEffectChorus_voice/3/rate_hz: +.. _class_AudioEffectChorus_property_voice/3/rate_hz: - :ref:`float` **voice/3/rate_hz** @@ -311,7 +311,7 @@ The voice's pan level. The voice's filter rate. -.. _class_AudioEffectChorus_voice/4/cutoff_hz: +.. _class_AudioEffectChorus_property_voice/4/cutoff_hz: - :ref:`float` **voice/4/cutoff_hz** @@ -323,7 +323,7 @@ The voice's filter rate. The voice's cutoff frequency. -.. _class_AudioEffectChorus_voice/4/delay_ms: +.. _class_AudioEffectChorus_property_voice/4/delay_ms: - :ref:`float` **voice/4/delay_ms** @@ -335,7 +335,7 @@ The voice's cutoff frequency. The voice's signal delay. -.. _class_AudioEffectChorus_voice/4/depth_ms: +.. _class_AudioEffectChorus_property_voice/4/depth_ms: - :ref:`float` **voice/4/depth_ms** @@ -347,7 +347,7 @@ The voice's signal delay. The voice filter's depth. -.. _class_AudioEffectChorus_voice/4/level_db: +.. _class_AudioEffectChorus_property_voice/4/level_db: - :ref:`float` **voice/4/level_db** @@ -359,7 +359,7 @@ The voice filter's depth. The voice's volume. -.. _class_AudioEffectChorus_voice/4/pan: +.. _class_AudioEffectChorus_property_voice/4/pan: - :ref:`float` **voice/4/pan** @@ -371,7 +371,7 @@ The voice's volume. The voice's pan level. -.. _class_AudioEffectChorus_voice/4/rate_hz: +.. _class_AudioEffectChorus_property_voice/4/rate_hz: - :ref:`float` **voice/4/rate_hz** @@ -383,7 +383,7 @@ The voice's pan level. The voice's filter rate. -.. _class_AudioEffectChorus_voice_count: +.. _class_AudioEffectChorus_property_voice_count: - :ref:`int` **voice_count** @@ -395,7 +395,7 @@ The voice's filter rate. The amount of voices in the effect. -.. _class_AudioEffectChorus_wet: +.. _class_AudioEffectChorus_property_wet: - :ref:`float` **wet** diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 15004d91e..e7f4c3851 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -21,21 +21,21 @@ Reduces sounds that exceed a certain threshold level, smooths out the dynamics a Properties ---------- -+-----------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`attack_us` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`gain` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`mix` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`ratio` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`release_ms` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`sidechain` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`threshold` | -+-----------------------------+-----------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`attack_us` | ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`gain` | ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`mix` | ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`ratio` | ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`release_ms` | ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`sidechain` | ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`threshold` | ++-----------------------------+--------------------------------------------------------------------+ Description ----------- @@ -55,7 +55,7 @@ Compressor has many uses in the mix: Property Descriptions --------------------- -.. _class_AudioEffectCompressor_attack_us: +.. _class_AudioEffectCompressor_property_attack_us: - :ref:`float` **attack_us** @@ -67,7 +67,7 @@ Property Descriptions Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: ``20ms``. -.. _class_AudioEffectCompressor_gain: +.. _class_AudioEffectCompressor_property_gain: - :ref:`float` **gain** @@ -79,7 +79,7 @@ Compressor's reaction time when the signal exceeds the threshold. Value can rang Gain applied to the output signal. -.. _class_AudioEffectCompressor_mix: +.. _class_AudioEffectCompressor_property_mix: - :ref:`float` **mix** @@ -91,7 +91,7 @@ Gain applied to the output signal. Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``. -.. _class_AudioEffectCompressor_ratio: +.. _class_AudioEffectCompressor_property_ratio: - :ref:`float` **ratio** @@ -103,7 +103,7 @@ Balance between original signal and effect signal. Value can range from 0 (total Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: ``4``. -.. _class_AudioEffectCompressor_release_ms: +.. _class_AudioEffectCompressor_property_release_ms: - :ref:`float` **release_ms** @@ -115,7 +115,7 @@ Amount of compression applied to the audio once it passes the threshold level. T Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: ``250ms``. -.. _class_AudioEffectCompressor_sidechain: +.. _class_AudioEffectCompressor_property_sidechain: - :ref:`String` **sidechain** @@ -127,7 +127,7 @@ Compressor's delay time to stop reducing the signal after the signal level falls Reduce the sound level using another audio bus for threshold detection. -.. _class_AudioEffectCompressor_threshold: +.. _class_AudioEffectCompressor_property_threshold: - :ref:`float` **threshold** diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 06cb4a2ec..1b9ff7c94 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -21,33 +21,33 @@ Two tap delay and feedback options. Properties ---------- -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`dry` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`feedback/active` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`feedback/delay_ms` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`feedback/level_db` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`feedback/lowpass` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tap1/active` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap1/delay_ms` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap1/level_db` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap1/pan` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tap2/active` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap2/delay_ms` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap2/level_db` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`tap2/pan` | -+---------------------------+--------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dry` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`feedback/active` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`feedback/delay_ms` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`feedback/level_db` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`feedback/lowpass` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tap1/active` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tap1/delay_ms` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tap1/level_db` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tap1/pan` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tap2/active` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tap2/delay_ms` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tap2/level_db` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tap2/pan` | ++---------------------------+-----------------------------------------------------------------------------+ Description ----------- @@ -57,7 +57,7 @@ Plays input signal back after a period of time. The delayed signal may be played Property Descriptions --------------------- -.. _class_AudioEffectDelay_dry: +.. _class_AudioEffectDelay_property_dry: - :ref:`float` **dry** @@ -69,7 +69,7 @@ Property Descriptions Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: ``1``. -.. _class_AudioEffectDelay_feedback/active: +.. _class_AudioEffectDelay_property_feedback/active: - :ref:`bool` **feedback/active** @@ -81,7 +81,7 @@ Output percent of original sound. At 0, only delayed sounds are output. Value ca If ``true``, feedback is enabled. Default value: ``false``. -.. _class_AudioEffectDelay_feedback/delay_ms: +.. _class_AudioEffectDelay_property_feedback/delay_ms: - :ref:`float` **feedback/delay_ms** @@ -93,7 +93,7 @@ If ``true``, feedback is enabled. Default value: ``false``. Feedback delay time in milliseconds. Default value: ``340``. -.. _class_AudioEffectDelay_feedback/level_db: +.. _class_AudioEffectDelay_property_feedback/level_db: - :ref:`float` **feedback/level_db** @@ -105,7 +105,7 @@ Feedback delay time in milliseconds. Default value: ``340``. Sound level for ``tap1``. Default value: ``-6 dB``. -.. _class_AudioEffectDelay_feedback/lowpass: +.. _class_AudioEffectDelay_property_feedback/lowpass: - :ref:`float` **feedback/lowpass** @@ -117,7 +117,7 @@ Sound level for ``tap1``. Default value: ``-6 dB``. Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: ``16000``. -.. _class_AudioEffectDelay_tap1/active: +.. _class_AudioEffectDelay_property_tap1/active: - :ref:`bool` **tap1/active** @@ -129,7 +129,7 @@ Low-pass filter for feedback. Frequencies below the Low Cut value are filtered o If ``true``, ``tap1`` will be enabled. Default value: ``true``. -.. _class_AudioEffectDelay_tap1/delay_ms: +.. _class_AudioEffectDelay_property_tap1/delay_ms: - :ref:`float` **tap1/delay_ms** @@ -141,7 +141,7 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``. **Tap1** delay time in milliseconds. Default value: ``250ms``. -.. _class_AudioEffectDelay_tap1/level_db: +.. _class_AudioEffectDelay_property_tap1/level_db: - :ref:`float` **tap1/level_db** @@ -153,7 +153,7 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``. Sound level for ``tap1``. Default value: ``-6 dB``. -.. _class_AudioEffectDelay_tap1/pan: +.. _class_AudioEffectDelay_property_tap1/pan: - :ref:`float` **tap1/pan** @@ -165,7 +165,7 @@ Sound level for ``tap1``. Default value: ``-6 dB``. Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``. -.. _class_AudioEffectDelay_tap2/active: +.. _class_AudioEffectDelay_property_tap2/active: - :ref:`bool` **tap2/active** @@ -177,7 +177,7 @@ Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully righ If ``true``, ``tap2`` will be enabled. Default value: ``true``. -.. _class_AudioEffectDelay_tap2/delay_ms: +.. _class_AudioEffectDelay_property_tap2/delay_ms: - :ref:`float` **tap2/delay_ms** @@ -189,7 +189,7 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``. **Tap2** delay time in milliseconds. Default value: ``500ms``. -.. _class_AudioEffectDelay_tap2/level_db: +.. _class_AudioEffectDelay_property_tap2/level_db: - :ref:`float` **tap2/level_db** @@ -201,7 +201,7 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``. Sound level for ``tap2``. Default value: ``-12 dB``. -.. _class_AudioEffectDelay_tap2/pan: +.. _class_AudioEffectDelay_property_tap2/pan: - :ref:`float` **tap2/pan** diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 763ee9881..9d1599611 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -21,23 +21,33 @@ Modify the sound to make it dirty. Properties ---------- -+----------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`drive` | -+----------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`keep_hf_hz` | -+----------------------------------------------+-----------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+----------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`post_gain` | -+----------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`pre_gain` | -+----------------------------------------------+-----------------------------------------------------------+ ++----------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`drive` | ++----------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`keep_hf_hz` | ++----------------------------------------------+--------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++----------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`post_gain` | ++----------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`pre_gain` | ++----------------------------------------------+--------------------------------------------------------------------+ Enumerations ------------ .. _enum_AudioEffectDistortion_Mode: +.. _class_AudioEffectDistortion_constant_MODE_CLIP: + +.. _class_AudioEffectDistortion_constant_MODE_ATAN: + +.. _class_AudioEffectDistortion_constant_MODE_LOFI: + +.. _class_AudioEffectDistortion_constant_MODE_OVERDRIVE: + +.. _class_AudioEffectDistortion_constant_MODE_WAVESHAPE: + enum **Mode**: - **MODE_CLIP** = **0** --- Digital distortion effect which cuts off peaks at the top and bottom of the waveform. @@ -60,7 +70,7 @@ By distorting the waveform the frequency content change, which will often make t Property Descriptions --------------------- -.. _class_AudioEffectDistortion_drive: +.. _class_AudioEffectDistortion_property_drive: - :ref:`float` **drive** @@ -72,7 +82,7 @@ Property Descriptions Distortion power. Value can range from 0 to 1. Default value: ``0``. -.. _class_AudioEffectDistortion_keep_hf_hz: +.. _class_AudioEffectDistortion_property_keep_hf_hz: - :ref:`float` **keep_hf_hz** @@ -84,7 +94,7 @@ Distortion power. Value can range from 0 to 1. Default value: ``0``. High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: ``16000``. -.. _class_AudioEffectDistortion_mode: +.. _class_AudioEffectDistortion_property_mode: - :ref:`Mode` **mode** @@ -96,7 +106,7 @@ High-pass filter. Frequencies higher than this value will not be affected by the Distortion type. Default value: ``MODE_CLIP``. -.. _class_AudioEffectDistortion_post_gain: +.. _class_AudioEffectDistortion_property_post_gain: - :ref:`float` **post_gain** @@ -108,7 +118,7 @@ Distortion type. Default value: ``MODE_CLIP``. Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``. -.. _class_AudioEffectDistortion_pre_gain: +.. _class_AudioEffectDistortion_property_pre_gain: - :ref:`float` **pre_gain** diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index 215acbca7..d5883d046 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -23,13 +23,13 @@ Use it to create a custom equalizer if :ref:`AudioEffectEQ6` | :ref:`get_band_count` **(** **)** 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 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_band_count` **(** **)** 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 **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -39,19 +39,19 @@ AudioEffectEQ gives you control over frequencies. Use it to compensate for exist Method Descriptions ------------------- -.. _class_AudioEffectEQ_get_band_count: +.. _class_AudioEffectEQ_method_get_band_count: - :ref:`int` **get_band_count** **(** **)** const Returns the number of bands of the equalizer. -.. _class_AudioEffectEQ_get_band_gain_db: +.. _class_AudioEffectEQ_method_get_band_gain_db: - :ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** const Returns the band's gain at the specified index, in dB. -.. _class_AudioEffectEQ_set_band_gain_db: +.. _class_AudioEffectEQ_method_set_band_gain_db: - void **set_band_gain_db** **(** :ref:`int` band_idx, :ref:`float` volume_db **)** diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 31b27152f..1ef0dc0c2 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -21,21 +21,29 @@ Adds a filter to the Audio Bus. Properties ---------- -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`cutoff_hz` | -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`FilterDB` | :ref:`db` | -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`gain` | -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`resonance` | -+--------------------------------------------------+-----------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`cutoff_hz` | ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`FilterDB` | :ref:`db` | ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`gain` | ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`resonance` | ++--------------------------------------------------+--------------------------------------------------------------+ Enumerations ------------ .. _enum_AudioEffectFilter_FilterDB: +.. _class_AudioEffectFilter_constant_FILTER_6DB: + +.. _class_AudioEffectFilter_constant_FILTER_12DB: + +.. _class_AudioEffectFilter_constant_FILTER_18DB: + +.. _class_AudioEffectFilter_constant_FILTER_24DB: + enum **FilterDB**: - **FILTER_6DB** = **0** @@ -49,12 +57,12 @@ enum **FilterDB**: Description ----------- -Allows frequencies other than the :ref:`cutoff_hz` to pass. +Allows frequencies other than the :ref:`cutoff_hz` to pass. Property Descriptions --------------------- -.. _class_AudioEffectFilter_cutoff_hz: +.. _class_AudioEffectFilter_property_cutoff_hz: - :ref:`float` **cutoff_hz** @@ -66,7 +74,7 @@ Property Descriptions Threshold frequency for the filter. -.. _class_AudioEffectFilter_db: +.. _class_AudioEffectFilter_property_db: - :ref:`FilterDB` **db** @@ -76,7 +84,7 @@ Threshold frequency for the filter. | *Getter* | get_db() | +----------+---------------+ -.. _class_AudioEffectFilter_gain: +.. _class_AudioEffectFilter_property_gain: - :ref:`float` **gain** @@ -88,7 +96,7 @@ Threshold frequency for the filter. Gain amount of the frequencies after the filter. -.. _class_AudioEffectFilter_resonance: +.. _class_AudioEffectFilter_property_resonance: - :ref:`float` **resonance** diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index e04f86666..d0ef18ca5 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -19,5 +19,5 @@ Adds a high pass filter to the Audio Bus. Description ----------- -Cuts frequencies lower than the :ref:`AudioEffectFilter.cutoff_hz` and allows higher frequencies to pass. +Cuts frequencies lower than the :ref:`AudioEffectFilter.cutoff_hz` and allows higher frequencies to pass. diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index b236e5b0f..4eabebac7 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -19,15 +19,15 @@ Adds a soft clip Limiter audio effect to an Audio bus. Properties ---------- -+---------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`ceiling_db` | -+---------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`soft_clip_db` | -+---------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`soft_clip_ratio` | -+---------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`threshold_db` | -+---------------------------+------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ceiling_db` | ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`soft_clip_db` | ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`soft_clip_ratio` | ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`threshold_db` | ++---------------------------+---------------------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ Soft clipping starts to reduce the peaks a little below the threshold level and Property Descriptions --------------------- -.. _class_AudioEffectLimiter_ceiling_db: +.. _class_AudioEffectLimiter_property_ceiling_db: - :ref:`float` **ceiling_db** @@ -51,7 +51,7 @@ Property Descriptions The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``. -.. _class_AudioEffectLimiter_soft_clip_db: +.. _class_AudioEffectLimiter_property_soft_clip_db: - :ref:`float` **soft_clip_db** @@ -63,7 +63,7 @@ The waveform's maximum allowed value. Value can range from -20 to -0.1. Default Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``. -.. _class_AudioEffectLimiter_soft_clip_ratio: +.. _class_AudioEffectLimiter_property_soft_clip_ratio: - :ref:`float` **soft_clip_ratio** @@ -73,7 +73,7 @@ Applies a gain to the limited waves. Value can range from 0 to 6. Default value: | *Getter* | get_soft_clip_ratio() | +----------+----------------------------+ -.. _class_AudioEffectLimiter_threshold_db: +.. _class_AudioEffectLimiter_property_threshold_db: - :ref:`float` **threshold_db** diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index d965814ca..701ee2cb2 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -19,5 +19,5 @@ Adds a low pass filter to the Audio Bus. Description ----------- -Cuts frequencies higher than the :ref:`AudioEffectFilter.cutoff_hz` and allows lower frequencies to pass. +Cuts frequencies higher than the :ref:`AudioEffectFilter.cutoff_hz` and allows lower frequencies to pass. diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 224739d79..58fcd4251 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -19,5 +19,5 @@ Adds a notch filter to the Audio Bus. Description ----------- -Attenuates frequencies in a narrow band around the :ref:`AudioEffectFilter.cutoff_hz` and cuts frequencies outside of this range. +Attenuates frequencies in a narrow band around the :ref:`AudioEffectFilter.cutoff_hz` and cuts frequencies outside of this range. diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index 3a53d4ee0..73a590ed3 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -19,9 +19,9 @@ Adds a Panner audio effect to an Audio bus. Pans sound left or right. Properties ---------- -+---------------------------+-----------------------------------------+ -| :ref:`float` | :ref:`pan` | -+---------------------------+-----------------------------------------+ ++---------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`pan` | ++---------------------------+--------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Determines how much of an audio signal is sent to the left and right buses. Property Descriptions --------------------- -.. _class_AudioEffectPanner_pan: +.. _class_AudioEffectPanner_property_pan: - :ref:`float` **pan** diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 7d586b2a4..d72e0f9e0 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -21,17 +21,17 @@ Combines the original signal with a copy that is slightly out of phase with the Properties ---------- -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`depth` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`feedback` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`range_max_hz` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`range_min_hz` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`rate_hz` | -+---------------------------+-----------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`depth` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`feedback` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`range_max_hz` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`range_min_hz` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`rate_hz` | ++---------------------------+--------------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ Combines phase-shifted signals with the original signal. The movement of the pha Property Descriptions --------------------- -.. _class_AudioEffectPhaser_depth: +.. _class_AudioEffectPhaser_property_depth: - :ref:`float` **depth** @@ -53,7 +53,7 @@ Property Descriptions Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: ``1``. -.. _class_AudioEffectPhaser_feedback: +.. _class_AudioEffectPhaser_property_feedback: - :ref:`float` **feedback** @@ -65,7 +65,7 @@ Governs how high the filter frequencies sweep. Low value will primarily affect b Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``. -.. _class_AudioEffectPhaser_range_max_hz: +.. _class_AudioEffectPhaser_property_range_max_hz: - :ref:`float` **range_max_hz** @@ -77,7 +77,7 @@ Output percent of modified sound. Value can range from 0.1 to 0.9. Default value Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``1600hz``. -.. _class_AudioEffectPhaser_range_min_hz: +.. _class_AudioEffectPhaser_property_range_min_hz: - :ref:`float` **range_min_hz** @@ -89,7 +89,7 @@ Determines the maximum frequency affected by the LFO modulations. Value can rang Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``440hz``. -.. _class_AudioEffectPhaser_rate_hz: +.. _class_AudioEffectPhaser_property_rate_hz: - :ref:`float` **rate_hz** diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 85793edc1..4f299e807 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -21,9 +21,9 @@ Raises or lowers the pitch of original sound. Properties ---------- -+---------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`pitch_scale` | -+---------------------------+-------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`pitch_scale` | ++---------------------------+----------------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Allows modulation of pitch independently of tempo. All frequencies can be increa Property Descriptions --------------------- -.. _class_AudioEffectPitchShift_pitch_scale: +.. _class_AudioEffectPitchShift_property_pitch_scale: - :ref:`float` **pitch_scale** diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index ae1531453..b95c8dff3 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -19,25 +19,25 @@ Brief Description Properties ---------- -+----------------------------------------------+-----------------------------------------------+ -| :ref:`Format` | :ref:`format` | -+----------------------------------------------+-----------------------------------------------+ ++----------------------------------------------+--------------------------------------------------------+ +| :ref:`Format` | :ref:`format` | ++----------------------------------------------+--------------------------------------------------------+ Methods ------- -+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStreamSample` | :ref:`get_recording` **(** **)** const | -+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_recording_active` **(** **)** const | -+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_recording_active` **(** :ref:`bool` record **)** | -+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStreamSample` | :ref:`get_recording` **(** **)** const | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_recording_active` **(** **)** const | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_recording_active` **(** :ref:`bool` record **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_AudioEffectRecord_format: +.. _class_AudioEffectRecord_property_format: - :ref:`Format` **format** @@ -50,15 +50,15 @@ Property Descriptions Method Descriptions ------------------- -.. _class_AudioEffectRecord_get_recording: +.. _class_AudioEffectRecord_method_get_recording: - :ref:`AudioStreamSample` **get_recording** **(** **)** const -.. _class_AudioEffectRecord_is_recording_active: +.. _class_AudioEffectRecord_method_is_recording_active: - :ref:`bool` **is_recording_active** **(** **)** const -.. _class_AudioEffectRecord_set_recording_active: +.. _class_AudioEffectRecord_method_set_recording_active: - void **set_recording_active** **(** :ref:`bool` record **)** diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index 5db5f7091..6e424d261 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -21,23 +21,23 @@ Simulates the sound of acoustic environments such as rooms, concert halls, caver Properties ---------- -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`dry` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`hipass` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`predelay_feedback` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`predelay_msec` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`room_size` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`spread` | -+---------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`wet` | -+---------------------------+---------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dry` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`hipass` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`predelay_feedback` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`predelay_msec` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`room_size` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`spread` | ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`wet` | ++---------------------------+------------------------------------------------------------------------------+ Description ----------- @@ -47,7 +47,7 @@ Simulates rooms of different sizes. Its parameters can be adjusted to simulate t Property Descriptions --------------------- -.. _class_AudioEffectReverb_damping: +.. _class_AudioEffectReverb_property_damping: - :ref:`float` **damping** @@ -59,7 +59,7 @@ Property Descriptions Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``. -.. _class_AudioEffectReverb_dry: +.. _class_AudioEffectReverb_property_dry: - :ref:`float` **dry** @@ -71,7 +71,7 @@ Defines how reflective the imaginary room's walls are. Value can range from 0 to Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: ``1``. -.. _class_AudioEffectReverb_hipass: +.. _class_AudioEffectReverb_property_hipass: - :ref:`float` **hipass** @@ -83,7 +83,7 @@ Output percent of original sound. At 0, only modified sound is outputted. Value High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: ``0``. -.. _class_AudioEffectReverb_predelay_feedback: +.. _class_AudioEffectReverb_property_predelay_feedback: - :ref:`float` **predelay_feedback** @@ -95,7 +95,7 @@ High-pass filter passes signals with a frequency higher than a certain cutoff fr Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. -.. _class_AudioEffectReverb_predelay_msec: +.. _class_AudioEffectReverb_property_predelay_msec: - :ref:`float` **predelay_msec** @@ -107,7 +107,7 @@ Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. Time between the original signal and the early reflections of the reverb signal. Default value: ``150ms``. -.. _class_AudioEffectReverb_room_size: +.. _class_AudioEffectReverb_property_room_size: - :ref:`float` **room_size** @@ -119,7 +119,7 @@ Time between the original signal and the early reflections of the reverb signal. Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``. -.. _class_AudioEffectReverb_spread: +.. _class_AudioEffectReverb_property_spread: - :ref:`float` **spread** @@ -131,7 +131,7 @@ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 t Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: ``1``. -.. _class_AudioEffectReverb_wet: +.. _class_AudioEffectReverb_property_wet: - :ref:`float` **wet** diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index b5d67d4d7..5a55dc5b4 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -19,18 +19,18 @@ Brief Description Properties ---------- -+---------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pan_pullout` | -+---------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`surround` | -+---------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`time_pullout_ms` | -+---------------------------+------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pan_pullout` | ++---------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`surround` | ++---------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`time_pullout_ms` | ++---------------------------+---------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_AudioEffectStereoEnhance_pan_pullout: +.. _class_AudioEffectStereoEnhance_property_pan_pullout: - :ref:`float` **pan_pullout** @@ -40,7 +40,7 @@ Property Descriptions | *Getter* | get_pan_pullout() | +----------+------------------------+ -.. _class_AudioEffectStereoEnhance_surround: +.. _class_AudioEffectStereoEnhance_property_surround: - :ref:`float` **surround** @@ -50,7 +50,7 @@ Property Descriptions | *Getter* | get_surround() | +----------+---------------------+ -.. _class_AudioEffectStereoEnhance_time_pullout_ms: +.. _class_AudioEffectStereoEnhance_property_time_pullout_ms: - :ref:`float` **time_pullout_ms** diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 64b98ce20..fb2527e68 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -19,92 +19,92 @@ Server interface for low level audio access. Methods ------- -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus` **(** :ref:`int` at_position=-1 **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`capture_get_device` **(** **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`capture_get_device_list` **(** **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`capture_set_device` **(** :ref:`String` name **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_channels` **(** :ref:`int` bus_idx **)** const | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_count` **(** **)** const | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** 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_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** 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:`String` | :ref:`get_device` **(** **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_device_list` **(** **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpeakerMode` | :ref:`get_speaker_mode` **(** **)** 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_mute` **(** :ref:`int` bus_idx **)** const | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_bus` **(** :ref:`int` index **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`String` device **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus` **(** :ref:`int` at_position=-1 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`capture_get_device` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`capture_get_device_list` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`capture_set_device` **(** :ref:`String` name **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_channels` **(** :ref:`int` bus_idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_count` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** 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_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** 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:`String` | :ref:`get_device` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_device_list` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SpeakerMode` | :ref:`get_speaker_mode` **(** **)** 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_mute` **(** :ref:`int` bus_idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus` **(** :ref:`int` index **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_device` **(** :ref:`String` device **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AudioServer_bus_layout_changed: +.. _class_AudioServer_signal_bus_layout_changed: - **bus_layout_changed** **(** **)** @@ -115,6 +115,14 @@ Enumerations .. _enum_AudioServer_SpeakerMode: +.. _class_AudioServer_constant_SPEAKER_MODE_STEREO: + +.. _class_AudioServer_constant_SPEAKER_SURROUND_31: + +.. _class_AudioServer_constant_SPEAKER_SURROUND_51: + +.. _class_AudioServer_constant_SPEAKER_SURROUND_71: + enum **SpeakerMode**: - **SPEAKER_MODE_STEREO** = **0** --- Two or fewer speakers are detected. @@ -138,229 +146,229 @@ Tutorials Method Descriptions ------------------- -.. _class_AudioServer_add_bus: +.. _class_AudioServer_method_add_bus: - void **add_bus** **(** :ref:`int` at_position=-1 **)** Adds a bus at ``at_position``. -.. _class_AudioServer_add_bus_effect: +.. _class_AudioServer_method_add_bus_effect: - void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ``at_position``. -.. _class_AudioServer_capture_get_device: +.. _class_AudioServer_method_capture_get_device: - :ref:`String` **capture_get_device** **(** **)** -.. _class_AudioServer_capture_get_device_list: +.. _class_AudioServer_method_capture_get_device_list: - :ref:`Array` **capture_get_device_list** **(** **)** -.. _class_AudioServer_capture_set_device: +.. _class_AudioServer_method_capture_set_device: - void **capture_set_device** **(** :ref:`String` name **)** -.. _class_AudioServer_generate_bus_layout: +.. _class_AudioServer_method_generate_bus_layout: - :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const Generates an :ref:`AudioBusLayout` using the available busses and effects. -.. _class_AudioServer_get_bus_channels: +.. _class_AudioServer_method_get_bus_channels: - :ref:`int` **get_bus_channels** **(** :ref:`int` bus_idx **)** const Returns the amount of channels of the bus at index ``bus_idx``. -.. _class_AudioServer_get_bus_count: +.. _class_AudioServer_method_get_bus_count: - :ref:`int` **get_bus_count** **(** **)** const Returns the number of available busses. -.. _class_AudioServer_get_bus_effect: +.. _class_AudioServer_method_get_bus_effect: - :ref:`AudioEffect` **get_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** Returns the :ref:`AudioEffect` at position ``effect_idx`` in bus ``bus_idx``. -.. _class_AudioServer_get_bus_effect_count: +.. _class_AudioServer_method_get_bus_effect_count: - :ref:`int` **get_bus_effect_count** **(** :ref:`int` bus_idx **)** Returns the number of effects on the bus at ``bus_idx``. -.. _class_AudioServer_get_bus_index: +.. _class_AudioServer_method_get_bus_index: - :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const Returns the index of the bus with the name ``bus_name``. -.. _class_AudioServer_get_bus_name: +.. _class_AudioServer_method_get_bus_name: - :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const Returns the name of the bus with the index ``bus_idx``. -.. _class_AudioServer_get_bus_peak_volume_left_db: +.. _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 Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``. -.. _class_AudioServer_get_bus_peak_volume_right_db: +.. _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 Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``. -.. _class_AudioServer_get_bus_send: +.. _class_AudioServer_method_get_bus_send: - :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. -.. _class_AudioServer_get_bus_volume_db: +.. _class_AudioServer_method_get_bus_volume_db: - :ref:`float` **get_bus_volume_db** **(** :ref:`int` bus_idx **)** const Returns the volume of the bus at index ``bus_idx`` in dB. -.. _class_AudioServer_get_device: +.. _class_AudioServer_method_get_device: - :ref:`String` **get_device** **(** **)** -.. _class_AudioServer_get_device_list: +.. _class_AudioServer_method_get_device_list: - :ref:`Array` **get_device_list** **(** **)** -.. _class_AudioServer_get_mix_rate: +.. _class_AudioServer_method_get_mix_rate: - :ref:`float` **get_mix_rate** **(** **)** const Returns the sample rate at the output of the audioserver. -.. _class_AudioServer_get_speaker_mode: +.. _class_AudioServer_method_get_speaker_mode: - :ref:`SpeakerMode` **get_speaker_mode** **(** **)** const Returns the speaker configuration. -.. _class_AudioServer_is_bus_bypassing_effects: +.. _class_AudioServer_method_is_bus_bypassing_effects: - :ref:`bool` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** const If ``true``, the bus at index ``bus_idx`` is bypassing effects. -.. _class_AudioServer_is_bus_effect_enabled: +.. _class_AudioServer_method_is_bus_effect_enabled: - :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. -.. _class_AudioServer_is_bus_mute: +.. _class_AudioServer_method_is_bus_mute: - :ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** const If ``true``, the bus at index ``bus_idx`` is muted. -.. _class_AudioServer_is_bus_solo: +.. _class_AudioServer_method_is_bus_solo: - :ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** const If ``true``, the bus at index ``bus_idx`` is in solo mode. -.. _class_AudioServer_lock: +.. _class_AudioServer_method_lock: - void **lock** **(** **)** Locks the audio drivers mainloop. Remember to unlock it afterwards. -.. _class_AudioServer_move_bus: +.. _class_AudioServer_method_move_bus: - void **move_bus** **(** :ref:`int` index, :ref:`int` to_index **)** Moves the bus from index ``index`` to index ``to_index``. -.. _class_AudioServer_remove_bus: +.. _class_AudioServer_method_remove_bus: - void **remove_bus** **(** :ref:`int` index **)** Removes the bus at index ``index``. -.. _class_AudioServer_remove_bus_effect: +.. _class_AudioServer_method_remove_bus_effect: - void **remove_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``. -.. _class_AudioServer_set_bus_bypass_effects: +.. _class_AudioServer_method_set_bus_bypass_effects: - void **set_bus_bypass_effects** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true``, the bus at index ``bus_idx`` is bypassing effects. -.. _class_AudioServer_set_bus_count: +.. _class_AudioServer_method_set_bus_count: - void **set_bus_count** **(** :ref:`int` amount **)** Adds and removes busses to make the number of busses match ``amount``. -.. _class_AudioServer_set_bus_effect_enabled: +.. _class_AudioServer_method_set_bus_effect_enabled: - void **set_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. -.. _class_AudioServer_set_bus_layout: +.. _class_AudioServer_method_set_bus_layout: - void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** Overwrites the currently used :ref:`AudioBusLayout`. -.. _class_AudioServer_set_bus_mute: +.. _class_AudioServer_method_set_bus_mute: - void **set_bus_mute** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true``, the bus at index ``bus_idx`` is muted. -.. _class_AudioServer_set_bus_name: +.. _class_AudioServer_method_set_bus_name: - void **set_bus_name** **(** :ref:`int` bus_idx, :ref:`String` name **)** Sets the name of the bus at index ``bus_idx`` to ``name``. -.. _class_AudioServer_set_bus_send: +.. _class_AudioServer_method_set_bus_send: - void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`String` send **)** Connects the output of the bus at ``bus_idx`` to the bus named ``send``. -.. _class_AudioServer_set_bus_solo: +.. _class_AudioServer_method_set_bus_solo: - void **set_bus_solo** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true``, the bus at index ``bus_idx`` is in solo mode. -.. _class_AudioServer_set_bus_volume_db: +.. _class_AudioServer_method_set_bus_volume_db: - void **set_bus_volume_db** **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. -.. _class_AudioServer_set_device: +.. _class_AudioServer_method_set_device: - void **set_device** **(** :ref:`String` device **)** -.. _class_AudioServer_swap_bus_effects: +.. _class_AudioServer_method_swap_bus_effects: - void **swap_bus_effects** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** Swaps the position of two effects in bus ``bus_idx``. -.. _class_AudioServer_unlock: +.. _class_AudioServer_method_unlock: - void **unlock** **(** **)** diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index babb1e179..3345a3622 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -21,9 +21,9 @@ Base class for audio streams. Methods ------- -+----------------------------+-------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+----------------------------+-------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** const | ++---------------------------+--------------------------------------------------------------------------+ Description ----------- @@ -38,7 +38,7 @@ Tutorials Method Descriptions ------------------- -.. _class_AudioStream_get_length: +.. _class_AudioStream_method_get_length: - :ref:`float` **get_length** **(** **)** const diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index ea81f0657..11a04e996 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -19,13 +19,13 @@ OGG Vorbis audio stream driver. Properties ---------- -+-------------------------------------------+------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`data` | -+-------------------------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`loop` | -+-------------------------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`loop_offset` | -+-------------------------------------------+------------------------------------------------------------+ ++-------------------------------------------+---------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`data` | ++-------------------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`loop` | ++-------------------------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`loop_offset` | ++-------------------------------------------+---------------------------------------------------------------------+ Description ----------- @@ -35,7 +35,7 @@ OGG Vorbis audio stream driver. Property Descriptions --------------------- -.. _class_AudioStreamOGGVorbis_data: +.. _class_AudioStreamOGGVorbis_property_data: - :ref:`PoolByteArray` **data** @@ -47,7 +47,7 @@ Property Descriptions Contains the audio data in bytes. -.. _class_AudioStreamOGGVorbis_loop: +.. _class_AudioStreamOGGVorbis_property_loop: - :ref:`bool` **loop** @@ -57,7 +57,7 @@ Contains the audio data in bytes. | *Getter* | has_loop() | +----------+-----------------+ -.. _class_AudioStreamOGGVorbis_loop_offset: +.. _class_AudioStreamOGGVorbis_property_loop_offset: - :ref:`float` **loop_offset** diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 4a2123676..94a8ed3a1 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -19,41 +19,41 @@ Plays back audio. Properties ---------- -+----------------------------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`autoplay` | -+----------------------------------------------------+-------------------------------------------------------------+ -| :ref:`String` | :ref:`bus` | -+----------------------------------------------------+-------------------------------------------------------------+ -| :ref:`MixTarget` | :ref:`mix_target` | -+----------------------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`pitch_scale` | -+----------------------------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+----------------------------------------------------+-------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`stream` | -+----------------------------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`stream_paused` | -+----------------------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`volume_db` | -+----------------------------------------------------+-------------------------------------------------------------+ ++----------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`autoplay` | ++----------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`String` | :ref:`bus` | ++----------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`MixTarget` | :ref:`mix_target` | ++----------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`pitch_scale` | ++----------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`playing` | ++----------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`stream` | ++----------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stream_paused` | ++----------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`volume_db` | ++----------------------------------------------------+----------------------------------------------------------------------+ Methods ------- -+----------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AudioStreamPlayer_finished: +.. _class_AudioStreamPlayer_signal_finished: - **finished** **(** **)** @@ -64,6 +64,12 @@ Enumerations .. _enum_AudioStreamPlayer_MixTarget: +.. _class_AudioStreamPlayer_constant_MIX_TARGET_STEREO: + +.. _class_AudioStreamPlayer_constant_MIX_TARGET_SURROUND: + +.. _class_AudioStreamPlayer_constant_MIX_TARGET_CENTER: + enum **MixTarget**: - **MIX_TARGET_STEREO** = **0** --- The audio will be played only on the first channel. @@ -87,7 +93,7 @@ Tutorials Property Descriptions --------------------- -.. _class_AudioStreamPlayer_autoplay: +.. _class_AudioStreamPlayer_property_autoplay: - :ref:`bool` **autoplay** @@ -99,7 +105,7 @@ Property Descriptions If ``true``, audio plays when added to scene tree. Default value: ``false``. -.. _class_AudioStreamPlayer_bus: +.. _class_AudioStreamPlayer_property_bus: - :ref:`String` **bus** @@ -111,7 +117,7 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``. Bus on which this audio is playing. -.. _class_AudioStreamPlayer_mix_target: +.. _class_AudioStreamPlayer_property_mix_target: - :ref:`MixTarget` **mix_target** @@ -123,7 +129,7 @@ Bus on which this audio is playing. If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants. -.. _class_AudioStreamPlayer_pitch_scale: +.. _class_AudioStreamPlayer_property_pitch_scale: - :ref:`float` **pitch_scale** @@ -135,7 +141,7 @@ If the audio configuration has more than two speakers, this sets the target chan Changes the pitch and the tempo of the audio. -.. _class_AudioStreamPlayer_playing: +.. _class_AudioStreamPlayer_property_playing: - :ref:`bool` **playing** @@ -145,7 +151,7 @@ Changes the pitch and the tempo of the audio. If ``true``, audio is playing. -.. _class_AudioStreamPlayer_stream: +.. _class_AudioStreamPlayer_property_stream: - :ref:`AudioStream` **stream** @@ -157,7 +163,7 @@ If ``true``, audio is playing. The :ref:`AudioStream` object to be played. -.. _class_AudioStreamPlayer_stream_paused: +.. _class_AudioStreamPlayer_property_stream_paused: - :ref:`bool` **stream_paused** @@ -167,7 +173,7 @@ The :ref:`AudioStream` object to be played. | *Getter* | get_stream_paused() | +----------+--------------------------+ -.. _class_AudioStreamPlayer_volume_db: +.. _class_AudioStreamPlayer_property_volume_db: - :ref:`float` **volume_db** @@ -182,25 +188,25 @@ Volume of sound, in dB. Method Descriptions ------------------- -.. _class_AudioStreamPlayer_get_playback_position: +.. _class_AudioStreamPlayer_method_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream` in seconds. -.. _class_AudioStreamPlayer_play: +.. _class_AudioStreamPlayer_method_play: - void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. -.. _class_AudioStreamPlayer_seek: +.. _class_AudioStreamPlayer_method_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. -.. _class_AudioStreamPlayer_stop: +.. _class_AudioStreamPlayer_method_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index ac3f5c916..27ff56b95 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -19,45 +19,45 @@ Plays audio in 2D. Properties ---------- -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`area_mask` | -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`attenuation` | -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`autoplay` | -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`bus` | -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`max_distance` | -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`pitch_scale` | -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`stream` | -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`stream_paused` | -+---------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`volume_db` | -+---------------------------------------+---------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_mask` | ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`attenuation` | ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`autoplay` | ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`bus` | ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max_distance` | ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pitch_scale` | ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`playing` | ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`stream` | ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stream_paused` | ++---------------------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`volume_db` | ++---------------------------------------+------------------------------------------------------------------------+ Methods ------- -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AudioStreamPlayer2D_finished: +.. _class_AudioStreamPlayer2D_signal_finished: - **finished** **(** **)** @@ -78,7 +78,7 @@ Tutorials Property Descriptions --------------------- -.. _class_AudioStreamPlayer2D_area_mask: +.. _class_AudioStreamPlayer2D_property_area_mask: - :ref:`int` **area_mask** @@ -90,7 +90,7 @@ Property Descriptions Areas in which this sound plays. -.. _class_AudioStreamPlayer2D_attenuation: +.. _class_AudioStreamPlayer2D_property_attenuation: - :ref:`float` **attenuation** @@ -102,7 +102,7 @@ Areas in which this sound plays. Dampens audio over distance with this as an exponent. -.. _class_AudioStreamPlayer2D_autoplay: +.. _class_AudioStreamPlayer2D_property_autoplay: - :ref:`bool` **autoplay** @@ -114,7 +114,7 @@ Dampens audio over distance with this as an exponent. If ``true``, audio plays when added to scene tree. Default value: ``false``. -.. _class_AudioStreamPlayer2D_bus: +.. _class_AudioStreamPlayer2D_property_bus: - :ref:`String` **bus** @@ -126,7 +126,7 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``. Bus on which this audio is playing. -.. _class_AudioStreamPlayer2D_max_distance: +.. _class_AudioStreamPlayer2D_property_max_distance: - :ref:`float` **max_distance** @@ -138,7 +138,7 @@ Bus on which this audio is playing. Maximum distance from which audio is still hearable. -.. _class_AudioStreamPlayer2D_pitch_scale: +.. _class_AudioStreamPlayer2D_property_pitch_scale: - :ref:`float` **pitch_scale** @@ -150,7 +150,7 @@ Maximum distance from which audio is still hearable. Changes the pitch and the tempo of the audio. -.. _class_AudioStreamPlayer2D_playing: +.. _class_AudioStreamPlayer2D_property_playing: - :ref:`bool` **playing** @@ -160,7 +160,7 @@ Changes the pitch and the tempo of the audio. If ``true``, audio is playing. -.. _class_AudioStreamPlayer2D_stream: +.. _class_AudioStreamPlayer2D_property_stream: - :ref:`AudioStream` **stream** @@ -172,7 +172,7 @@ If ``true``, audio is playing. The :ref:`AudioStream` object to be played. -.. _class_AudioStreamPlayer2D_stream_paused: +.. _class_AudioStreamPlayer2D_property_stream_paused: - :ref:`bool` **stream_paused** @@ -182,7 +182,7 @@ The :ref:`AudioStream` object to be played. | *Getter* | get_stream_paused() | +----------+--------------------------+ -.. _class_AudioStreamPlayer2D_volume_db: +.. _class_AudioStreamPlayer2D_property_volume_db: - :ref:`float` **volume_db** @@ -197,25 +197,25 @@ Base volume without dampening. Method Descriptions ------------------- -.. _class_AudioStreamPlayer2D_get_playback_position: +.. _class_AudioStreamPlayer2D_method_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. -.. _class_AudioStreamPlayer2D_play: +.. _class_AudioStreamPlayer2D_method_play: - void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. -.. _class_AudioStreamPlayer2D_seek: +.. _class_AudioStreamPlayer2D_method_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. -.. _class_AudioStreamPlayer2D_stop: +.. _class_AudioStreamPlayer2D_method_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index dd2ed387e..36bc1b2df 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -19,63 +19,63 @@ Plays 3D sound in 3D space. Properties ---------- -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_mask` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`attenuation_filter_cutoff_hz` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`attenuation_filter_db` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`AttenuationModel` | :ref:`attenuation_model` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`autoplay` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`bus` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`DopplerTracking` | :ref:`doppler_tracking` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_angle_degrees` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emission_angle_enabled` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_angle_filter_attenuation_db` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max_db` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max_distance` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`OutOfRangeMode` | :ref:`out_of_range_mode` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pitch_scale` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`playing` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`stream` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stream_paused` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`unit_db` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`unit_size` | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_mask` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`attenuation_filter_cutoff_hz` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`attenuation_filter_db` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`AttenuationModel` | :ref:`attenuation_model` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`autoplay` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`bus` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`DopplerTracking` | :ref:`doppler_tracking` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`emission_angle_degrees` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`emission_angle_enabled` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`emission_angle_filter_attenuation_db` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max_db` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max_distance` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`OutOfRangeMode` | :ref:`out_of_range_mode` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pitch_scale` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`playing` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`stream` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stream_paused` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`unit_db` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`unit_size` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ Methods ------- -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_AudioStreamPlayer3D_finished: +.. _class_AudioStreamPlayer3D_signal_finished: - **finished** **(** **)** @@ -86,6 +86,12 @@ Enumerations .. _enum_AudioStreamPlayer3D_AttenuationModel: +.. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_DISTANCE: + +.. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_SQUARE_DISTANCE: + +.. _class_AudioStreamPlayer3D_constant_ATTENUATION_LOGARITHMIC: + enum **AttenuationModel**: - **ATTENUATION_INVERSE_DISTANCE** = **0** --- Linear dampening of loudness according to distance. @@ -96,6 +102,10 @@ enum **AttenuationModel**: .. _enum_AudioStreamPlayer3D_OutOfRangeMode: +.. _class_AudioStreamPlayer3D_constant_OUT_OF_RANGE_MIX: + +.. _class_AudioStreamPlayer3D_constant_OUT_OF_RANGE_PAUSE: + enum **OutOfRangeMode**: - **OUT_OF_RANGE_MIX** = **0** --- Mix this audio in, even when it's out of range. @@ -104,6 +114,12 @@ enum **OutOfRangeMode**: .. _enum_AudioStreamPlayer3D_DopplerTracking: +.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_DISABLED: + +.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_IDLE_STEP: + +.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_PHYSICS_STEP: + enum **DopplerTracking**: - **DOPPLER_TRACKING_DISABLED** = **0** --- Disables doppler tracking. @@ -127,7 +143,7 @@ Tutorials Property Descriptions --------------------- -.. _class_AudioStreamPlayer3D_area_mask: +.. _class_AudioStreamPlayer3D_property_area_mask: - :ref:`int` **area_mask** @@ -139,7 +155,7 @@ Property Descriptions Areas in which this sound plays. -.. _class_AudioStreamPlayer3D_attenuation_filter_cutoff_hz: +.. _class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz: - :ref:`float` **attenuation_filter_cutoff_hz** @@ -151,7 +167,7 @@ Areas in which this sound plays. Dampens audio above this frequency, in Hz. -.. _class_AudioStreamPlayer3D_attenuation_filter_db: +.. _class_AudioStreamPlayer3D_property_attenuation_filter_db: - :ref:`float` **attenuation_filter_db** @@ -163,7 +179,7 @@ Dampens audio above this frequency, in Hz. Amount how much the filter affects the loudness, in dB. -.. _class_AudioStreamPlayer3D_attenuation_model: +.. _class_AudioStreamPlayer3D_property_attenuation_model: - :ref:`AttenuationModel` **attenuation_model** @@ -175,7 +191,7 @@ Amount how much the filter affects the loudness, in dB. Decides if audio should get quieter with distance linearly, quadratically or logarithmically. -.. _class_AudioStreamPlayer3D_autoplay: +.. _class_AudioStreamPlayer3D_property_autoplay: - :ref:`bool` **autoplay** @@ -187,7 +203,7 @@ Decides if audio should get quieter with distance linearly, quadratically or log If ``true``, audio plays when added to scene tree. Default value: ``false``. -.. _class_AudioStreamPlayer3D_bus: +.. _class_AudioStreamPlayer3D_property_bus: - :ref:`String` **bus** @@ -199,7 +215,7 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``. Bus on which this audio is playing. -.. _class_AudioStreamPlayer3D_doppler_tracking: +.. _class_AudioStreamPlayer3D_property_doppler_tracking: - :ref:`DopplerTracking` **doppler_tracking** @@ -211,7 +227,7 @@ Bus on which this audio is playing. Decides in which step the Doppler effect should be calculated. -.. _class_AudioStreamPlayer3D_emission_angle_degrees: +.. _class_AudioStreamPlayer3D_property_emission_angle_degrees: - :ref:`float` **emission_angle_degrees** @@ -223,7 +239,7 @@ Decides in which step the Doppler effect should be calculated. The angle in which the audio reaches cameras undampened. -.. _class_AudioStreamPlayer3D_emission_angle_enabled: +.. _class_AudioStreamPlayer3D_property_emission_angle_enabled: - :ref:`bool` **emission_angle_enabled** @@ -235,7 +251,7 @@ The angle in which the audio reaches cameras undampened. If ``true``, the audio should be dampened according to the direction of the sound. -.. _class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db: +.. _class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db: - :ref:`float` **emission_angle_filter_attenuation_db** @@ -247,7 +263,7 @@ If ``true``, the audio should be dampened according to the direction of the soun dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. -.. _class_AudioStreamPlayer3D_max_db: +.. _class_AudioStreamPlayer3D_property_max_db: - :ref:`float` **max_db** @@ -259,7 +275,7 @@ dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_ang Sets the absolute maximum of the soundlevel, in dB. -.. _class_AudioStreamPlayer3D_max_distance: +.. _class_AudioStreamPlayer3D_property_max_distance: - :ref:`float` **max_distance** @@ -271,7 +287,7 @@ Sets the absolute maximum of the soundlevel, in dB. Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. -.. _class_AudioStreamPlayer3D_out_of_range_mode: +.. _class_AudioStreamPlayer3D_property_out_of_range_mode: - :ref:`OutOfRangeMode` **out_of_range_mode** @@ -283,7 +299,7 @@ Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect Decides if audio should pause when source is outside of 'max_distance' range. -.. _class_AudioStreamPlayer3D_pitch_scale: +.. _class_AudioStreamPlayer3D_property_pitch_scale: - :ref:`float` **pitch_scale** @@ -295,7 +311,7 @@ Decides if audio should pause when source is outside of 'max_distance' range. Changes the pitch and the tempo of the audio. -.. _class_AudioStreamPlayer3D_playing: +.. _class_AudioStreamPlayer3D_property_playing: - :ref:`bool` **playing** @@ -305,7 +321,7 @@ Changes the pitch and the tempo of the audio. If ``true``, audio is playing. -.. _class_AudioStreamPlayer3D_stream: +.. _class_AudioStreamPlayer3D_property_stream: - :ref:`AudioStream` **stream** @@ -317,7 +333,7 @@ If ``true``, audio is playing. The :ref:`AudioStream` object to be played. -.. _class_AudioStreamPlayer3D_stream_paused: +.. _class_AudioStreamPlayer3D_property_stream_paused: - :ref:`bool` **stream_paused** @@ -327,7 +343,7 @@ The :ref:`AudioStream` object to be played. | *Getter* | get_stream_paused() | +----------+--------------------------+ -.. _class_AudioStreamPlayer3D_unit_db: +.. _class_AudioStreamPlayer3D_property_unit_db: - :ref:`float` **unit_db** @@ -339,7 +355,7 @@ The :ref:`AudioStream` object to be played. Base sound level unaffected by dampening, in dB. -.. _class_AudioStreamPlayer3D_unit_size: +.. _class_AudioStreamPlayer3D_property_unit_size: - :ref:`float` **unit_size** @@ -354,25 +370,25 @@ Factor for the attenuation effect. Method Descriptions ------------------- -.. _class_AudioStreamPlayer3D_get_playback_position: +.. _class_AudioStreamPlayer3D_method_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. -.. _class_AudioStreamPlayer3D_play: +.. _class_AudioStreamPlayer3D_method_play: - void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. -.. _class_AudioStreamPlayer3D_seek: +.. _class_AudioStreamPlayer3D_method_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. -.. _class_AudioStreamPlayer3D_stop: +.. _class_AudioStreamPlayer3D_method_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index be4a4fcde..c614441a6 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -19,11 +19,11 @@ Plays audio with random pitch tweaking. Properties ---------- -+---------------------------------------+----------------------------------------------------------------+ -| :ref:`AudioStream` | :ref:`audio_stream` | -+---------------------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`random_pitch` | -+---------------------------------------+----------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`audio_stream` | ++---------------------------------------+-------------------------------------------------------------------------+ +| :ref:`float` | :ref:`random_pitch` | ++---------------------------------------+-------------------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Randomly varies pitch on each start. Property Descriptions --------------------- -.. _class_AudioStreamRandomPitch_audio_stream: +.. _class_AudioStreamRandomPitch_property_audio_stream: - :ref:`AudioStream` **audio_stream** @@ -45,7 +45,7 @@ Property Descriptions The current :ref:`AudioStream`. -.. _class_AudioStreamRandomPitch_random_pitch: +.. _class_AudioStreamRandomPitch_property_random_pitch: - :ref:`float` **random_pitch** diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 712fa5dfe..10a002165 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -19,34 +19,40 @@ Plays audio. Properties ---------- -+--------------------------------------------------+-------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`data` | -+--------------------------------------------------+-------------------------------------------------------+ -| :ref:`Format` | :ref:`format` | -+--------------------------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`loop_begin` | -+--------------------------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`loop_end` | -+--------------------------------------------------+-------------------------------------------------------+ -| :ref:`LoopMode` | :ref:`loop_mode` | -+--------------------------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`mix_rate` | -+--------------------------------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`stereo` | -+--------------------------------------------------+-------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`data` | ++--------------------------------------------------+----------------------------------------------------------------+ +| :ref:`Format` | :ref:`format` | ++--------------------------------------------------+----------------------------------------------------------------+ +| :ref:`int` | :ref:`loop_begin` | ++--------------------------------------------------+----------------------------------------------------------------+ +| :ref:`int` | :ref:`loop_end` | ++--------------------------------------------------+----------------------------------------------------------------+ +| :ref:`LoopMode` | :ref:`loop_mode` | ++--------------------------------------------------+----------------------------------------------------------------+ +| :ref:`int` | :ref:`mix_rate` | ++--------------------------------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`stereo` | ++--------------------------------------------------+----------------------------------------------------------------+ Methods ------- -+-------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_to_wav` **(** :ref:`String` path **)** | -+-------+------------------------------------------------------------------------------------------------------+ ++------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_to_wav` **(** :ref:`String` path **)** | ++------+-------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_AudioStreamSample_Format: +.. _class_AudioStreamSample_constant_FORMAT_8_BITS: + +.. _class_AudioStreamSample_constant_FORMAT_16_BITS: + +.. _class_AudioStreamSample_constant_FORMAT_IMA_ADPCM: + enum **Format**: - **FORMAT_8_BITS** = **0** --- Audio codec 8 bit. @@ -57,6 +63,14 @@ enum **Format**: .. _enum_AudioStreamSample_LoopMode: +.. _class_AudioStreamSample_constant_LOOP_DISABLED: + +.. _class_AudioStreamSample_constant_LOOP_FORWARD: + +.. _class_AudioStreamSample_constant_LOOP_PING_PONG: + +.. _class_AudioStreamSample_constant_LOOP_BACKWARD: + enum **LoopMode**: - **LOOP_DISABLED** = **0** --- Audio does not loop. @@ -75,7 +89,7 @@ Plays audio, can loop. Property Descriptions --------------------- -.. _class_AudioStreamSample_data: +.. _class_AudioStreamSample_property_data: - :ref:`PoolByteArray` **data** @@ -87,7 +101,7 @@ Property Descriptions Contains the audio data in bytes. -.. _class_AudioStreamSample_format: +.. _class_AudioStreamSample_property_format: - :ref:`Format` **format** @@ -99,7 +113,7 @@ Contains the audio data in bytes. Audio format. See FORMAT\_\* constants for values. -.. _class_AudioStreamSample_loop_begin: +.. _class_AudioStreamSample_property_loop_begin: - :ref:`int` **loop_begin** @@ -111,7 +125,7 @@ Audio format. See FORMAT\_\* constants for values. Loop start in bytes. -.. _class_AudioStreamSample_loop_end: +.. _class_AudioStreamSample_property_loop_end: - :ref:`int` **loop_end** @@ -123,7 +137,7 @@ Loop start in bytes. Loop end in bytes. -.. _class_AudioStreamSample_loop_mode: +.. _class_AudioStreamSample_property_loop_mode: - :ref:`LoopMode` **loop_mode** @@ -135,7 +149,7 @@ Loop end in bytes. Loop mode. See LOOP\_\* constants for values. -.. _class_AudioStreamSample_mix_rate: +.. _class_AudioStreamSample_property_mix_rate: - :ref:`int` **mix_rate** @@ -147,7 +161,7 @@ Loop mode. See LOOP\_\* constants for values. The sample rate for mixing this audio. -.. _class_AudioStreamSample_stereo: +.. _class_AudioStreamSample_property_stereo: - :ref:`bool` **stereo** @@ -162,7 +176,7 @@ If ``true``, audio is stereo. Default value: ``false``. Method Descriptions ------------------- -.. _class_AudioStreamSample_save_to_wav: +.. _class_AudioStreamSample_method_save_to_wav: - void **save_to_wav** **(** :ref:`String` path **)** diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 2f73220ff..0d831a2ff 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -19,17 +19,23 @@ Copies a region of the screen (or the whole screen) to a buffer so it can be acc Properties ---------- -+-----------------------------------------------+--------------------------------------------------+ -| :ref:`CopyMode` | :ref:`copy_mode` | -+-----------------------------------------------+--------------------------------------------------+ -| :ref:`Rect2` | :ref:`rect` | -+-----------------------------------------------+--------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------+ +| :ref:`CopyMode` | :ref:`copy_mode` | ++-----------------------------------------------+-----------------------------------------------------------+ +| :ref:`Rect2` | :ref:`rect` | ++-----------------------------------------------+-----------------------------------------------------------+ Enumerations ------------ .. _enum_BackBufferCopy_CopyMode: +.. _class_BackBufferCopy_constant_COPY_MODE_DISABLED: + +.. _class_BackBufferCopy_constant_COPY_MODE_RECT: + +.. _class_BackBufferCopy_constant_COPY_MODE_VIEWPORT: + enum **CopyMode**: - **COPY_MODE_DISABLED** = **0** --- Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers. @@ -46,7 +52,7 @@ Node for back-buffering the currently displayed screen. The region defined in th Property Descriptions --------------------- -.. _class_BackBufferCopy_copy_mode: +.. _class_BackBufferCopy_property_copy_mode: - :ref:`CopyMode` **copy_mode** @@ -58,7 +64,7 @@ Property Descriptions Buffer mode. See ``COPY_MODE_*`` constants. -.. _class_BackBufferCopy_rect: +.. _class_BackBufferCopy_property_rect: - :ref:`Rect2` **rect** diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index 1d0b78391..ef61c4924 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -19,42 +19,48 @@ Prerendered indirect light map for a scene. Properties ---------- -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`bake_cell_size` | -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`bake_energy` | -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`bake_extents` | -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`bake_hdr` | -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`BakeMode` | :ref:`bake_mode` | -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`bake_propagation` | -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`BakeQuality` | :ref:`bake_quality` | -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`capture_cell_size` | -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`String` | :ref:`image_path` | -+----------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`BakedLightmapData` | :ref:`light_data` | -+----------------------------------------------------+-----------------------------------------------------------------+ ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bake_cell_size` | ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bake_energy` | ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`bake_extents` | ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`bake_hdr` | ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`BakeMode` | :ref:`bake_mode` | ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bake_propagation` | ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`BakeQuality` | :ref:`bake_quality` | ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`capture_cell_size` | ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`String` | :ref:`image_path` | ++----------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`BakedLightmapData` | :ref:`light_data` | ++----------------------------------------------------+--------------------------------------------------------------------------+ Methods ------- -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BakeError` | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`debug_bake` **(** **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BakeError` | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`debug_bake` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_BakedLightmap_BakeQuality: +.. _class_BakedLightmap_constant_BAKE_QUALITY_LOW: + +.. _class_BakedLightmap_constant_BAKE_QUALITY_MEDIUM: + +.. _class_BakedLightmap_constant_BAKE_QUALITY_HIGH: + enum **BakeQuality**: - **BAKE_QUALITY_LOW** = **0** --- Lowest bake quality mode. Fastest to calculate. @@ -65,6 +71,10 @@ enum **BakeQuality**: .. _enum_BakedLightmap_BakeMode: +.. _class_BakedLightmap_constant_BAKE_MODE_CONE_TRACE: + +.. _class_BakedLightmap_constant_BAKE_MODE_RAY_TRACE: + enum **BakeMode**: - **BAKE_MODE_CONE_TRACE** = **0** --- Less precise but faster bake mode. @@ -73,6 +83,16 @@ enum **BakeMode**: .. _enum_BakedLightmap_BakeError: +.. _class_BakedLightmap_constant_BAKE_ERROR_OK: + +.. _class_BakedLightmap_constant_BAKE_ERROR_NO_SAVE_PATH: + +.. _class_BakedLightmap_constant_BAKE_ERROR_NO_MESHES: + +.. _class_BakedLightmap_constant_BAKE_ERROR_CANT_CREATE_IMAGE: + +.. _class_BakedLightmap_constant_BAKE_ERROR_USER_ABORTED: + enum **BakeError**: - **BAKE_ERROR_OK** = **0** @@ -98,7 +118,7 @@ Tutorials Property Descriptions --------------------- -.. _class_BakedLightmap_bake_cell_size: +.. _class_BakedLightmap_property_bake_cell_size: - :ref:`float` **bake_cell_size** @@ -110,7 +130,7 @@ Property Descriptions Grid subdivision size for lightmapper calculation. Default value of ``0.25`` will work for most cases. Increase for better lighting on small details or if your scene is very large. -.. _class_BakedLightmap_bake_energy: +.. _class_BakedLightmap_property_bake_energy: - :ref:`float` **bake_energy** @@ -120,7 +140,7 @@ Grid subdivision size for lightmapper calculation. Default value of ``0.25`` wil | *Getter* | get_energy() | +----------+-------------------+ -.. _class_BakedLightmap_bake_extents: +.. _class_BakedLightmap_property_bake_extents: - :ref:`Vector3` **bake_extents** @@ -132,7 +152,7 @@ Grid subdivision size for lightmapper calculation. Default value of ``0.25`` wil Size of affected area. -.. _class_BakedLightmap_bake_hdr: +.. _class_BakedLightmap_property_bake_hdr: - :ref:`bool` **bake_hdr** @@ -144,7 +164,7 @@ Size of affected area. If ``true``, lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``. -.. _class_BakedLightmap_bake_mode: +.. _class_BakedLightmap_property_bake_mode: - :ref:`BakeMode` **bake_mode** @@ -154,9 +174,9 @@ If ``true``, lightmap can capture light values greater than ``1.0``. Turning thi | *Getter* | get_bake_mode() | +----------+----------------------+ -Lightmapping mode. See :ref:`BakeMode`. +Lightmapping mode. See :ref:`BakeMode`. -.. _class_BakedLightmap_bake_propagation: +.. _class_BakedLightmap_property_bake_propagation: - :ref:`float` **bake_propagation** @@ -166,7 +186,7 @@ Lightmapping mode. See :ref:`BakeMode`. | *Getter* | get_propagation() | +----------+------------------------+ -.. _class_BakedLightmap_bake_quality: +.. _class_BakedLightmap_property_bake_quality: - :ref:`BakeQuality` **bake_quality** @@ -176,9 +196,9 @@ Lightmapping mode. See :ref:`BakeMode`. | *Getter* | get_bake_quality() | +----------+-------------------------+ -Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. +Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. -.. _class_BakedLightmap_capture_cell_size: +.. _class_BakedLightmap_property_capture_cell_size: - :ref:`float` **capture_cell_size** @@ -188,9 +208,9 @@ Three quality modes are available. Higher quality requires more rendering time. | *Getter* | get_capture_cell_size() | +----------+------------------------------+ -Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size`. +Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size`. -.. _class_BakedLightmap_image_path: +.. _class_BakedLightmap_property_image_path: - :ref:`String` **image_path** @@ -202,7 +222,7 @@ Grid size used for real-time capture information on dynamic objects. Cannot be l Location where lightmaps will be saved. -.. _class_BakedLightmap_light_data: +.. _class_BakedLightmap_property_light_data: - :ref:`BakedLightmapData` **light_data** @@ -217,11 +237,11 @@ The calculated light data. Method Descriptions ------------------- -.. _class_BakedLightmap_bake: +.. _class_BakedLightmap_method_bake: - :ref:`BakeError` **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** -.. _class_BakedLightmap_debug_bake: +.. _class_BakedLightmap_method_debug_bake: - void **debug_bake** **(** **)** diff --git a/classes/class_bakedlightmapdata.rst b/classes/class_bakedlightmapdata.rst index f73d3db6b..70c8bdd66 100644 --- a/classes/class_bakedlightmapdata.rst +++ b/classes/class_bakedlightmapdata.rst @@ -19,37 +19,37 @@ Brief Description Properties ---------- -+-------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`bounds` | -+-------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`cell_space_transform` | -+-------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cell_subdiv` | -+-------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`energy` | -+-------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`octree` | -+-------------------------------------------+---------------------------------------------------------------------------+ ++-------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`bounds` | ++-------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`cell_space_transform` | ++-------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cell_subdiv` | ++-------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`energy` | ++-------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`octree` | ++-------------------------------------------+------------------------------------------------------------------------------------+ Methods ------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user` **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_users` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_user_count` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_user_lightmap` **(** :ref:`int` user_idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_user_path` **(** :ref:`int` user_idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_user` **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_users` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_user_count` **(** **)** const | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_user_lightmap` **(** :ref:`int` user_idx **)** const | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_user_path` **(** :ref:`int` user_idx **)** const | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_BakedLightmapData_bounds: +.. _class_BakedLightmapData_property_bounds: - :ref:`AABB` **bounds** @@ -59,7 +59,7 @@ Property Descriptions | *Getter* | get_bounds() | +----------+-------------------+ -.. _class_BakedLightmapData_cell_space_transform: +.. _class_BakedLightmapData_property_cell_space_transform: - :ref:`Transform` **cell_space_transform** @@ -69,7 +69,7 @@ Property Descriptions | *Getter* | get_cell_space_transform() | +----------+---------------------------------+ -.. _class_BakedLightmapData_cell_subdiv: +.. _class_BakedLightmapData_property_cell_subdiv: - :ref:`int` **cell_subdiv** @@ -79,7 +79,7 @@ Property Descriptions | *Getter* | get_cell_subdiv() | +----------+------------------------+ -.. _class_BakedLightmapData_energy: +.. _class_BakedLightmapData_property_energy: - :ref:`float` **energy** @@ -89,7 +89,7 @@ Property Descriptions | *Getter* | get_energy() | +----------+-------------------+ -.. _class_BakedLightmapData_octree: +.. _class_BakedLightmapData_property_octree: - :ref:`PoolByteArray` **octree** @@ -102,23 +102,23 @@ Property Descriptions Method Descriptions ------------------- -.. _class_BakedLightmapData_add_user: +.. _class_BakedLightmapData_method_add_user: - void **add_user** **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** -.. _class_BakedLightmapData_clear_users: +.. _class_BakedLightmapData_method_clear_users: - void **clear_users** **(** **)** -.. _class_BakedLightmapData_get_user_count: +.. _class_BakedLightmapData_method_get_user_count: - :ref:`int` **get_user_count** **(** **)** const -.. _class_BakedLightmapData_get_user_lightmap: +.. _class_BakedLightmapData_method_get_user_lightmap: - :ref:`Texture` **get_user_lightmap** **(** :ref:`int` user_idx **)** const -.. _class_BakedLightmapData_get_user_path: +.. _class_BakedLightmapData_method_get_user_path: - :ref:`NodePath` **get_user_path** **(** :ref:`int` user_idx **)** const diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 1860d059d..6e5ae0343 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -21,61 +21,61 @@ Base class for different kinds of buttons. Properties ---------- -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`ActionMode` | :ref:`action_mode` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`button_mask` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`FocusMode` | :ref:`enabled_focus_mode` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`ButtonGroup` | :ref:`group` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`shortcut` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shortcut_in_tooltip` | -+-----------------------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`toggle_mode` | -+-----------------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`ActionMode` | :ref:`action_mode` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`int` | :ref:`button_mask` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`FocusMode` | :ref:`enabled_focus_mode` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`ButtonGroup` | :ref:`group` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`ShortCut` | :ref:`shortcut` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shortcut_in_tooltip` | ++-----------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`toggle_mode` | ++-----------------------------------------------+---------------------------------------------------------------------------+ 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 ------- -.. _class_BaseButton_button_down: +.. _class_BaseButton_signal_button_down: - **button_down** **(** **)** Emitted when the button starts being held down. -.. _class_BaseButton_button_up: +.. _class_BaseButton_signal_button_up: - **button_up** **(** **)** Emitted when the button stops being held down. -.. _class_BaseButton_pressed: +.. _class_BaseButton_signal_pressed: - **pressed** **(** **)** This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise). -.. _class_BaseButton_toggled: +.. _class_BaseButton_signal_toggled: - **toggled** **(** :ref:`bool` button_pressed **)** @@ -86,6 +86,16 @@ Enumerations .. _enum_BaseButton_DrawMode: +.. _class_BaseButton_constant_DRAW_NORMAL: + +.. _class_BaseButton_constant_DRAW_PRESSED: + +.. _class_BaseButton_constant_DRAW_HOVER: + +.. _class_BaseButton_constant_DRAW_DISABLED: + +.. _class_BaseButton_constant_DRAW_HOVER_PRESSED: + enum **DrawMode**: - **DRAW_NORMAL** = **0** --- The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons. @@ -100,6 +110,10 @@ enum **DrawMode**: .. _enum_BaseButton_ActionMode: +.. _class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS: + +.. _class_BaseButton_constant_ACTION_MODE_BUTTON_RELEASE: + enum **ActionMode**: - **ACTION_MODE_BUTTON_PRESS** = **0** --- Require just a press to consider the button clicked. @@ -114,7 +128,7 @@ BaseButton is the abstract base class for buttons, so it shouldn't be used direc Property Descriptions --------------------- -.. _class_BaseButton_action_mode: +.. _class_BaseButton_property_action_mode: - :ref:`ActionMode` **action_mode** @@ -126,7 +140,7 @@ Property Descriptions Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants. -.. _class_BaseButton_button_mask: +.. _class_BaseButton_property_button_mask: - :ref:`int` **button_mask** @@ -140,7 +154,7 @@ Binary mask to choose which mouse buttons this button will respond to. To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT. -.. _class_BaseButton_disabled: +.. _class_BaseButton_property_disabled: - :ref:`bool` **disabled** @@ -152,7 +166,7 @@ To allow both left-click and right-click, set this to 3, because it's BUTTON_MAS If ``true``, the button is in disabled state and can't be clicked or toggled. -.. _class_BaseButton_enabled_focus_mode: +.. _class_BaseButton_property_enabled_focus_mode: - :ref:`FocusMode` **enabled_focus_mode** @@ -162,9 +176,9 @@ If ``true``, the button is in disabled state and can't be clicked or toggled. | *Getter* | get_enabled_focus_mode() | +----------+-------------------------------+ -Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`disabled`). +Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`disabled`). -.. _class_BaseButton_group: +.. _class_BaseButton_property_group: - :ref:`ButtonGroup` **group** @@ -176,7 +190,7 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont :ref:`ButtonGroup` associated to the button. -.. _class_BaseButton_pressed: +.. _class_BaseButton_property_pressed: - :ref:`bool` **pressed** @@ -188,7 +202,7 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont If ``true``, the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). -.. _class_BaseButton_shortcut: +.. _class_BaseButton_property_shortcut: - :ref:`ShortCut` **shortcut** @@ -200,7 +214,7 @@ If ``true``, the button's state is pressed. Means the button is pressed down or :ref:`ShortCut` associated to the button. -.. _class_BaseButton_shortcut_in_tooltip: +.. _class_BaseButton_property_shortcut_in_tooltip: - :ref:`bool` **shortcut_in_tooltip** @@ -212,7 +226,7 @@ If ``true``, the button's state is pressed. Means the button is pressed down or If ``true``, the button will add information about its shortcut in the tooltip. -.. _class_BaseButton_toggle_mode: +.. _class_BaseButton_property_toggle_mode: - :ref:`bool` **toggle_mode** @@ -227,25 +241,25 @@ If ``true``, the button is in toggle mode. Makes the button flip state between p Method Descriptions ------------------- -.. _class_BaseButton__pressed: +.. _class_BaseButton_method__pressed: - void **_pressed** **(** **)** virtual Called when the button is pressed. -.. _class_BaseButton__toggled: +.. _class_BaseButton_method__toggled: - void **_toggled** **(** :ref:`bool` button_pressed **)** virtual Called when the button is toggled (only if toggle_mode is active). -.. _class_BaseButton_get_draw_mode: +.. _class_BaseButton_method_get_draw_mode: - :ref:`DrawMode` **get_draw_mode** **(** **)** const Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum. -.. _class_BaseButton_is_hovered: +.. _class_BaseButton_method_is_hovered: - :ref:`bool` **is_hovered** **(** **)** const diff --git a/classes/class_basis.rst b/classes/class_basis.rst index f846ee9e5..6b584c92d 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -17,56 +17,56 @@ Brief Description Properties ---------- -+-------------------------------+-------------------------+ -| :ref:`Vector3` | :ref:`x` | -+-------------------------------+-------------------------+ -| :ref:`Vector3` | :ref:`y` | -+-------------------------------+-------------------------+ -| :ref:`Vector3` | :ref:`z` | -+-------------------------------+-------------------------+ ++-------------------------------+----------------------------------+ +| :ref:`Vector3` | :ref:`x` | ++-------------------------------+----------------------------------+ +| :ref:`Vector3` | :ref:`y` | ++-------------------------------+----------------------------------+ +| :ref:`Vector3` | :ref:`z` | ++-------------------------------+----------------------------------+ Methods ------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Quat` from **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` from **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`determinant` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_euler` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_orthogonal_index` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_scale` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`inverse` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`orthonormalized` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`slerp` **(** :ref:`Basis` b, :ref:`float` t **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`transposed` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform_inv` **(** :ref:`Vector3` v **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Quat` from **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` from **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`determinant` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_euler` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_orthogonal_index` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_scale` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`inverse` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`orthonormalized` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`slerp` **(** :ref:`Basis` b, :ref:`float` t **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`transposed` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`xform_inv` **(** :ref:`Vector3` v **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -85,19 +85,19 @@ Tutorials Property Descriptions --------------------- -.. _class_Basis_x: +.. _class_Basis_property_x: - :ref:`Vector3` **x** The basis matrix's x vector. -.. _class_Basis_y: +.. _class_Basis_property_y: - :ref:`Vector3` **y** The basis matrix's y vector. -.. _class_Basis_z: +.. _class_Basis_property_z: - :ref:`Vector3` **z** @@ -106,115 +106,109 @@ The basis matrix's z vector. Method Descriptions ------------------- -.. _class_Basis_Basis: +.. _class_Basis_method_Basis: - :ref:`Basis` **Basis** **(** :ref:`Quat` from **)** Create a rotation matrix from the given quaternion. -.. _class_Basis_Basis: - - :ref:`Basis` **Basis** **(** :ref:`Vector3` from **)** Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle). -.. _class_Basis_Basis: - - :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Create a rotation matrix which rotates around the given axis by the specified angle, in radians. The axis must be a normalized vector. -.. _class_Basis_Basis: - - :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** Create a matrix from 3 axis vectors. -.. _class_Basis_determinant: +.. _class_Basis_method_determinant: - :ref:`float` **determinant** **(** **)** Return the determinant of the matrix. -.. _class_Basis_get_euler: +.. _class_Basis_method_get_euler: - :ref:`Vector3` **get_euler** **(** **)** Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). -.. _class_Basis_get_orthogonal_index: +.. _class_Basis_method_get_orthogonal_index: - :ref:`int` **get_orthogonal_index** **(** **)** This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code. -.. _class_Basis_get_scale: +.. _class_Basis_method_get_scale: - :ref:`Vector3` **get_scale** **(** **)** Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. -.. _class_Basis_inverse: +.. _class_Basis_method_inverse: - :ref:`Basis` **inverse** **(** **)** Return the inverse of the matrix. -.. _class_Basis_orthonormalized: +.. _class_Basis_method_orthonormalized: - :ref:`Basis` **orthonormalized** **(** **)** Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. -.. _class_Basis_rotated: +.. _class_Basis_method_rotated: - :ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector. -.. _class_Basis_scaled: +.. _class_Basis_method_scaled: - :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** Introduce an additional scaling specified by the given 3D scaling factor. -.. _class_Basis_slerp: +.. _class_Basis_method_slerp: - :ref:`Basis` **slerp** **(** :ref:`Basis` b, :ref:`float` t **)** Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. -.. _class_Basis_tdotx: +.. _class_Basis_method_tdotx: - :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** Transposed dot product with the x axis of the matrix. -.. _class_Basis_tdoty: +.. _class_Basis_method_tdoty: - :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** Transposed dot product with the y axis of the matrix. -.. _class_Basis_tdotz: +.. _class_Basis_method_tdotz: - :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** Transposed dot product with the z axis of the matrix. -.. _class_Basis_transposed: +.. _class_Basis_method_transposed: - :ref:`Basis` **transposed** **(** **)** Return the transposed version of the matrix. -.. _class_Basis_xform: +.. _class_Basis_method_xform: - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** Return a vector transformed (multiplied) by the matrix. -.. _class_Basis_xform_inv: +.. _class_Basis_method_xform_inv: - :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index f1b57e90c..b7dffd111 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -19,25 +19,25 @@ Boolean matrix. Methods ------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`Vector2` size **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image_alpha` **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** 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 | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit_rect` **(** :ref:`Rect2` rect, :ref:`bool` bit **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`Vector2` size **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_image_alpha` **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** const | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** 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 | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bit_rect` **(** :ref:`Rect2` rect, :ref:`bool` bit **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -47,51 +47,51 @@ A two-dimensional array of boolean values, can be used to efficiently store a bi Method Descriptions ------------------- -.. _class_BitMap_create: +.. _class_BitMap_method_create: - void **create** **(** :ref:`Vector2` size **)** Creates a bitmap with the specified size, filled with false. -.. _class_BitMap_create_from_image_alpha: +.. _class_BitMap_method_create_from_image_alpha: - void **create_from_image_alpha** **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is equal to ``threshold`` or less, and true in other case. -.. _class_BitMap_get_bit: +.. _class_BitMap_method_get_bit: - :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const Returns bitmap's value at the specified position. -.. _class_BitMap_get_size: +.. _class_BitMap_method_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns bitmap's dimensions. -.. _class_BitMap_get_true_bit_count: +.. _class_BitMap_method_get_true_bit_count: - :ref:`int` **get_true_bit_count** **(** **)** const Returns the amount of bitmap elements that are set to true. -.. _class_BitMap_grow_mask: +.. _class_BitMap_method_grow_mask: - void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** -.. _class_BitMap_opaque_to_polygons: +.. _class_BitMap_method_opaque_to_polygons: - :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const -.. _class_BitMap_set_bit: +.. _class_BitMap_method_set_bit: - void **set_bit** **(** :ref:`Vector2` position, :ref:`bool` bit **)** Sets the bitmap's element at the specified position, to the specified value. -.. _class_BitMap_set_bit_rect: +.. _class_BitMap_method_set_bit_rect: - void **set_bit_rect** **(** :ref:`Rect2` rect, :ref:`bool` bit **)** diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 668248c0a..85bd6fdf1 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -19,38 +19,38 @@ Renders text using ``*.fnt`` fonts. Properties ---------- -+-------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`ascent` | -+-------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`distance_field` | -+-------------------------------------+--------------------------------------------------------+ -| :ref:`BitmapFont` | :ref:`fallback` | -+-------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+-------------------------------------+--------------------------------------------------------+ ++-------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`ascent` | ++-------------------------------------+-----------------------------------------------------------------+ +| :ref:`bool` | :ref:`distance_field` | ++-------------------------------------+-----------------------------------------------------------------+ +| :ref:`BitmapFont` | :ref:`fallback` | ++-------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`height` | ++-------------------------------------+-----------------------------------------------------------------+ Methods ------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_count` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_count` **(** **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -60,7 +60,7 @@ Renders text using ``*.fnt`` fonts containing texture atlases. Supports distance Property Descriptions --------------------- -.. _class_BitmapFont_ascent: +.. _class_BitmapFont_property_ascent: - :ref:`float` **ascent** @@ -72,7 +72,7 @@ Property Descriptions Ascent (number of pixels above the baseline). -.. _class_BitmapFont_distance_field: +.. _class_BitmapFont_property_distance_field: - :ref:`bool` **distance_field** @@ -84,7 +84,7 @@ Ascent (number of pixels above the baseline). If ``true``, distance field hint is enabled. -.. _class_BitmapFont_fallback: +.. _class_BitmapFont_property_fallback: - :ref:`BitmapFont` **fallback** @@ -96,7 +96,7 @@ If ``true``, distance field hint is enabled. The fallback font. -.. _class_BitmapFont_height: +.. _class_BitmapFont_property_height: - :ref:`float` **height** @@ -111,55 +111,55 @@ Total font height (ascent plus descent) in pixels. Method Descriptions ------------------- -.. _class_BitmapFont_add_char: +.. _class_BitmapFont_method_add_char: - void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** Adds a character to the font, where ``character`` is the unicode value, ``texture`` is the texture index, ``rect`` is the region in the texture (in pixels!), ``align`` is the (optional) alignment for the character and ``advance`` is the (optional) advance. -.. _class_BitmapFont_add_kerning_pair: +.. _class_BitmapFont_method_add_kerning_pair: - void **add_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. -.. _class_BitmapFont_add_texture: +.. _class_BitmapFont_method_add_texture: - void **add_texture** **(** :ref:`Texture` texture **)** Adds a texture to the ``BitmapFont``. -.. _class_BitmapFont_clear: +.. _class_BitmapFont_method_clear: - void **clear** **(** **)** Clears all the font data and settings. -.. _class_BitmapFont_create_from_fnt: +.. _class_BitmapFont_method_create_from_fnt: - :ref:`Error` **create_from_fnt** **(** :ref:`String` path **)** Creates a BitmapFont from the ``*.fnt`` file at ``path``. -.. _class_BitmapFont_get_char_size: +.. _class_BitmapFont_method_get_char_size: - :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. -.. _class_BitmapFont_get_kerning_pair: +.. _class_BitmapFont_method_get_kerning_pair: - :ref:`int` **get_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b **)** const Returns a kerning pair as a difference. -.. _class_BitmapFont_get_texture: +.. _class_BitmapFont_method_get_texture: - :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** const Returns the font atlas texture at index ``idx``. -.. _class_BitmapFont_get_texture_count: +.. _class_BitmapFont_method_get_texture_count: - :ref:`int` **get_texture_count** **(** **)** const diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index 5b99e825f..a0ff04b4b 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -19,27 +19,27 @@ Brief Description Properties ---------- -+---------------------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`default_length` | -+---------------------------------------+----------------------------------------------------+ -| :ref:`Transform2D` | :ref:`rest` | -+---------------------------------------+----------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------+ +| :ref:`float` | :ref:`default_length` | ++---------------------------------------+-------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`rest` | ++---------------------------------------+-------------------------------------------------------------+ 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 --------------------- -.. _class_Bone2D_default_length: +.. _class_Bone2D_property_default_length: - :ref:`float` **default_length** @@ -49,7 +49,7 @@ Property Descriptions | *Getter* | get_default_length() | +----------+---------------------------+ -.. _class_Bone2D_rest: +.. _class_Bone2D_property_rest: - :ref:`Transform2D` **rest** @@ -62,15 +62,15 @@ Property Descriptions Method Descriptions ------------------- -.. _class_Bone2D_apply_rest: +.. _class_Bone2D_method_apply_rest: - void **apply_rest** **(** **)** -.. _class_Bone2D_get_index_in_skeleton: +.. _class_Bone2D_method_get_index_in_skeleton: - :ref:`int` **get_index_in_skeleton** **(** **)** const -.. _class_Bone2D_get_skeleton_rest: +.. _class_Bone2D_method_get_skeleton_rest: - :ref:`Transform2D` **get_skeleton_rest** **(** **)** const diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index 940ef97a8..89ee72dfc 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -19,9 +19,9 @@ A node that will attach to a bone. Properties ---------- -+-----------------------------+--------------------------------------------------+ -| :ref:`String` | :ref:`bone_name` | -+-----------------------------+--------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------+ +| :ref:`String` | :ref:`bone_name` | ++-----------------------------+-----------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ This node must be the child of a :ref:`Skeleton` node. You can t Property Descriptions --------------------- -.. _class_BoneAttachment_bone_name: +.. _class_BoneAttachment_property_bone_name: - :ref:`String` **bone_name** diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 319846714..2d5ebc8d1 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -17,13 +17,13 @@ Boolean built-in type Methods ------- -+--------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`int` from **)** | -+--------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`float` from **)** | -+--------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`String` from **)** | -+--------------------------+---------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`bool` **(** :ref:`int` from **)** | ++-------------------------+----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`bool` **(** :ref:`float` from **)** | ++-------------------------+----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`bool` **(** :ref:`String` from **)** | ++-------------------------+----------------------------------------------------------------------------------+ Description ----------- @@ -33,20 +33,16 @@ Boolean built-in type. Method Descriptions ------------------- -.. _class_bool_bool: +.. _class_bool_method_bool: - :ref:`bool` **bool** **(** :ref:`int` from **)** Cast an :ref:`int` value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case. -.. _class_bool_bool: - - :ref:`bool` **bool** **(** :ref:`float` from **)** Cast a :ref:`float` value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case. -.. _class_bool_bool: - - :ref:`bool` **bool** **(** :ref:`String` from **)** Cast a :ref:`String` value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: ``bool('False')`` returns true, ``bool('')``. returns false diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 8809d13bd..3eb01d95a 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -21,22 +21,28 @@ Base class for box containers. Properties ---------- -+-----------------------------------------------+------------------------------------------------+ -| :ref:`AlignMode` | :ref:`alignment` | -+-----------------------------------------------+------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------+ +| :ref:`AlignMode` | :ref:`alignment` | ++-----------------------------------------------+---------------------------------------------------------+ Methods ------- -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`add_spacer` **(** :ref:`bool` begin **)** | -+-------+--------------------------------------------------------------------------------------------+ ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`add_spacer` **(** :ref:`bool` begin **)** | ++------+---------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_BoxContainer_AlignMode: +.. _class_BoxContainer_constant_ALIGN_BEGIN: + +.. _class_BoxContainer_constant_ALIGN_CENTER: + +.. _class_BoxContainer_constant_ALIGN_END: + enum **AlignMode**: - **ALIGN_BEGIN** = **0** --- Aligns children with the beginning of the container. @@ -53,7 +59,7 @@ Arranges child controls vertically or horizontally, and rearranges the controls Property Descriptions --------------------- -.. _class_BoxContainer_alignment: +.. _class_BoxContainer_property_alignment: - :ref:`AlignMode` **alignment** @@ -68,7 +74,7 @@ The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CEN Method Descriptions ------------------- -.. _class_BoxContainer_add_spacer: +.. _class_BoxContainer_method_add_spacer: - void **add_spacer** **(** :ref:`bool` begin **)** diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index 89d3907bf..fe3f18448 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -19,9 +19,9 @@ Box shape resource. Properties ---------- -+-------------------------------+----------------------------------------+ -| :ref:`Vector3` | :ref:`extents` | -+-------------------------------+----------------------------------------+ ++-------------------------------+-------------------------------------------------+ +| :ref:`Vector3` | :ref:`extents` | ++-------------------------------+-------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Description Property Descriptions --------------------- -.. _class_BoxShape_extents: +.. _class_BoxShape_property_extents: - :ref:`Vector3` **extents** diff --git a/classes/class_button.rst b/classes/class_button.rst index 9e044147f..e17e379ec 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -21,50 +21,56 @@ Standard themed Button. Properties ---------- -+-----------------------------------------+------------------------------------------+ -| :ref:`TextAlign` | :ref:`align` | -+-----------------------------------------+------------------------------------------+ -| :ref:`bool` | :ref:`clip_text` | -+-----------------------------------------+------------------------------------------+ -| :ref:`bool` | :ref:`flat` | -+-----------------------------------------+------------------------------------------+ -| :ref:`Texture` | :ref:`icon` | -+-----------------------------------------+------------------------------------------+ -| :ref:`String` | :ref:`text` | -+-----------------------------------------+------------------------------------------+ ++-----------------------------------------+---------------------------------------------------+ +| :ref:`TextAlign` | :ref:`align` | ++-----------------------------------------+---------------------------------------------------+ +| :ref:`bool` | :ref:`clip_text` | ++-----------------------------------------+---------------------------------------------------+ +| :ref:`bool` | :ref:`flat` | ++-----------------------------------------+---------------------------------------------------+ +| :ref:`Texture` | :ref:`icon` | ++-----------------------------------------+---------------------------------------------------+ +| :ref:`String` | :ref:`text` | ++-----------------------------------------+---------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+--------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`disabled` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_pressed` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`pressed` | -+---------------------------------+--------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`StyleBox` | disabled | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+---------------------+ +| :ref:`Font` | font | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_hover | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_pressed | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | hover | ++---------------------------------+---------------------+ +| :ref:`int` | hseparation | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | pressed | ++---------------------------------+---------------------+ Enumerations ------------ .. _enum_Button_TextAlign: +.. _class_Button_constant_ALIGN_LEFT: + +.. _class_Button_constant_ALIGN_CENTER: + +.. _class_Button_constant_ALIGN_RIGHT: + enum **TextAlign**: - **ALIGN_LEFT** = **0** --- Align the text to the left. @@ -81,7 +87,7 @@ Button is the standard themed button. It can contain text and an icon, and will Property Descriptions --------------------- -.. _class_Button_align: +.. _class_Button_property_align: - :ref:`TextAlign` **align** @@ -93,7 +99,7 @@ Property Descriptions Text alignment policy for the button's text, use one of the ALIGN\_\* constants. -.. _class_Button_clip_text: +.. _class_Button_property_clip_text: - :ref:`bool` **clip_text** @@ -105,7 +111,7 @@ Text alignment policy for the button's text, use one of the ALIGN\_\* constants. When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. -.. _class_Button_flat: +.. _class_Button_property_flat: - :ref:`bool` **flat** @@ -117,7 +123,7 @@ When this property is enabled, text that is too large to fit the button is clipp Flat buttons don't display decoration. -.. _class_Button_icon: +.. _class_Button_property_icon: - :ref:`Texture` **icon** @@ -129,7 +135,7 @@ Flat buttons don't display decoration. Button's icon, if text is present the icon will be placed before the text. -.. _class_Button_text: +.. _class_Button_property_text: - :ref:`String` **text** diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index f3dd1a43a..06c4da052 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -19,29 +19,29 @@ Group of Buttons. Methods ------- -+--------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_buttons` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | -+--------------------------------------+-----------------------------------------------------------------------------+ ++-------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_buttons` **(** **)** | ++-------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | ++-------------------------------------+------------------------------------------------------------------------------------+ Description ----------- Group of :ref:`Button`. All direct and indirect children buttons become radios. Only one allows being pressed. -:ref:`BaseButton.toggle_mode` should be ``true``. +:ref:`BaseButton.toggle_mode` should be ``true``. Method Descriptions ------------------- -.. _class_ButtonGroup_get_buttons: +.. _class_ButtonGroup_method_get_buttons: - :ref:`Array` **get_buttons** **(** **)** -Returns an :ref:`Array` of :ref:`Button`\ s who have this as their ``ButtonGroup`` (see :ref:`BaseButton.group`). +Returns an :ref:`Array` of :ref:`Button`\ s who have this as their ``ButtonGroup`` (see :ref:`BaseButton.group`). -.. _class_ButtonGroup_get_pressed_button: +.. _class_ButtonGroup_method_get_pressed_button: - :ref:`BaseButton` **get_pressed_button** **(** **)** diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 9357046ff..9667f9829 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -21,68 +21,72 @@ Camera node, displays from a point of view. Properties ---------- -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`int` | :ref:`cull_mask` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`current` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`DopplerTracking` | :ref:`doppler_tracking` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`Environment` | :ref:`environment` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`far` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`fov` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`h_offset` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`KeepAspect` | :ref:`keep_aspect` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`near` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`Projection` | :ref:`projection` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`size` | -+-----------------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`v_offset` | -+-----------------------------------------------------+--------------------------------------------------------+ ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`int` | :ref:`cull_mask` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`bool` | :ref:`current` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`DopplerTracking` | :ref:`doppler_tracking` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`Environment` | :ref:`environment` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`far` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`fov` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`h_offset` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`KeepAspect` | :ref:`keep_aspect` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`near` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`Projection` | :ref:`projection` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`size` | ++-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`v_offset` | ++-----------------------------------------------------+-----------------------------------------------------------------+ Methods ------- -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_cull_mask_bit` **(** :ref:`int` layer **)** 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_position` **(** :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 | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mask_bit` **(** :ref:`int` layer, :ref:`bool` enable **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_cull_mask_bit` **(** :ref:`int` layer **)** 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_position` **(** :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 | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask_bit` **(** :ref:`int` layer, :ref:`bool` enable **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Camera_Projection: +.. _class_Camera_constant_PROJECTION_PERSPECTIVE: + +.. _class_Camera_constant_PROJECTION_ORTHOGONAL: + enum **Projection**: - **PROJECTION_PERSPECTIVE** = **0** --- Perspective Projection (object's size on the screen becomes smaller when far away). @@ -91,6 +95,10 @@ enum **Projection**: .. _enum_Camera_KeepAspect: +.. _class_Camera_constant_KEEP_WIDTH: + +.. _class_Camera_constant_KEEP_HEIGHT: + enum **KeepAspect**: - **KEEP_WIDTH** = **0** --- Preserves the horizontal aspect ratio. @@ -99,6 +107,12 @@ enum **KeepAspect**: .. _enum_Camera_DopplerTracking: +.. _class_Camera_constant_DOPPLER_TRACKING_DISABLED: + +.. _class_Camera_constant_DOPPLER_TRACKING_IDLE_STEP: + +.. _class_Camera_constant_DOPPLER_TRACKING_PHYSICS_STEP: + enum **DopplerTracking**: - **DOPPLER_TRACKING_DISABLED** = **0** --- Disable Doppler effect simulation (default). @@ -115,7 +129,7 @@ Camera is a special node that displays what is visible from its current location Property Descriptions --------------------- -.. _class_Camera_cull_mask: +.. _class_Camera_property_cull_mask: - :ref:`int` **cull_mask** @@ -127,7 +141,7 @@ Property Descriptions The culling mask that describes which 3D render layers are rendered by this camera. -.. _class_Camera_current: +.. _class_Camera_property_current: - :ref:`bool` **current** @@ -139,7 +153,7 @@ The culling mask that describes which 3D render layers are rendered by this came If ``true``, the ancestor :ref:`Viewport` is currently using this Camera. Default value: ``false``. -.. _class_Camera_doppler_tracking: +.. _class_Camera_property_doppler_tracking: - :ref:`DopplerTracking` **doppler_tracking** @@ -151,7 +165,7 @@ If ``true``, the ancestor :ref:`Viewport` is currently using thi If not ``DOPPLER_TRACKING_DISABLED`` this Camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. Default value: ``DOPPLER_TRACKING_DISABLED``. -.. _class_Camera_environment: +.. _class_Camera_property_environment: - :ref:`Environment` **environment** @@ -163,7 +177,7 @@ If not ``DOPPLER_TRACKING_DISABLED`` this Camera will simulate the Doppler effec The :ref:`Environment` to use for this Camera. -.. _class_Camera_far: +.. _class_Camera_property_far: - :ref:`float` **far** @@ -175,7 +189,7 @@ The :ref:`Environment` to use for this Camera. The distance to the far culling boundary for this Camera relative to its local z-axis. -.. _class_Camera_fov: +.. _class_Camera_property_fov: - :ref:`float` **fov** @@ -185,9 +199,9 @@ The distance to the far culling boundary for this Camera relative to its local z | *Getter* | get_fov() | +----------+----------------+ -The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect` locks one axis, ``fov`` sets the other axis' field of view angle. +The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect` locks one axis, ``fov`` sets the other axis' field of view angle. -.. _class_Camera_h_offset: +.. _class_Camera_property_h_offset: - :ref:`float` **h_offset** @@ -199,7 +213,7 @@ The camera's field of view angle (in degrees). Only applicable in perspective mo The horizontal (X) offset of the Camera viewport. -.. _class_Camera_keep_aspect: +.. _class_Camera_property_keep_aspect: - :ref:`KeepAspect` **keep_aspect** @@ -209,9 +223,9 @@ The horizontal (X) offset of the Camera viewport. | *Getter* | get_keep_aspect_mode() | +----------+-----------------------------+ -The axis to lock during :ref:`fov`/:ref:`size` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``. +The axis to lock during :ref:`fov`/:ref:`size` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``. -.. _class_Camera_near: +.. _class_Camera_property_near: - :ref:`float` **near** @@ -223,7 +237,7 @@ The axis to lock during :ref:`fov`/:ref:`size` **projection** @@ -235,7 +249,7 @@ The distance to the near culling boundary for this Camera relative to its local The camera's projection mode. In ``PROJECTION_PERSPECTIVE`` mode, objects' z-distance from the camera's local space scales their perceived size. -.. _class_Camera_size: +.. _class_Camera_property_size: - :ref:`float` **size** @@ -245,9 +259,9 @@ The camera's projection mode. In ``PROJECTION_PERSPECTIVE`` mode, objects' z-dis | *Getter* | get_size() | +----------+-----------------+ -The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since :ref:`keep_aspect` locks on axis, ``size`` sets the other axis' size length. +The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since :ref:`keep_aspect` locks on axis, ``size`` sets the other axis' size length. -.. _class_Camera_v_offset: +.. _class_Camera_property_v_offset: - :ref:`float` **v_offset** @@ -262,75 +276,75 @@ The vertical (Y) offset of the Camera viewport. Method Descriptions ------------------- -.. _class_Camera_clear_current: +.. _class_Camera_method_clear_current: - void **clear_current** **(** :ref:`bool` enable_next=true **)** If this is the current Camera, remove it from being current. If ``enable_next`` is true, request to make the next Camera current, if any. -.. _class_Camera_get_camera_transform: +.. _class_Camera_method_get_camera_transform: - :ref:`Transform` **get_camera_transform** **(** **)** const Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node` transform. -.. _class_Camera_get_cull_mask_bit: +.. _class_Camera_method_get_cull_mask_bit: - :ref:`bool` **get_cull_mask_bit** **(** :ref:`int` layer **)** const -.. _class_Camera_is_position_behind: +.. _class_Camera_method_is_position_behind: - :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** const Returns ``true`` if the given position is behind the Camera. Note that a position which returns ``false`` may still be outside the Camera's field of view. -.. _class_Camera_make_current: +.. _class_Camera_method_make_current: - void **make_current** **(** **)** Makes this camera the current Camera for the :ref:`Viewport` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. -.. _class_Camera_project_local_ray_normal: +.. _class_Camera_method_project_local_ray_normal: - :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. -.. _class_Camera_project_position: +.. _class_Camera_method_project_position: - :ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point **)** const Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport` rectangle. -.. _class_Camera_project_ray_normal: +.. _class_Camera_method_project_ray_normal: - :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. -.. _class_Camera_project_ray_origin: +.. _class_Camera_method_project_ray_origin: - :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. -.. _class_Camera_set_cull_mask_bit: +.. _class_Camera_method_set_cull_mask_bit: - void **set_cull_mask_bit** **(** :ref:`int` layer, :ref:`bool` enable **)** -.. _class_Camera_set_orthogonal: +.. _class_Camera_method_set_orthogonal: - void **set_orthogonal** **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** Sets the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) -.. _class_Camera_set_perspective: +.. _class_Camera_method_set_perspective: - void **set_perspective** **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** Sets the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units. -.. _class_Camera_unproject_position: +.. _class_Camera_method_unproject_position: - :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** const diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index a9a919103..2954bae18 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -19,82 +19,86 @@ Camera node for 2D scenes. Properties ---------- -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`AnchorMode` | :ref:`anchor_mode` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`current` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`custom_viewport` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_margin_bottom` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`drag_margin_h_enabled` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_margin_left` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_margin_right` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_margin_top` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`drag_margin_v_enabled` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_draw_drag_margin` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_draw_limits` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_draw_screen` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`limit_bottom` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`limit_left` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`limit_right` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`limit_smoothed` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`limit_top` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`offset_h` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`offset_v` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Camera2DProcessMode` | :ref:`process_mode` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rotating` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`smoothing_enabled` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`float` | :ref:`smoothing_speed` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`zoom` | -+---------------------------------------------------------------+------------------------------------------------------------------------+ ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`AnchorMode` | :ref:`anchor_mode` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`current` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`custom_viewport` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`drag_margin_bottom` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`drag_margin_h_enabled` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`drag_margin_left` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`drag_margin_right` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`drag_margin_top` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`drag_margin_v_enabled` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor_draw_drag_margin` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor_draw_limits` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor_draw_screen` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`limit_bottom` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`limit_left` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`limit_right` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`limit_smoothed` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`limit_top` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`offset` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`offset_h` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`offset_v` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`Camera2DProcessMode` | :ref:`process_mode` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rotating` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`smoothing_enabled` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`smoothing_speed` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`zoom` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ Methods ------- -+--------------------------------+--------------------------------------------------------------------------------------------+ -| void | :ref:`align` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------+ -| void | :ref:`force_update_scroll` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------+ -| void | :ref:`reset_smoothing` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`align` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`force_update_scroll` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`reset_smoothing` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Camera2D_AnchorMode: +.. _class_Camera2D_constant_ANCHOR_MODE_FIXED_TOP_LEFT: + +.. _class_Camera2D_constant_ANCHOR_MODE_DRAG_CENTER: + enum **AnchorMode**: - **ANCHOR_MODE_FIXED_TOP_LEFT** = **0** --- The camera's position is fixed so that the top-left corner is always at the origin. @@ -103,6 +107,10 @@ enum **AnchorMode**: .. _enum_Camera2D_Camera2DProcessMode: +.. _class_Camera2D_constant_CAMERA2D_PROCESS_PHYSICS: + +.. _class_Camera2D_constant_CAMERA2D_PROCESS_IDLE: + enum **Camera2DProcessMode**: - **CAMERA2D_PROCESS_PHYSICS** = **0** @@ -119,7 +127,7 @@ This node is intended to be a simple helper to get things going quickly and it m Property Descriptions --------------------- -.. _class_Camera2D_anchor_mode: +.. _class_Camera2D_property_anchor_mode: - :ref:`AnchorMode` **anchor_mode** @@ -131,7 +139,7 @@ Property Descriptions The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. -.. _class_Camera2D_current: +.. _class_Camera2D_property_current: - :ref:`bool` **current** @@ -141,7 +149,7 @@ The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. If ``true``, the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one. -.. _class_Camera2D_custom_viewport: +.. _class_Camera2D_property_custom_viewport: - :ref:`Node` **custom_viewport** @@ -153,7 +161,7 @@ If ``true``, the camera is the active camera for the current scene. Only one cam The custom :ref:`Viewport` node attached to the ``Camera2D``. If null or not a :ref:`Viewport`, uses the default viewport instead. -.. _class_Camera2D_drag_margin_bottom: +.. _class_Camera2D_property_drag_margin_bottom: - :ref:`float` **drag_margin_bottom** @@ -165,7 +173,7 @@ The custom :ref:`Viewport` node attached to the ``Camera2D``. If Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. -.. _class_Camera2D_drag_margin_h_enabled: +.. _class_Camera2D_property_drag_margin_h_enabled: - :ref:`bool` **drag_margin_h_enabled** @@ -177,7 +185,7 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move If ``true``, the camera only moves when reaching the horizontal drag margins. If ``false``, the camera moves horizontally regardless of margins. Default value: ``true``. -.. _class_Camera2D_drag_margin_left: +.. _class_Camera2D_property_drag_margin_left: - :ref:`float` **drag_margin_left** @@ -189,7 +197,7 @@ If ``true``, the camera only moves when reaching the horizontal drag margins. If Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. -.. _class_Camera2D_drag_margin_right: +.. _class_Camera2D_property_drag_margin_right: - :ref:`float` **drag_margin_right** @@ -201,7 +209,7 @@ Left margin needed to drag the camera. A value of ``1`` makes the camera move on Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. -.. _class_Camera2D_drag_margin_top: +.. _class_Camera2D_property_drag_margin_top: - :ref:`float` **drag_margin_top** @@ -213,7 +221,7 @@ Right margin needed to drag the camera. A value of ``1`` makes the camera move o Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. -.. _class_Camera2D_drag_margin_v_enabled: +.. _class_Camera2D_property_drag_margin_v_enabled: - :ref:`bool` **drag_margin_v_enabled** @@ -225,7 +233,7 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl If ``true``, the camera only moves when reaching the vertical drag margins. If ``false``, the camera moves vertically regardless of margins. Default value: ``true``. -.. _class_Camera2D_editor_draw_drag_margin: +.. _class_Camera2D_property_editor_draw_drag_margin: - :ref:`bool` **editor_draw_drag_margin** @@ -237,7 +245,7 @@ If ``true``, the camera only moves when reaching the vertical drag margins. If ` If ``true``, draws the camera's drag margin rectangle in the editor. Default value: ``false`` -.. _class_Camera2D_editor_draw_limits: +.. _class_Camera2D_property_editor_draw_limits: - :ref:`bool` **editor_draw_limits** @@ -249,7 +257,7 @@ If ``true``, draws the camera's drag margin rectangle in the editor. Default val If ``true``, draws the camera's limits rectangle in the editor. Default value: ``true`` -.. _class_Camera2D_editor_draw_screen: +.. _class_Camera2D_property_editor_draw_screen: - :ref:`bool` **editor_draw_screen** @@ -261,7 +269,7 @@ If ``true``, draws the camera's limits rectangle in the editor. Default value: ` If ``true``, draws the camera's screen rectangle in the editor. Default value: ``false`` -.. _class_Camera2D_limit_bottom: +.. _class_Camera2D_property_limit_bottom: - :ref:`int` **limit_bottom** @@ -273,7 +281,7 @@ If ``true``, draws the camera's screen rectangle in the editor. Default value: ` Bottom scroll limit in pixels. The camera stops moving when reaching this value. -.. _class_Camera2D_limit_left: +.. _class_Camera2D_property_limit_left: - :ref:`int` **limit_left** @@ -285,7 +293,7 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value. Left scroll limit in pixels. The camera stops moving when reaching this value. -.. _class_Camera2D_limit_right: +.. _class_Camera2D_property_limit_right: - :ref:`int` **limit_right** @@ -297,7 +305,7 @@ Left scroll limit in pixels. The camera stops moving when reaching this value. Right scroll limit in pixels. The camera stops moving when reaching this value. -.. _class_Camera2D_limit_smoothed: +.. _class_Camera2D_property_limit_smoothed: - :ref:`bool` **limit_smoothed** @@ -309,7 +317,7 @@ Right scroll limit in pixels. The camera stops moving when reaching this value. If ``true``, the camera smoothly stops when reaches its limits. Default value: ``false`` -.. _class_Camera2D_limit_top: +.. _class_Camera2D_property_limit_top: - :ref:`int` **limit_top** @@ -321,7 +329,7 @@ If ``true``, the camera smoothly stops when reaches its limits. Default value: ` Top scroll limit in pixels. The camera stops moving when reaching this value. -.. _class_Camera2D_offset: +.. _class_Camera2D_property_offset: - :ref:`Vector2` **offset** @@ -333,7 +341,7 @@ Top scroll limit in pixels. The camera stops moving when reaching this value. The camera's offset, useful for looking around or camera shake animations. -.. _class_Camera2D_offset_h: +.. _class_Camera2D_property_offset_h: - :ref:`float` **offset_h** @@ -345,7 +353,7 @@ The camera's offset, useful for looking around or camera shake animations. The horizontal offset of the camera, relative to the drag margins. Default value: ``0`` -.. _class_Camera2D_offset_v: +.. _class_Camera2D_property_offset_v: - :ref:`float` **offset_v** @@ -357,7 +365,7 @@ The horizontal offset of the camera, relative to the drag margins. Default value The vertical offset of the camera, relative to the drag margins. Default value: ``0`` -.. _class_Camera2D_process_mode: +.. _class_Camera2D_property_process_mode: - :ref:`Camera2DProcessMode` **process_mode** @@ -367,7 +375,7 @@ The vertical offset of the camera, relative to the drag margins. Default value: | *Getter* | get_process_mode() | +----------+-------------------------+ -.. _class_Camera2D_rotating: +.. _class_Camera2D_property_rotating: - :ref:`bool` **rotating** @@ -379,7 +387,7 @@ The vertical offset of the camera, relative to the drag margins. Default value: If ``true``, the camera rotates with the target. Default value: ``false`` -.. _class_Camera2D_smoothing_enabled: +.. _class_Camera2D_property_smoothing_enabled: - :ref:`bool` **smoothing_enabled** @@ -389,9 +397,9 @@ If ``true``, the camera rotates with the target. Default value: ``false`` | *Getter* | is_follow_smoothing_enabled() | +----------+------------------------------------+ -If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed`. Default value: ``false`` +If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed`. Default value: ``false`` -.. _class_Camera2D_smoothing_speed: +.. _class_Camera2D_property_smoothing_speed: - :ref:`float` **smoothing_speed** @@ -401,9 +409,9 @@ If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_spe | *Getter* | get_follow_smoothing() | +----------+-----------------------------+ -Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled` is ``true`` +Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled` is ``true`` -.. _class_Camera2D_zoom: +.. _class_Camera2D_property_zoom: - :ref:`Vector2` **zoom** @@ -418,43 +426,43 @@ The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)`` Method Descriptions ------------------- -.. _class_Camera2D_align: +.. _class_Camera2D_method_align: - void **align** **(** **)** Align the camera to the tracked node -.. _class_Camera2D_clear_current: +.. _class_Camera2D_method_clear_current: - void **clear_current** **(** **)** Removes any ``Camera2D`` from the ancestor :ref:`Viewport`'s internal currently-assigned camera. -.. _class_Camera2D_force_update_scroll: +.. _class_Camera2D_method_force_update_scroll: - void **force_update_scroll** **(** **)** Force the camera to update scroll immediately. -.. _class_Camera2D_get_camera_position: +.. _class_Camera2D_method_get_camera_position: - :ref:`Vector2` **get_camera_position** **(** **)** const Return the camera position. -.. _class_Camera2D_get_camera_screen_center: +.. _class_Camera2D_method_get_camera_screen_center: - :ref:`Vector2` **get_camera_screen_center** **(** **)** const Returns the location of the ``Camera2D``'s screen-center, relative to the origin. -.. _class_Camera2D_make_current: +.. _class_Camera2D_method_make_current: - void **make_current** **(** **)** Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. -.. _class_Camera2D_reset_smoothing: +.. _class_Camera2D_method_reset_smoothing: - void **reset_smoothing** **(** **)** diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 454ef307e..a3cb0203f 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -21,141 +21,141 @@ Base class of anything 2D. Properties ---------- -+---------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`light_mask` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`modulate` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`self_modulate` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_behind_parent` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_on_top` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_parent_material` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`visible` | -+---------------------------------+------------------------------------------------------------------+ ++---------------------------------+---------------------------------------------------------------------------+ +| :ref:`int` | :ref:`light_mask` | ++---------------------------------+---------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------+---------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`modulate` | ++---------------------------------+---------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`self_modulate` | ++---------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`show_behind_parent` | ++---------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`show_on_top` | ++---------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_parent_material` | ++---------------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`visible` | ++---------------------------------+---------------------------------------------------------------------------+ Methods ------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_draw` **(** **)** virtual | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_mesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multiline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multiline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multimesh` **(** :ref:`MultiMesh` multimesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_update_transform` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_draw` **(** **)** virtual | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_mesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_multiline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_multiline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_multimesh` **(** :ref:`MultiMesh` multimesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_update_transform` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_CanvasItem_draw: +.. _class_CanvasItem_signal_draw: - **draw** **(** **)** Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. -.. _class_CanvasItem_hide: +.. _class_CanvasItem_signal_hide: - **hide** **(** **)** Emitted when becoming hidden. -.. _class_CanvasItem_item_rect_changed: +.. _class_CanvasItem_signal_item_rect_changed: - **item_rect_changed** **(** **)** Emitted when the item rect has changed. -.. _class_CanvasItem_visibility_changed: +.. _class_CanvasItem_signal_visibility_changed: - **visibility_changed** **(** **)** @@ -166,6 +166,18 @@ Enumerations .. _enum_CanvasItem_BlendMode: +.. _class_CanvasItem_constant_BLEND_MODE_MIX: + +.. _class_CanvasItem_constant_BLEND_MODE_ADD: + +.. _class_CanvasItem_constant_BLEND_MODE_SUB: + +.. _class_CanvasItem_constant_BLEND_MODE_MUL: + +.. _class_CanvasItem_constant_BLEND_MODE_PREMULT_ALPHA: + +.. _class_CanvasItem_constant_BLEND_MODE_DISABLED: + enum **BlendMode**: - **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. @@ -183,7 +195,17 @@ enum **BlendMode**: Constants --------- -- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Canvas item transform has changed. Notification is only received if enabled by :ref:`set_notify_transform` or :ref:`set_notify_local_transform`. +.. _class_CanvasItem_constant_NOTIFICATION_TRANSFORM_CHANGED: + +.. _class_CanvasItem_constant_NOTIFICATION_DRAW: + +.. _class_CanvasItem_constant_NOTIFICATION_VISIBILITY_CHANGED: + +.. _class_CanvasItem_constant_NOTIFICATION_ENTER_CANVAS: + +.. _class_CanvasItem_constant_NOTIFICATION_EXIT_CANVAS: + +- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Canvas item transform has changed. Notification is only received if enabled by :ref:`set_notify_transform` or :ref:`set_notify_local_transform`. - **NOTIFICATION_DRAW** = **30** --- CanvasItem is requested to draw. @@ -216,7 +238,7 @@ Tutorials Property Descriptions --------------------- -.. _class_CanvasItem_light_mask: +.. _class_CanvasItem_property_light_mask: - :ref:`int` **light_mask** @@ -228,7 +250,7 @@ Property Descriptions The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` nodes. Default value: ``1``. -.. _class_CanvasItem_material: +.. _class_CanvasItem_property_material: - :ref:`Material` **material** @@ -240,7 +262,7 @@ The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` **modulate** @@ -252,7 +274,7 @@ The material applied to textures on this ``CanvasItem``. Default value: ``null`` The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white"). -.. _class_CanvasItem_self_modulate: +.. _class_CanvasItem_property_self_modulate: - :ref:`Color` **self_modulate** @@ -264,7 +286,7 @@ The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s. Default value: ``Color(1, 1, 1, 1)`` (opaque "white").. -.. _class_CanvasItem_show_behind_parent: +.. _class_CanvasItem_property_show_behind_parent: - :ref:`bool` **show_behind_parent** @@ -276,13 +298,13 @@ The color applied to textures on this ``CanvasItem``. This is not inherited by c If ``true``, the object draws behind its parent. Default value: ``false``. -.. _class_CanvasItem_show_on_top: +.. _class_CanvasItem_property_show_on_top: - :ref:`bool` **show_on_top** If ``true``, the object draws on top of its parent. Default value: ``true``. -.. _class_CanvasItem_use_parent_material: +.. _class_CanvasItem_property_use_parent_material: - :ref:`bool` **use_parent_material** @@ -292,9 +314,9 @@ If ``true``, the object draws on top of its parent. Default value: ``true``. | *Getter* | get_use_parent_material() | +----------+--------------------------------+ -If ``true``, the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. Default value: ``false``. +If ``true``, the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. Default value: ``false``. -.. _class_CanvasItem_visible: +.. _class_CanvasItem_property_visible: - :ref:`bool` **visible** @@ -309,265 +331,265 @@ If ``true``, this ``CanvasItem`` is drawn. Default value: ``true``. For controls Method Descriptions ------------------- -.. _class_CanvasItem__draw: +.. _class_CanvasItem_method__draw: - void **_draw** **(** **)** virtual Called (if exists) to draw the canvas item. -.. _class_CanvasItem_draw_char: +.. _class_CanvasItem_method_draw_char: - :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. -.. _class_CanvasItem_draw_circle: +.. _class_CanvasItem_method_draw_circle: - void **draw_circle** **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** Draws a colored circle. -.. _class_CanvasItem_draw_colored_polygon: +.. _class_CanvasItem_method_draw_colored_polygon: - void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** Draws a colored polygon of any amount of points, convex or concave. -.. _class_CanvasItem_draw_line: +.. _class_CanvasItem_method_draw_line: - void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. -.. _class_CanvasItem_draw_mesh: +.. _class_CanvasItem_method_draw_mesh: - void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** -.. _class_CanvasItem_draw_multiline: +.. _class_CanvasItem_method_draw_multiline: - void **draw_multiline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws multiple, parallel lines with a uniform ``color`` and ``width`` and optional antialiasing. -.. _class_CanvasItem_draw_multiline_colors: +.. _class_CanvasItem_method_draw_multiline_colors: - void **draw_multiline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws multiple, parallel lines with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. -.. _class_CanvasItem_draw_multimesh: +.. _class_CanvasItem_method_draw_multimesh: - void **draw_multimesh** **(** :ref:`MultiMesh` multimesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** -.. _class_CanvasItem_draw_polygon: +.. _class_CanvasItem_method_draw_polygon: - void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** Draws a polygon of any amount of points, convex or concave. -.. _class_CanvasItem_draw_polyline: +.. _class_CanvasItem_method_draw_polyline: - void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing. -.. _class_CanvasItem_draw_polyline_colors: +.. _class_CanvasItem_method_draw_polyline_colors: - void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws interconnected line segments with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. -.. _class_CanvasItem_draw_primitive: +.. _class_CanvasItem_method_draw_primitive: - void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** Draws a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. -.. _class_CanvasItem_draw_rect: +.. _class_CanvasItem_method_draw_rect: - void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** Draws a colored rectangle. -.. _class_CanvasItem_draw_set_transform: +.. _class_CanvasItem_method_draw_set_transform: - void **draw_set_transform** **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. -.. _class_CanvasItem_draw_set_transform_matrix: +.. _class_CanvasItem_method_draw_set_transform_matrix: - void **draw_set_transform_matrix** **(** :ref:`Transform2D` xform **)** Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. -.. _class_CanvasItem_draw_string: +.. _class_CanvasItem_method_draw_string: - void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** Draws a string using a custom font. -.. _class_CanvasItem_draw_style_box: +.. _class_CanvasItem_method_draw_style_box: - void **draw_style_box** **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** Draws a styled rectangle. -.. _class_CanvasItem_draw_texture: +.. _class_CanvasItem_method_draw_texture: - void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** Draws a texture at a given position. -.. _class_CanvasItem_draw_texture_rect: +.. _class_CanvasItem_method_draw_texture_rect: - void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. -.. _class_CanvasItem_draw_texture_rect_region: +.. _class_CanvasItem_method_draw_texture_rect_region: - void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. -.. _class_CanvasItem_force_update_transform: +.. _class_CanvasItem_method_force_update_transform: - void **force_update_transform** **(** **)** -.. _class_CanvasItem_get_canvas: +.. _class_CanvasItem_method_get_canvas: - :ref:`RID` **get_canvas** **(** **)** const Return the :ref:`RID` of the :ref:`World2D` canvas where this item is in. -.. _class_CanvasItem_get_canvas_item: +.. _class_CanvasItem_method_get_canvas_item: - :ref:`RID` **get_canvas_item** **(** **)** const Return the canvas item RID used by :ref:`VisualServer` for this item. -.. _class_CanvasItem_get_canvas_transform: +.. _class_CanvasItem_method_get_canvas_transform: - :ref:`Transform2D` **get_canvas_transform** **(** **)** const Get the transform matrix of this item's canvas. -.. _class_CanvasItem_get_global_mouse_position: +.. _class_CanvasItem_method_get_global_mouse_position: - :ref:`Vector2` **get_global_mouse_position** **(** **)** const Get the global position of the mouse. -.. _class_CanvasItem_get_global_transform: +.. _class_CanvasItem_method_get_global_transform: - :ref:`Transform2D` **get_global_transform** **(** **)** const Get the global transform matrix of this item. -.. _class_CanvasItem_get_global_transform_with_canvas: +.. _class_CanvasItem_method_get_global_transform_with_canvas: - :ref:`Transform2D` **get_global_transform_with_canvas** **(** **)** const Get the global transform matrix of this item in relation to the canvas. -.. _class_CanvasItem_get_local_mouse_position: +.. _class_CanvasItem_method_get_local_mouse_position: - :ref:`Vector2` **get_local_mouse_position** **(** **)** const Get the mouse position relative to this item's position. -.. _class_CanvasItem_get_transform: +.. _class_CanvasItem_method_get_transform: - :ref:`Transform2D` **get_transform** **(** **)** const Get the transform matrix of this item. -.. _class_CanvasItem_get_viewport_rect: +.. _class_CanvasItem_method_get_viewport_rect: - :ref:`Rect2` **get_viewport_rect** **(** **)** const Get the viewport's boundaries as a :ref:`Rect2`. -.. _class_CanvasItem_get_viewport_transform: +.. _class_CanvasItem_method_get_viewport_transform: - :ref:`Transform2D` **get_viewport_transform** **(** **)** const Get this item's transform in relation to the viewport. -.. _class_CanvasItem_get_world_2d: +.. _class_CanvasItem_method_get_world_2d: - :ref:`World2D` **get_world_2d** **(** **)** const Get the :ref:`World2D` where this item is in. -.. _class_CanvasItem_hide: +.. _class_CanvasItem_method_hide: - void **hide** **(** **)** Hide the CanvasItem currently visible. -.. _class_CanvasItem_is_local_transform_notification_enabled: +.. _class_CanvasItem_method_is_local_transform_notification_enabled: - :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const Returns ``true`` if local transform notifications are communicated to children. -.. _class_CanvasItem_is_set_as_toplevel: +.. _class_CanvasItem_method_is_set_as_toplevel: - :ref:`bool` **is_set_as_toplevel** **(** **)** const -Return if set as toplevel. See :ref:`set_as_toplevel`. +Return if set as toplevel. See :ref:`set_as_toplevel`. -.. _class_CanvasItem_is_transform_notification_enabled: +.. _class_CanvasItem_method_is_transform_notification_enabled: - :ref:`bool` **is_transform_notification_enabled** **(** **)** const Returns ``true`` if global transform notifications are communicated to children. -.. _class_CanvasItem_is_visible_in_tree: +.. _class_CanvasItem_method_is_visible_in_tree: - :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 its inherited visibility is also ``true``. +Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and its inherited visibility is also ``true``. -.. _class_CanvasItem_make_canvas_position_local: +.. _class_CanvasItem_method_make_canvas_position_local: - :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** const Assigns ``screen_point`` as this node's new local transform. -.. _class_CanvasItem_make_input_local: +.. _class_CanvasItem_method_make_input_local: - :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const Transformations issued by ``event``'s inputs are applied in local space instead of global space. -.. _class_CanvasItem_set_as_toplevel: +.. _class_CanvasItem_method_set_as_toplevel: - void **set_as_toplevel** **(** :ref:`bool` enable **)** Sets as top level. This means that it will not inherit transform from parent canvas items. -.. _class_CanvasItem_set_notify_local_transform: +.. _class_CanvasItem_method_set_notify_local_transform: - void **set_notify_local_transform** **(** :ref:`bool` enable **)** If ``enable`` is ``true``, children will be updated with local transform data. -.. _class_CanvasItem_set_notify_transform: +.. _class_CanvasItem_method_set_notify_transform: - void **set_notify_transform** **(** :ref:`bool` enable **)** If ``enable`` is ``true``, children will be updated with global transform data. -.. _class_CanvasItem_show: +.. _class_CanvasItem_method_show: - void **show** **(** **)** Show the CanvasItem currently hidden. For controls that inherit :ref:`Popup`, the correct way to make them visible is to call one of the multiple popup\*() functions instead. -.. _class_CanvasItem_update: +.. _class_CanvasItem_method_update: - void **update** **(** **)** diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 6feb46a08..535269ca1 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -19,25 +19,35 @@ A material for :ref:`CanvasItem`\ s. Properties ---------- -+-----------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`BlendMode` | :ref:`blend_mode` | -+-----------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`LightMode` | :ref:`light_mode` | -+-----------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_anim_h_frames` | -+-----------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_anim_loop` | -+-----------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_anim_v_frames` | -+-----------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_animation` | -+-----------------------------------------------------+----------------------------------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`BlendMode` | :ref:`blend_mode` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`LightMode` | :ref:`light_mode` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`particles_anim_h_frames` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_anim_loop` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`particles_anim_v_frames` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_animation` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_CanvasItemMaterial_BlendMode: +.. _class_CanvasItemMaterial_constant_BLEND_MODE_MIX: + +.. _class_CanvasItemMaterial_constant_BLEND_MODE_ADD: + +.. _class_CanvasItemMaterial_constant_BLEND_MODE_SUB: + +.. _class_CanvasItemMaterial_constant_BLEND_MODE_MUL: + +.. _class_CanvasItemMaterial_constant_BLEND_MODE_PREMULT_ALPHA: + enum **BlendMode**: - **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. @@ -52,6 +62,12 @@ enum **BlendMode**: .. _enum_CanvasItemMaterial_LightMode: +.. _class_CanvasItemMaterial_constant_LIGHT_MODE_NORMAL: + +.. _class_CanvasItemMaterial_constant_LIGHT_MODE_UNSHADED: + +.. _class_CanvasItemMaterial_constant_LIGHT_MODE_LIGHT_ONLY: + enum **LightMode**: - **LIGHT_MODE_NORMAL** = **0** --- Render the material using both light and non-light sensitive material properties. @@ -68,7 +84,7 @@ Description Property Descriptions --------------------- -.. _class_CanvasItemMaterial_blend_mode: +.. _class_CanvasItemMaterial_property_blend_mode: - :ref:`BlendMode` **blend_mode** @@ -80,7 +96,7 @@ Property Descriptions The manner in which a material's rendering is applied to underlying textures. -.. _class_CanvasItemMaterial_light_mode: +.. _class_CanvasItemMaterial_property_light_mode: - :ref:`LightMode` **light_mode** @@ -92,7 +108,7 @@ The manner in which a material's rendering is applied to underlying textures. The manner in which material reacts to lighting. -.. _class_CanvasItemMaterial_particles_anim_h_frames: +.. _class_CanvasItemMaterial_property_particles_anim_h_frames: - :ref:`int` **particles_anim_h_frames** @@ -102,7 +118,7 @@ The manner in which material reacts to lighting. | *Getter* | get_particles_anim_h_frames() | +----------+------------------------------------+ -.. _class_CanvasItemMaterial_particles_anim_loop: +.. _class_CanvasItemMaterial_property_particles_anim_loop: - :ref:`bool` **particles_anim_loop** @@ -112,7 +128,7 @@ The manner in which material reacts to lighting. | *Getter* | get_particles_anim_loop() | +----------+--------------------------------+ -.. _class_CanvasItemMaterial_particles_anim_v_frames: +.. _class_CanvasItemMaterial_property_particles_anim_v_frames: - :ref:`int` **particles_anim_v_frames** @@ -122,7 +138,7 @@ The manner in which material reacts to lighting. | *Getter* | get_particles_anim_v_frames() | +----------+------------------------------------+ -.. _class_CanvasItemMaterial_particles_animation: +.. _class_CanvasItemMaterial_property_particles_animation: - :ref:`bool` **particles_animation** diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 2d6c69324..02839c35a 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -21,28 +21,28 @@ Canvas drawing layer. Properties ---------- -+---------------------------------------+-------------------------------------------------------------+ -| :ref:`Node` | :ref:`custom_viewport` | -+---------------------------------------+-------------------------------------------------------------+ -| :ref:`int` | :ref:`layer` | -+---------------------------------------+-------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+---------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation` | -+---------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation_degrees` | -+---------------------------------------+-------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scale` | -+---------------------------------------+-------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | -+---------------------------------------+-------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------+ +| :ref:`Node` | :ref:`custom_viewport` | ++---------------------------------------+----------------------------------------------------------------------+ +| :ref:`int` | :ref:`layer` | ++---------------------------------------+----------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`offset` | ++---------------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`rotation` | ++---------------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`rotation_degrees` | ++---------------------------------------+----------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`scale` | ++---------------------------------------+----------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`transform` | ++---------------------------------------+----------------------------------------------------------------------+ Methods ------- -+------------------------+-------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | -+------------------------+-------------------------------------------------------------------+ ++-----------------------+--------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | ++-----------------------+--------------------------------------------------------------------------+ Description ----------- @@ -59,7 +59,7 @@ Tutorials Property Descriptions --------------------- -.. _class_CanvasLayer_custom_viewport: +.. _class_CanvasLayer_property_custom_viewport: - :ref:`Node` **custom_viewport** @@ -71,7 +71,7 @@ Property Descriptions The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead. -.. _class_CanvasLayer_layer: +.. _class_CanvasLayer_property_layer: - :ref:`int` **layer** @@ -83,7 +83,7 @@ The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. Layer index for draw order. Lower values are drawn first. Default value: ``1``. -.. _class_CanvasLayer_offset: +.. _class_CanvasLayer_property_offset: - :ref:`Vector2` **offset** @@ -95,7 +95,7 @@ Layer index for draw order. Lower values are drawn first. Default value: ``1``. The layer's base offset. -.. _class_CanvasLayer_rotation: +.. _class_CanvasLayer_property_rotation: - :ref:`float` **rotation** @@ -107,7 +107,7 @@ The layer's base offset. The layer's rotation in radians. -.. _class_CanvasLayer_rotation_degrees: +.. _class_CanvasLayer_property_rotation_degrees: - :ref:`float` **rotation_degrees** @@ -119,7 +119,7 @@ The layer's rotation in radians. The layer's rotation in degrees. -.. _class_CanvasLayer_scale: +.. _class_CanvasLayer_property_scale: - :ref:`Vector2` **scale** @@ -131,7 +131,7 @@ The layer's rotation in degrees. The layer's scale. -.. _class_CanvasLayer_transform: +.. _class_CanvasLayer_property_transform: - :ref:`Transform2D` **transform** @@ -146,7 +146,7 @@ The layer's transform. Method Descriptions ------------------- -.. _class_CanvasLayer_get_canvas: +.. _class_CanvasLayer_method_get_canvas: - :ref:`RID` **get_canvas** **(** **)** const diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index e91987c74..dd0b74957 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -19,9 +19,9 @@ Tint the entire canvas. Properties ---------- -+---------------------------+------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+------------------------------------------+ ++---------------------------+---------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------+---------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Description Property Descriptions --------------------- -.. _class_CanvasModulate_color: +.. _class_CanvasModulate_property_color: - :ref:`Color` **color** diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 21b9802a6..f903f87c1 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -19,15 +19,15 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh`. Properties ---------- -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`mid_height` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`radial_segments` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`rings` | -+---------------------------+-----------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`mid_height` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`radial_segments` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`rings` | ++---------------------------+--------------------------------------------------------------------+ Description ----------- @@ -37,7 +37,7 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh`. Property Descriptions --------------------- -.. _class_CapsuleMesh_mid_height: +.. _class_CapsuleMesh_property_mid_height: - :ref:`float` **mid_height** @@ -49,7 +49,7 @@ Property Descriptions Height of the capsule mesh from the center point. Defaults to 1.0. -.. _class_CapsuleMesh_radial_segments: +.. _class_CapsuleMesh_property_radial_segments: - :ref:`int` **radial_segments** @@ -61,7 +61,7 @@ Height of the capsule mesh from the center point. Defaults to 1.0. Number of radial segments on the capsule mesh. Defaults to 64. -.. _class_CapsuleMesh_radius: +.. _class_CapsuleMesh_property_radius: - :ref:`float` **radius** @@ -73,7 +73,7 @@ Number of radial segments on the capsule mesh. Defaults to 64. Radius of the capsule mesh. Defaults to 1.0. -.. _class_CapsuleMesh_rings: +.. _class_CapsuleMesh_property_rings: - :ref:`int` **rings** diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index d10bd8485..a20efe40d 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -19,11 +19,11 @@ Capsule shape for collisions. Properties ---------- -+---------------------------+------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+------------------------------------------+ ++---------------------------+---------------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------+---------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+---------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Capsule shape for collisions. Property Descriptions --------------------- -.. _class_CapsuleShape_height: +.. _class_CapsuleShape_property_height: - :ref:`float` **height** @@ -45,7 +45,7 @@ Property Descriptions The capsule's height. -.. _class_CapsuleShape_radius: +.. _class_CapsuleShape_property_radius: - :ref:`float` **radius** diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 671041430..6fccaf789 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -19,11 +19,11 @@ Capsule shape for 2D collisions. Properties ---------- -+---------------------------+--------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+--------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+--------------------------------------------+ ++---------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+-----------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Capsule shape for 2D collisions. Property Descriptions --------------------- -.. _class_CapsuleShape2D_height: +.. _class_CapsuleShape2D_property_height: - :ref:`float` **height** @@ -45,7 +45,7 @@ Property Descriptions The capsule's height. -.. _class_CapsuleShape2D_radius: +.. _class_CapsuleShape2D_property_radius: - :ref:`float` **radius** diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index c7332700d..320bec636 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -19,9 +19,9 @@ Keeps children controls centered. Properties ---------- -+-------------------------+---------------------------------------------------------+ -| :ref:`bool` | :ref:`use_top_left` | -+-------------------------+---------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_top_left` | ++-------------------------+------------------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ CenterContainer Keeps children controls centered. This container keeps all child Property Descriptions --------------------- -.. _class_CenterContainer_use_top_left: +.. _class_CenterContainer_property_use_top_left: - :ref:`bool` **use_top_left** diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 0f506e698..332f4f5bd 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -19,43 +19,43 @@ Binary choice user interface widget. Theme Properties ---------------- -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`check_vadjust` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`checked` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`disabled` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover_pressed` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_pressed` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover_pressed` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`pressed` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`radio_checked` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`radio_unchecked` | -+---------------------------------+--------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`unchecked` | -+---------------------------------+--------------------------------------------------------------------------+ ++---------------------------------+--------------------------+ +| :ref:`int` | check_vadjust | ++---------------------------------+--------------------------+ +| :ref:`Texture` | checked | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | disabled | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+--------------------------+ +| :ref:`Font` | font | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color_hover | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color_hover_pressed | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color_pressed | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | hover | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | hover_pressed | ++---------------------------------+--------------------------+ +| :ref:`int` | hseparation | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | pressed | ++---------------------------------+--------------------------+ +| :ref:`Texture` | radio_checked | ++---------------------------------+--------------------------+ +| :ref:`Texture` | radio_unchecked | ++---------------------------------+--------------------------+ +| :ref:`Texture` | unchecked | ++---------------------------------+--------------------------+ Description ----------- diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index 65688a907..77aaaf8b9 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -19,39 +19,39 @@ Checkable button. Theme Properties ---------------- -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`check_vadjust` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`disabled` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover_pressed` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_pressed` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover_pressed` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`off` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`on` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`pressed` | -+---------------------------------+-----------------------------------------------------------------------------+ ++---------------------------------+--------------------------+ +| :ref:`int` | check_vadjust | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | disabled | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+--------------------------+ +| :ref:`Font` | font | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color_hover | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color_hover_pressed | ++---------------------------------+--------------------------+ +| :ref:`Color` | font_color_pressed | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | hover | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | hover_pressed | ++---------------------------------+--------------------------+ +| :ref:`int` | hseparation | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+--------------------------+ +| :ref:`Texture` | off | ++---------------------------------+--------------------------+ +| :ref:`Texture` | on | ++---------------------------------+--------------------------+ +| :ref:`StyleBox` | pressed | ++---------------------------------+--------------------------+ Description ----------- diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 36e4188e7..368e47d17 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -19,9 +19,9 @@ Circular shape for 2D collisions. Properties ---------- -+---------------------------+-------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+-------------------------------------------+ ++---------------------------+----------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+----------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Circular shape for 2D collisions. This shape is useful for modeling balls or sma Property Descriptions --------------------- -.. _class_CircleShape2D_radius: +.. _class_CircleShape2D_property_radius: - :ref:`float` **radius** diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 5d693719f..fce64b208 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -19,47 +19,47 @@ Class information repository. 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 | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -69,121 +69,121 @@ Provides access to metadata stored for every available class. Method Descriptions ------------------- -.. _class_ClassDB_can_instance: +.. _class_ClassDB_method_can_instance: - :ref:`bool` **can_instance** **(** :ref:`String` class **)** const Returns true if you can instance objects from the specified 'class', false in other case. -.. _class_ClassDB_class_exists: +.. _class_ClassDB_method_class_exists: - :ref:`bool` **class_exists** **(** :ref:`String` class **)** const Returns whether the specified 'class' is available or not. -.. _class_ClassDB_class_get_category: +.. _class_ClassDB_method_class_get_category: - :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. -.. _class_ClassDB_class_get_integer_constant: +.. _class_ClassDB_method_class_get_integer_constant: - :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. -.. _class_ClassDB_class_get_integer_constant_list: +.. _class_ClassDB_method_class_get_integer_constant_list: - :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. -.. _class_ClassDB_class_get_method_list: +.. _class_ClassDB_method_class_get_method_list: - :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). -.. _class_ClassDB_class_get_property: +.. _class_ClassDB_method_class_get_property: - :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const Returns the value of 'property' of 'class' or its ancestry. -.. _class_ClassDB_class_get_property_list: +.. _class_ClassDB_method_class_get_property_list: - :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. -.. _class_ClassDB_class_get_signal: +.. _class_ClassDB_method_class_get_signal: - :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). -.. _class_ClassDB_class_get_signal_list: +.. _class_ClassDB_method_class_get_signal_list: - :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`. +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`. -.. _class_ClassDB_class_has_integer_constant: +.. _class_ClassDB_method_class_has_integer_constant: - :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const Return whether 'class' or its ancestry has an integer constant called 'name' or not. -.. _class_ClassDB_class_has_method: +.. _class_ClassDB_method_class_has_method: - :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. -.. _class_ClassDB_class_has_signal: +.. _class_ClassDB_method_class_has_signal: - :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const Return whether 'class' or its ancestry has a signal called 'signal' or not. -.. _class_ClassDB_class_set_property: +.. _class_ClassDB_method_class_set_property: - :ref:`Error` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const Sets 'property' value of 'class' to 'value'. -.. _class_ClassDB_get_class_list: +.. _class_ClassDB_method_get_class_list: - :ref:`PoolStringArray` **get_class_list** **(** **)** const Returns the names of all the classes available. -.. _class_ClassDB_get_inheriters_from_class: +.. _class_ClassDB_method_get_inheriters_from_class: - :ref:`PoolStringArray` **get_inheriters_from_class** **(** :ref:`String` class **)** const Returns the names of all the classes that directly or indirectly inherit from 'class'. -.. _class_ClassDB_get_parent_class: +.. _class_ClassDB_method_get_parent_class: - :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const Returns the parent class of 'class'. -.. _class_ClassDB_instance: +.. _class_ClassDB_method_instance: - :ref:`Variant` **instance** **(** :ref:`String` class **)** const Creates an instance of 'class'. -.. _class_ClassDB_is_class_enabled: +.. _class_ClassDB_method_is_class_enabled: - :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const Returns whether this class is enabled or not. -.. _class_ClassDB_is_parent_class: +.. _class_ClassDB_method_is_parent_class: - :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const diff --git a/classes/class_clippedcamera.rst b/classes/class_clippedcamera.rst index f3a3bae72..c7843e93d 100644 --- a/classes/class_clippedcamera.rst +++ b/classes/class_clippedcamera.rst @@ -19,42 +19,46 @@ Brief Description Properties ---------- -+----------------------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`clip_to_areas` | -+----------------------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`clip_to_bodies` | -+----------------------------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+----------------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`margin` | -+----------------------------------------------------+-----------------------------------------------------------+ -| :ref:`ProcessMode` | :ref:`process_mode` | -+----------------------------------------------------+-----------------------------------------------------------+ ++----------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`clip_to_areas` | ++----------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`clip_to_bodies` | ++----------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++----------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin` | ++----------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`ProcessMode` | :ref:`process_mode` | ++----------------------------------------------------+--------------------------------------------------------------------+ Methods ------- -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception` **(** :ref:`Object` node **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_exceptions` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception` **(** :ref:`Object` node **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_exceptions` **(** **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_ClippedCamera_ProcessMode: +.. _class_ClippedCamera_constant_CLIP_PROCESS_PHYSICS: + +.. _class_ClippedCamera_constant_CLIP_PROCESS_IDLE: + enum **ProcessMode**: - **CLIP_PROCESS_PHYSICS** = **0** @@ -64,7 +68,7 @@ enum **ProcessMode**: Property Descriptions --------------------- -.. _class_ClippedCamera_clip_to_areas: +.. _class_ClippedCamera_property_clip_to_areas: - :ref:`bool` **clip_to_areas** @@ -74,7 +78,7 @@ Property Descriptions | *Getter* | is_clip_to_areas_enabled() | +----------+----------------------------+ -.. _class_ClippedCamera_clip_to_bodies: +.. _class_ClippedCamera_property_clip_to_bodies: - :ref:`bool` **clip_to_bodies** @@ -84,7 +88,7 @@ Property Descriptions | *Getter* | is_clip_to_bodies_enabled() | +----------+-----------------------------+ -.. _class_ClippedCamera_collision_mask: +.. _class_ClippedCamera_property_collision_mask: - :ref:`int` **collision_mask** @@ -94,7 +98,7 @@ Property Descriptions | *Getter* | get_collision_mask() | +----------+---------------------------+ -.. _class_ClippedCamera_margin: +.. _class_ClippedCamera_property_margin: - :ref:`float` **margin** @@ -104,7 +108,7 @@ Property Descriptions | *Getter* | get_margin() | +----------+-------------------+ -.. _class_ClippedCamera_process_mode: +.. _class_ClippedCamera_property_process_mode: - :ref:`ProcessMode` **process_mode** @@ -117,31 +121,31 @@ Property Descriptions Method Descriptions ------------------- -.. _class_ClippedCamera_add_exception: +.. _class_ClippedCamera_method_add_exception: - void **add_exception** **(** :ref:`Object` node **)** -.. _class_ClippedCamera_add_exception_rid: +.. _class_ClippedCamera_method_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** -.. _class_ClippedCamera_clear_exceptions: +.. _class_ClippedCamera_method_clear_exceptions: - void **clear_exceptions** **(** **)** -.. _class_ClippedCamera_get_collision_mask_bit: +.. _class_ClippedCamera_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -.. _class_ClippedCamera_remove_exception: +.. _class_ClippedCamera_method_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** -.. _class_ClippedCamera_remove_exception_rid: +.. _class_ClippedCamera_method_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** -.. _class_ClippedCamera_set_collision_mask_bit: +.. _class_ClippedCamera_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index c8a5b597f..829c2d6bd 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -21,67 +21,67 @@ Base node for collision objects. Properties ---------- -+-------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_capture_on_drag` | -+-------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_ray_pickable` | -+-------------------------+---------------------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_capture_on_drag` | ++-------------------------+------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_ray_pickable` | ++-------------------------+------------------------------------------------------------------------------------+ 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 ------- -.. _class_CollisionObject_input_event: +.. _class_CollisionObject_signal_input_event: - **input_event** **(** :ref:`Node` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** -Emitted when :ref:`_input_event` receives an event. See its description for details. +Emitted when :ref:`_input_event` receives an event. See its description for details. -.. _class_CollisionObject_mouse_entered: +.. _class_CollisionObject_signal_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. -.. _class_CollisionObject_mouse_exited: +.. _class_CollisionObject_signal_mouse_exited: - **mouse_exited** **(** **)** @@ -95,7 +95,7 @@ CollisionObject is the base class for physics objects. It can hold any number of Property Descriptions --------------------- -.. _class_CollisionObject_input_capture_on_drag: +.. _class_CollisionObject_property_input_capture_on_drag: - :ref:`bool` **input_capture_on_drag** @@ -107,7 +107,7 @@ Property Descriptions If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``. -.. _class_CollisionObject_input_ray_pickable: +.. _class_CollisionObject_property_input_ray_pickable: - :ref:`bool` **input_ray_pickable** @@ -122,103 +122,103 @@ If ``true``, the :ref:`CollisionObject`'s shapes will res Method Descriptions ------------------- -.. _class_CollisionObject__input_event: +.. _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 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. -.. _class_CollisionObject_create_shape_owner: +.. _class_CollisionObject_method_create_shape_owner: - :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. -.. _class_CollisionObject_get_rid: +.. _class_CollisionObject_method_get_rid: - :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. -.. _class_CollisionObject_get_shape_owners: +.. _class_CollisionObject_method_get_shape_owners: - :ref:`Array` **get_shape_owners** **(** **)** Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. -.. _class_CollisionObject_is_shape_owner_disabled: +.. _class_CollisionObject_method_is_shape_owner_disabled: - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const If ``true``, the shape owner and its shapes are disabled. -.. _class_CollisionObject_remove_shape_owner: +.. _class_CollisionObject_method_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. -.. _class_CollisionObject_shape_find_owner: +.. _class_CollisionObject_method_shape_find_owner: - :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const Returns the ``owner_id`` of the given shape. -.. _class_CollisionObject_shape_owner_add_shape: +.. _class_CollisionObject_method_shape_owner_add_shape: - void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape` shape **)** Adds a :ref:`Shape` to the shape owner. -.. _class_CollisionObject_shape_owner_clear_shapes: +.. _class_CollisionObject_method_shape_owner_clear_shapes: - void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Removes all shapes from the shape owner. -.. _class_CollisionObject_shape_owner_get_owner: +.. _class_CollisionObject_method_shape_owner_get_owner: - :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const Returns the parent object of the given shape owner. -.. _class_CollisionObject_shape_owner_get_shape: +.. _class_CollisionObject_method_shape_owner_get_shape: - :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. -.. _class_CollisionObject_shape_owner_get_shape_count: +.. _class_CollisionObject_method_shape_owner_get_shape_count: - :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns the number of shapes the given shape owner contains. -.. _class_CollisionObject_shape_owner_get_shape_index: +.. _class_CollisionObject_method_shape_owner_get_shape_index: - :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. -.. _class_CollisionObject_shape_owner_get_transform: +.. _class_CollisionObject_method_shape_owner_get_transform: - :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Returns the shape owner's :ref:`Transform`. -.. _class_CollisionObject_shape_owner_remove_shape: +.. _class_CollisionObject_method_shape_owner_remove_shape: - void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes a shape from the given shape owner. -.. _class_CollisionObject_shape_owner_set_disabled: +.. _class_CollisionObject_method_shape_owner_set_disabled: - void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** If ``true``, disables the given shape owner. -.. _class_CollisionObject_shape_owner_set_transform: +.. _class_CollisionObject_method_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)** diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 9ebab8250..0aec1e4aa 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -21,69 +21,69 @@ Base node for 2D collision objects. Properties ---------- -+-------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_pickable` | -+-------------------------+---------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_pickable` | ++-------------------------+------------------------------------------------------------------------+ 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:`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_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:`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_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_CollisionObject2D_input_event: +.. _class_CollisionObject2D_signal_input_event: - **input_event** **(** :ref:`Node` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** -Emitted when an input event occurs and ``input_pickable`` is ``true``. See :ref:`_input_event` for details. +Emitted when an input event occurs and ``input_pickable`` is ``true``. See :ref:`_input_event` for details. -.. _class_CollisionObject2D_mouse_entered: +.. _class_CollisionObject2D_signal_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. -.. _class_CollisionObject2D_mouse_exited: +.. _class_CollisionObject2D_signal_mouse_exited: - **mouse_exited** **(** **)** @@ -97,7 +97,7 @@ CollisionObject2D is the base class for 2D physics objects. It can hold any numb Property Descriptions --------------------- -.. _class_CollisionObject2D_input_pickable: +.. _class_CollisionObject2D_property_input_pickable: - :ref:`bool` **input_pickable** @@ -112,115 +112,115 @@ If ``true``, this object is pickable. A pickable object can detect the mouse poi Method Descriptions ------------------- -.. _class_CollisionObject2D__input_event: +.. _class_CollisionObject2D_method__input_event: - void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual Accepts unhandled :ref:`InputEvent`\ s. ``shape_idx`` is the child index of the clicked :ref:`Shape2D`. Connect to the ``input_event`` signal to easily pick up these events. -.. _class_CollisionObject2D_create_shape_owner: +.. _class_CollisionObject2D_method_create_shape_owner: - :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. -.. _class_CollisionObject2D_get_rid: +.. _class_CollisionObject2D_method_get_rid: - :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. -.. _class_CollisionObject2D_get_shape_owners: +.. _class_CollisionObject2D_method_get_shape_owners: - :ref:`Array` **get_shape_owners** **(** **)** Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. -.. _class_CollisionObject2D_is_shape_owner_disabled: +.. _class_CollisionObject2D_method_is_shape_owner_disabled: - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const If ``true``, the shape owner and its shapes are disabled. -.. _class_CollisionObject2D_is_shape_owner_one_way_collision_enabled: +.. _class_CollisionObject2D_method_is_shape_owner_one_way_collision_enabled: - :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. -.. _class_CollisionObject2D_remove_shape_owner: +.. _class_CollisionObject2D_method_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. -.. _class_CollisionObject2D_shape_find_owner: +.. _class_CollisionObject2D_method_shape_find_owner: - :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const Returns the ``owner_id`` of the given shape. -.. _class_CollisionObject2D_shape_owner_add_shape: +.. _class_CollisionObject2D_method_shape_owner_add_shape: - void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** Adds a :ref:`Shape2D` to the shape owner. -.. _class_CollisionObject2D_shape_owner_clear_shapes: +.. _class_CollisionObject2D_method_shape_owner_clear_shapes: - void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Removes all shapes from the shape owner. -.. _class_CollisionObject2D_shape_owner_get_owner: +.. _class_CollisionObject2D_method_shape_owner_get_owner: - :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const Returns the parent object of the given shape owner. -.. _class_CollisionObject2D_shape_owner_get_shape: +.. _class_CollisionObject2D_method_shape_owner_get_shape: - :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. -.. _class_CollisionObject2D_shape_owner_get_shape_count: +.. _class_CollisionObject2D_method_shape_owner_get_shape_count: - :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns the number of shapes the given shape owner contains. -.. _class_CollisionObject2D_shape_owner_get_shape_index: +.. _class_CollisionObject2D_method_shape_owner_get_shape_index: - :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. -.. _class_CollisionObject2D_shape_owner_get_transform: +.. _class_CollisionObject2D_method_shape_owner_get_transform: - :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Returns the shape owner's :ref:`Transform2D`. -.. _class_CollisionObject2D_shape_owner_remove_shape: +.. _class_CollisionObject2D_method_shape_owner_remove_shape: - void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes a shape from the given shape owner. -.. _class_CollisionObject2D_shape_owner_set_disabled: +.. _class_CollisionObject2D_method_shape_owner_set_disabled: - void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** If ``true``, disables the given shape owner. -.. _class_CollisionObject2D_shape_owner_set_one_way_collision: +.. _class_CollisionObject2D_method_shape_owner_set_one_way_collision: - void **shape_owner_set_one_way_collision** **(** :ref:`int` owner_id, :ref:`bool` enable **)** If ``enable`` is ``true``, collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. -.. _class_CollisionObject2D_shape_owner_set_transform: +.. _class_CollisionObject2D_method_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index a94737564..a686e925b 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -19,13 +19,13 @@ Editor-only class for defining a collision polygon in 3D space. Properties ---------- -+-------------------------------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`depth` | -+-------------------------------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+-------------------------------------------------+--------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+-------------------------------------------------+--------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`depth` | ++-------------------------------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++-------------------------------------------------+-----------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | ++-------------------------------------------------+-----------------------------------------------------------+ Description ----------- @@ -35,7 +35,7 @@ Allows editing a collision polygon's vertices on a selected plane. Can also set Property Descriptions --------------------- -.. _class_CollisionPolygon_depth: +.. _class_CollisionPolygon_property_depth: - :ref:`float` **depth** @@ -47,7 +47,7 @@ Property Descriptions Length that the resulting collision extends in either direction perpendicular to its polygon. -.. _class_CollisionPolygon_disabled: +.. _class_CollisionPolygon_property_disabled: - :ref:`bool` **disabled** @@ -59,7 +59,7 @@ Length that the resulting collision extends in either direction perpendicular to If true, no collision will be produced. -.. _class_CollisionPolygon_polygon: +.. _class_CollisionPolygon_property_polygon: - :ref:`PoolVector2Array` **polygon** diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 28e92c9fa..ff8086fc0 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -19,21 +19,25 @@ Defines a 2D collision polygon. Properties ---------- -+-----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`BuildMode` | :ref:`build_mode` | -+-----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+-----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_way_collision` | -+-----------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+-----------------------------------------------------+----------------------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`BuildMode` | :ref:`build_mode` | ++-----------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++-----------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`one_way_collision` | ++-----------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | ++-----------------------------------------------------+-------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_CollisionPolygon2D_BuildMode: +.. _class_CollisionPolygon2D_constant_BUILD_SOLIDS: + +.. _class_CollisionPolygon2D_constant_BUILD_SEGMENTS: + enum **BuildMode**: - **BUILD_SOLIDS** = **0** --- Collisions will include the polygon and its contained area. @@ -48,7 +52,7 @@ Provides a 2D collision polygon to a :ref:`CollisionObject2D` **build_mode** @@ -60,7 +64,7 @@ Property Descriptions Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``. -.. _class_CollisionPolygon2D_disabled: +.. _class_CollisionPolygon2D_property_disabled: - :ref:`bool` **disabled** @@ -72,7 +76,7 @@ Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUI If ``true``, no collisions will be detected. -.. _class_CollisionPolygon2D_one_way_collision: +.. _class_CollisionPolygon2D_property_one_way_collision: - :ref:`bool` **one_way_collision** @@ -84,7 +88,7 @@ If ``true``, no collisions will be detected. If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. -.. _class_CollisionPolygon2D_polygon: +.. _class_CollisionPolygon2D_property_polygon: - :ref:`PoolVector2Array` **polygon** diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 1292b7bd2..87da83bb6 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -19,25 +19,25 @@ Node that represents collision shape data in 3D space. Properties ---------- -+---------------------------+------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+---------------------------+------------------------------------------------+ -| :ref:`Shape` | :ref:`shape` | -+---------------------------+------------------------------------------------+ ++---------------------------+---------------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++---------------------------+---------------------------------------------------------+ +| :ref:`Shape` | :ref:`shape` | ++---------------------------+---------------------------------------------------------+ Methods ------- -+-------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_convex_from_brothers` **(** **)** | -+-------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | -+-------+---------------------------------------------------------------------------------------------------------------------+ ++------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_convex_from_brothers` **(** **)** | ++------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | ++------+----------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area` to give it a detection shape, or add it to a :ref:`PhysicsBody` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject.shape_owner_get_shape` to get the actual shape. +Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area` to give it a detection shape, or add it to a :ref:`PhysicsBody` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject.shape_owner_get_shape` to get the actual shape. Tutorials --------- @@ -47,7 +47,7 @@ Tutorials Property Descriptions --------------------- -.. _class_CollisionShape_disabled: +.. _class_CollisionShape_property_disabled: - :ref:`bool` **disabled** @@ -59,7 +59,7 @@ Property Descriptions A disabled collision shape has no effect in the world. -.. _class_CollisionShape_shape: +.. _class_CollisionShape_property_shape: - :ref:`Shape` **shape** @@ -74,13 +74,13 @@ The actual shape owned by this collision shape. Method Descriptions ------------------- -.. _class_CollisionShape_make_convex_from_brothers: +.. _class_CollisionShape_method_make_convex_from_brothers: - void **make_convex_from_brothers** **(** **)** Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance` siblings geometry. -.. _class_CollisionShape_resource_changed: +.. _class_CollisionShape_method_resource_changed: - void **resource_changed** **(** :ref:`Resource` resource **)** diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 518c756b8..6655819f4 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -19,18 +19,18 @@ Node that represents collision shape data in 2D space. Properties ---------- -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disabled` | -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_way_collision` | -+-------------------------------+--------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`shape` | -+-------------------------------+--------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++-------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`one_way_collision` | ++-------------------------------+-----------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`shape` | ++-------------------------------+-----------------------------------------------------------------------------+ Description ----------- -Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D` to give it a detection shape, or add it to a :ref:`PhysicsBody2D` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject2D.shape_owner_get_shape` to get the actual shape. +Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D` to give it a detection shape, or add it to a :ref:`PhysicsBody2D` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`CollisionObject2D.shape_owner_get_shape` to get the actual shape. Tutorials --------- @@ -40,7 +40,7 @@ Tutorials Property Descriptions --------------------- -.. _class_CollisionShape2D_disabled: +.. _class_CollisionShape2D_property_disabled: - :ref:`bool` **disabled** @@ -52,7 +52,7 @@ Property Descriptions A disabled collision shape has no effect in the world. -.. _class_CollisionShape2D_one_way_collision: +.. _class_CollisionShape2D_property_one_way_collision: - :ref:`bool` **one_way_collision** @@ -64,7 +64,7 @@ A disabled collision shape has no effect in the world. Sets whether this collision shape should only detect collision on one side (top or bottom). -.. _class_CollisionShape2D_shape: +.. _class_CollisionShape2D_property_shape: - :ref:`Shape2D` **shape** diff --git a/classes/class_color.rst b/classes/class_color.rst index c748fecde..e722de6b3 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -17,76 +17,366 @@ Color in RGBA format with some support for ARGB format. Properties ---------- -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`a` | -+---------------------------+---------------------------+ -| :ref:`int` | :ref:`a8` | -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`b` | -+---------------------------+---------------------------+ -| :ref:`int` | :ref:`b8` | -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`g` | -+---------------------------+---------------------------+ -| :ref:`int` | :ref:`g8` | -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`h` | -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`r` | -+---------------------------+---------------------------+ -| :ref:`int` | :ref:`r8` | -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`s` | -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`v` | -+---------------------------+---------------------------+ ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`a` | ++---------------------------+------------------------------------+ +| :ref:`int` | :ref:`a8` | ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`b` | ++---------------------------+------------------------------------+ +| :ref:`int` | :ref:`b8` | ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`g` | ++---------------------------+------------------------------------+ +| :ref:`int` | :ref:`g8` | ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`h` | ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`r` | ++---------------------------+------------------------------------+ +| :ref:`int` | :ref:`r8` | ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`s` | ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`v` | ++---------------------------+------------------------------------+ Methods ------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`int` from **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`contrasted` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`darkened` **(** :ref:`float` amount **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`from_hsv` **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gray` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`inverted` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`lightened` **(** :ref:`float` amount **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_abgr32` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_abgr64` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_argb32` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_argb64` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=True **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_rgba32` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_rgba64` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`int` from **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`contrasted` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`darkened` **(** :ref:`float` amount **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`from_hsv` **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gray` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`inverted` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`lightened` **(** :ref:`float` amount **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_abgr32` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_abgr64` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_argb32` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_argb64` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=True **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_rgba32` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_rgba64` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_Color_constant_gray: + +.. _class_Color_constant_aliceblue: + +.. _class_Color_constant_antiquewhite: + +.. _class_Color_constant_aqua: + +.. _class_Color_constant_aquamarine: + +.. _class_Color_constant_azure: + +.. _class_Color_constant_beige: + +.. _class_Color_constant_bisque: + +.. _class_Color_constant_black: + +.. _class_Color_constant_blanchedalmond: + +.. _class_Color_constant_blue: + +.. _class_Color_constant_blueviolet: + +.. _class_Color_constant_brown: + +.. _class_Color_constant_burlywood: + +.. _class_Color_constant_cadetblue: + +.. _class_Color_constant_chartreuse: + +.. _class_Color_constant_chocolate: + +.. _class_Color_constant_coral: + +.. _class_Color_constant_cornflower: + +.. _class_Color_constant_cornsilk: + +.. _class_Color_constant_crimson: + +.. _class_Color_constant_cyan: + +.. _class_Color_constant_darkblue: + +.. _class_Color_constant_darkcyan: + +.. _class_Color_constant_darkgoldenrod: + +.. _class_Color_constant_darkgray: + +.. _class_Color_constant_darkgreen: + +.. _class_Color_constant_darkkhaki: + +.. _class_Color_constant_darkmagenta: + +.. _class_Color_constant_darkolivegreen: + +.. _class_Color_constant_darkorange: + +.. _class_Color_constant_darkorchid: + +.. _class_Color_constant_darkred: + +.. _class_Color_constant_darksalmon: + +.. _class_Color_constant_darkseagreen: + +.. _class_Color_constant_darkslateblue: + +.. _class_Color_constant_darkslategray: + +.. _class_Color_constant_darkturquoise: + +.. _class_Color_constant_darkviolet: + +.. _class_Color_constant_deeppink: + +.. _class_Color_constant_deepskyblue: + +.. _class_Color_constant_dimgray: + +.. _class_Color_constant_dodgerblue: + +.. _class_Color_constant_firebrick: + +.. _class_Color_constant_floralwhite: + +.. _class_Color_constant_forestgreen: + +.. _class_Color_constant_fuchsia: + +.. _class_Color_constant_gainsboro: + +.. _class_Color_constant_ghostwhite: + +.. _class_Color_constant_gold: + +.. _class_Color_constant_goldenrod: + +.. _class_Color_constant_green: + +.. _class_Color_constant_greenyellow: + +.. _class_Color_constant_honeydew: + +.. _class_Color_constant_hotpink: + +.. _class_Color_constant_indianred: + +.. _class_Color_constant_indigo: + +.. _class_Color_constant_ivory: + +.. _class_Color_constant_khaki: + +.. _class_Color_constant_lavender: + +.. _class_Color_constant_lavenderblush: + +.. _class_Color_constant_lawngreen: + +.. _class_Color_constant_lemonchiffon: + +.. _class_Color_constant_lightblue: + +.. _class_Color_constant_lightcoral: + +.. _class_Color_constant_lightcyan: + +.. _class_Color_constant_lightgoldenrod: + +.. _class_Color_constant_lightgray: + +.. _class_Color_constant_lightgreen: + +.. _class_Color_constant_lightpink: + +.. _class_Color_constant_lightsalmon: + +.. _class_Color_constant_lightseagreen: + +.. _class_Color_constant_lightskyblue: + +.. _class_Color_constant_lightslategray: + +.. _class_Color_constant_lightsteelblue: + +.. _class_Color_constant_lightyellow: + +.. _class_Color_constant_lime: + +.. _class_Color_constant_limegreen: + +.. _class_Color_constant_linen: + +.. _class_Color_constant_magenta: + +.. _class_Color_constant_maroon: + +.. _class_Color_constant_mediumaquamarine: + +.. _class_Color_constant_mediumblue: + +.. _class_Color_constant_mediumorchid: + +.. _class_Color_constant_mediumpurple: + +.. _class_Color_constant_mediumseagreen: + +.. _class_Color_constant_mediumslateblue: + +.. _class_Color_constant_mediumspringgreen: + +.. _class_Color_constant_mediumturquoise: + +.. _class_Color_constant_mediumvioletred: + +.. _class_Color_constant_midnightblue: + +.. _class_Color_constant_mintcream: + +.. _class_Color_constant_mistyrose: + +.. _class_Color_constant_moccasin: + +.. _class_Color_constant_navajowhite: + +.. _class_Color_constant_navyblue: + +.. _class_Color_constant_oldlace: + +.. _class_Color_constant_olive: + +.. _class_Color_constant_olivedrab: + +.. _class_Color_constant_orange: + +.. _class_Color_constant_orangered: + +.. _class_Color_constant_orchid: + +.. _class_Color_constant_palegoldenrod: + +.. _class_Color_constant_palegreen: + +.. _class_Color_constant_paleturquoise: + +.. _class_Color_constant_palevioletred: + +.. _class_Color_constant_papayawhip: + +.. _class_Color_constant_peachpuff: + +.. _class_Color_constant_peru: + +.. _class_Color_constant_pink: + +.. _class_Color_constant_plum: + +.. _class_Color_constant_powderblue: + +.. _class_Color_constant_purple: + +.. _class_Color_constant_rebeccapurple: + +.. _class_Color_constant_red: + +.. _class_Color_constant_rosybrown: + +.. _class_Color_constant_royalblue: + +.. _class_Color_constant_saddlebrown: + +.. _class_Color_constant_salmon: + +.. _class_Color_constant_sandybrown: + +.. _class_Color_constant_seagreen: + +.. _class_Color_constant_seashell: + +.. _class_Color_constant_sienna: + +.. _class_Color_constant_silver: + +.. _class_Color_constant_skyblue: + +.. _class_Color_constant_slateblue: + +.. _class_Color_constant_slategray: + +.. _class_Color_constant_snow: + +.. _class_Color_constant_springgreen: + +.. _class_Color_constant_steelblue: + +.. _class_Color_constant_tan: + +.. _class_Color_constant_teal: + +.. _class_Color_constant_thistle: + +.. _class_Color_constant_tomato: + +.. _class_Color_constant_turquoise: + +.. _class_Color_constant_violet: + +.. _class_Color_constant_webgray: + +.. _class_Color_constant_webgreen: + +.. _class_Color_constant_webmaroon: + +.. _class_Color_constant_webpurple: + +.. _class_Color_constant_wheat: + +.. _class_Color_constant_white: + +.. _class_Color_constant_whitesmoke: + +.. _class_Color_constant_yellow: + +.. _class_Color_constant_yellowgreen: + - **gray** = **Color( 0.75, 0.75, 0.75, 1 )** - **aliceblue** = **Color( 0.94, 0.97, 1, 1 )** @@ -380,74 +670,74 @@ Constants Description ----------- -A color is represented by red, green, and blue ``(r, g, b)`` components. Additionally, ``a`` represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some properties (such as :ref:`CanvasItem.modulate`) may accept values > 1. +A color is represented by red, green, and blue ``(r, g, b)`` components. Additionally, ``a`` represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some properties (such as :ref:`CanvasItem.modulate`) may accept values > 1. -You can also create a color from standardized color names by using :ref:`@GDScript.ColorN`. +You can also create a color from standardized color names by using :ref:`@GDScript.ColorN`. Property Descriptions --------------------- -.. _class_Color_a: +.. _class_Color_property_a: - :ref:`float` **a** Alpha value (range 0 to 1). -.. _class_Color_a8: +.. _class_Color_property_a8: - :ref:`int` **a8** Alpha value (range 0 to 255). -.. _class_Color_b: +.. _class_Color_property_b: - :ref:`float` **b** Blue value (range 0 to 1). -.. _class_Color_b8: +.. _class_Color_property_b8: - :ref:`int` **b8** Blue value (range 0 to 255). -.. _class_Color_g: +.. _class_Color_property_g: - :ref:`float` **g** Green value (range 0 to 1). -.. _class_Color_g8: +.. _class_Color_property_g8: - :ref:`int` **g8** Green value (range 0 to 255). -.. _class_Color_h: +.. _class_Color_property_h: - :ref:`float` **h** HSV hue value (range 0 to 1). -.. _class_Color_r: +.. _class_Color_property_r: - :ref:`float` **r** Red value (range 0 to 1). -.. _class_Color_r8: +.. _class_Color_property_r8: - :ref:`int` **r8** Red value (range 0 to 255). -.. _class_Color_s: +.. _class_Color_property_s: - :ref:`float` **s** HSV saturation value (range 0 to 1). -.. _class_Color_v: +.. _class_Color_property_v: - :ref:`float` **v** @@ -456,11 +746,11 @@ HSV value (range 0 to 1). Method Descriptions ------------------- -.. _class_Color_Color: +.. _class_Color_method_Color: - :ref:`Color` **Color** **(** :ref:`String` from **)** -Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN`. +Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN`. :: @@ -470,8 +760,6 @@ Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. var c3 = Color("#b2d90a") # RGB format with '#' var c4 = Color("b2d90a") # RGB format -.. _class_Color_Color: - - :ref:`Color` **Color** **(** :ref:`int` from **)** Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). @@ -480,8 +768,6 @@ Constructs a color from a 32-bit integer (each byte represents a component of th var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18) -.. _class_Color_Color: - - :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** Constructs a color from an RGB profile using values between 0 and 1. Alpha will always be 1. @@ -490,8 +776,6 @@ Constructs a color from an RGB profile using values between 0 and 1. Alpha will var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255) -.. _class_Color_Color: - - :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** Constructs a color from an RGBA profile using values between 0 and 1. @@ -500,7 +784,7 @@ Constructs a color from an RGBA profile using values between 0 and 1. var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204) -.. _class_Color_blend: +.. _class_Color_method_blend: - :ref:`Color` **blend** **(** :ref:`Color` over **)** @@ -512,7 +796,7 @@ Returns a new color resulting from blending this color over another. If the colo var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50% var blended_color = bg.blend(fg) # Brown with alpha of 75% -.. _class_Color_contrasted: +.. _class_Color_method_contrasted: - :ref:`Color` **contrasted** **(** **)** @@ -523,7 +807,7 @@ Returns the most contrasting color. var c = Color(0.3, 0.4, 0.9) var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255) -.. _class_Color_darkened: +.. _class_Color_method_darkened: - :ref:`Color` **darkened** **(** :ref:`float` amount **)** @@ -534,7 +818,7 @@ Returns a new color resulting from making this color darker by the specified per var green = Color(0.0, 1.0, 0.0) var darkgreen = green.darkened(0.2) # 20% darker than regular green -.. _class_Color_from_hsv: +.. _class_Color_method_from_hsv: - :ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** @@ -544,7 +828,7 @@ Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values betwe var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8) -.. _class_Color_gray: +.. _class_Color_method_gray: - :ref:`float` **gray** **(** **)** @@ -557,7 +841,7 @@ The gray value is calculated as ``(r + g + b) / 3``. var c = Color(0.2, 0.45, 0.82) var gray = c.gray() # a value of 0.466667 -.. _class_Color_inverted: +.. _class_Color_method_inverted: - :ref:`Color` **inverted** **(** **)** @@ -568,7 +852,7 @@ Returns the inverted color ``(1 - r, 1 - g, 1 - b, 1 - a)``. var c = Color(0.3, 0.4, 0.9) var inverted_color = c.inverted() # a color of an RGBA(178, 153, 26, 255) -.. _class_Color_lightened: +.. _class_Color_method_lightened: - :ref:`Color` **lightened** **(** :ref:`float` amount **)** @@ -579,7 +863,7 @@ Returns a new color resulting from making this color lighter by the specified pe var green = Color(0.0, 1.0, 0.0) var lightgreen = green.lightened(0.2) # 20% lighter than regular green -.. _class_Color_linear_interpolate: +.. _class_Color_method_linear_interpolate: - :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** @@ -591,7 +875,7 @@ Returns the linear interpolation with another color. The interpolation factor `` var c2 = Color(0.0, 1.0, 0.0) var li_c = c1.linear_interpolate(c2, 0.5) # a color of an RGBA(128, 128, 0, 255) -.. _class_Color_to_abgr32: +.. _class_Color_method_to_abgr32: - :ref:`int` **to_abgr32** **(** **)** @@ -602,7 +886,7 @@ Returns the color's 32-bit integer in ABGR format (each byte represents a compon var c = Color(1, 0.5, 0.2) print(c.to_abgr32()) # Prints 4281565439 -.. _class_Color_to_abgr64: +.. _class_Color_method_to_abgr64: - :ref:`int` **to_abgr64** **(** **)** @@ -613,7 +897,7 @@ Returns the color's 64-bit integer in ABGR format (each word represents a compon var c = Color(1, 0.5, 0.2) print(c.to_abgr64()) # Prints -225178692812801 -.. _class_Color_to_argb32: +.. _class_Color_method_to_argb32: - :ref:`int` **to_argb32** **(** **)** @@ -624,7 +908,7 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon var c = Color(1, 0.5, 0.2) print(c.to_argb32()) # Prints 4294934323 -.. _class_Color_to_argb64: +.. _class_Color_method_to_argb64: - :ref:`int` **to_argb64** **(** **)** @@ -635,7 +919,7 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon var c = Color(1, 0.5, 0.2) print(c.to_argb64()) # Prints -2147470541 -.. _class_Color_to_html: +.. _class_Color_method_to_html: - :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** @@ -649,7 +933,7 @@ Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string. var s1 = c.to_html() # Results "7fffffff" var s2 = c.to_html(false) # Results 'ffffff' -.. _class_Color_to_rgba32: +.. _class_Color_method_to_rgba32: - :ref:`int` **to_rgba32** **(** **)** @@ -660,7 +944,7 @@ Returns the color's 32-bit integer in RGBA format (each byte represents a compon var c = Color(1, 0.5, 0.2) print(c.to_rgba32()) # Prints 4286526463 -.. _class_Color_to_rgba64: +.. _class_Color_method_to_rgba64: - :ref:`int` **to_rgba64** **(** **)** diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 7ade0d077..9442fac00 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -19,68 +19,68 @@ Color picker control. Properties ---------- -+---------------------------+-------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`deferred_mode` | -+---------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`edit_alpha` | -+---------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`raw_mode` | -+---------------------------+-------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`deferred_mode` | ++---------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`edit_alpha` | ++---------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`raw_mode` | ++---------------------------+----------------------------------------------------------------+ Methods ------- -+----------------------------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`add_preset` **(** :ref:`Color` color **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_preset` **(** :ref:`Color` color **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`get_presets` **(** **)** const | -+----------------------------------------------+-------------------------------------------------------------------------------------------------+ ++---------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_preset` **(** :ref:`Color` color **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_preset` **(** :ref:`Color` color **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`get_presets` **(** **)** const | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+-------------------------------+-------------------------------------------------------+ -| :ref:`Texture` | :ref:`add_preset` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`Texture` | :ref:`color_hue` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`Texture` | :ref:`color_sample` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`h_width` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`label_width` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`margin` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`Texture` | :ref:`preset_bg` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`Texture` | :ref:`screen_picker` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`sv_height` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`sv_width` | -+-------------------------------+-------------------------------------------------------+ ++-------------------------------+---------------+ +| :ref:`Texture` | add_preset | ++-------------------------------+---------------+ +| :ref:`Texture` | color_hue | ++-------------------------------+---------------+ +| :ref:`Texture` | color_sample | ++-------------------------------+---------------+ +| :ref:`int` | h_width | ++-------------------------------+---------------+ +| :ref:`int` | label_width | ++-------------------------------+---------------+ +| :ref:`int` | margin | ++-------------------------------+---------------+ +| :ref:`Texture` | preset_bg | ++-------------------------------+---------------+ +| :ref:`Texture` | screen_picker | ++-------------------------------+---------------+ +| :ref:`int` | sv_height | ++-------------------------------+---------------+ +| :ref:`int` | sv_width | ++-------------------------------+---------------+ Signals ------- -.. _class_ColorPicker_color_changed: +.. _class_ColorPicker_signal_color_changed: - **color_changed** **(** :ref:`Color` color **)** Emitted when the color is changed. -.. _class_ColorPicker_preset_added: +.. _class_ColorPicker_signal_preset_added: - **preset_added** **(** :ref:`Color` color **)** Emitted when a preset is added. -.. _class_ColorPicker_preset_removed: +.. _class_ColorPicker_signal_preset_removed: - **preset_removed** **(** :ref:`Color` color **)** @@ -94,7 +94,7 @@ Description Property Descriptions --------------------- -.. _class_ColorPicker_color: +.. _class_ColorPicker_property_color: - :ref:`Color` **color** @@ -106,7 +106,7 @@ Property Descriptions The currently selected color. -.. _class_ColorPicker_deferred_mode: +.. _class_ColorPicker_property_deferred_mode: - :ref:`bool` **deferred_mode** @@ -118,7 +118,7 @@ The currently selected color. If ``true``, the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). -.. _class_ColorPicker_edit_alpha: +.. _class_ColorPicker_property_edit_alpha: - :ref:`bool` **edit_alpha** @@ -130,7 +130,7 @@ If ``true``, the color will apply only after the user releases the mouse button, If ``true``, shows an alpha channel slider (transparency). -.. _class_ColorPicker_raw_mode: +.. _class_ColorPicker_property_raw_mode: - :ref:`bool` **raw_mode** @@ -145,19 +145,19 @@ If ``true``, allows the color R, G, B component values to go beyond 1.0, which c Method Descriptions ------------------- -.. _class_ColorPicker_add_preset: +.. _class_ColorPicker_method_add_preset: - void **add_preset** **(** :ref:`Color` color **)** Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for *this* color picker. -.. _class_ColorPicker_erase_preset: +.. _class_ColorPicker_method_erase_preset: - void **erase_preset** **(** :ref:`Color` color **)** Remove the given color from the list of color presets of this color picker. -.. _class_ColorPicker_get_presets: +.. _class_ColorPicker_method_get_presets: - :ref:`PoolColorArray` **get_presets** **(** **)** const diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index e6e9013d9..8dfcdc2a2 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -19,60 +19,60 @@ Button that pops out a :ref:`ColorPicker`. Properties ---------- -+---------------------------+-------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`edit_alpha` | -+---------------------------+-------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`edit_alpha` | ++---------------------------+----------------------------------------------------------------+ Methods ------- -+----------------------------------------+-------------------------------------------------------------------+ -| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------+ -| :ref:`PopupPanel` | :ref:`get_popup` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------+ +| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------+ +| :ref:`PopupPanel` | :ref:`get_popup` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`bg` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`disabled` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_pressed` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`pressed` | -+---------------------------------+-------------------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`Texture` | bg | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | disabled | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+---------------------+ +| :ref:`Font` | font | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_hover | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_pressed | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | hover | ++---------------------------------+---------------------+ +| :ref:`int` | hseparation | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | pressed | ++---------------------------------+---------------------+ Signals ------- -.. _class_ColorPickerButton_color_changed: +.. _class_ColorPickerButton_signal_color_changed: - **color_changed** **(** :ref:`Color` color **)** Emitted when the color changes. -.. _class_ColorPickerButton_popup_closed: +.. _class_ColorPickerButton_signal_popup_closed: - **popup_closed** **(** **)** @@ -84,7 +84,7 @@ Encapsulates a :ref:`ColorPicker` making it accessible by pre Property Descriptions --------------------- -.. _class_ColorPickerButton_color: +.. _class_ColorPickerButton_property_color: - :ref:`Color` **color** @@ -96,7 +96,7 @@ Property Descriptions The currently selected color. -.. _class_ColorPickerButton_edit_alpha: +.. _class_ColorPickerButton_property_edit_alpha: - :ref:`bool` **edit_alpha** @@ -111,13 +111,13 @@ If ``true``, the alpha channel in the displayed :ref:`ColorPicker` **get_picker** **(** **)** Returns the :ref:`ColorPicker` that this node toggles. -.. _class_ColorPickerButton_get_popup: +.. _class_ColorPickerButton_method_get_popup: - :ref:`PopupPanel` **get_popup** **(** **)** diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 946e7b155..a67d374d9 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -19,9 +19,9 @@ Colored rectangle. Properties ---------- -+---------------------------+-------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+-------------------------------------+ ++---------------------------+----------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------+----------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Displays a colored rectangle. Property Descriptions --------------------- -.. _class_ColorRect_color: +.. _class_ColorRect_property_color: - :ref:`Color` **color** diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index dfb1c6bf9..7e0c30539 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -19,11 +19,11 @@ Concave polygon shape. Methods ------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_faces` **(** :ref:`PoolVector3Array` faces **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_faces` **(** :ref:`PoolVector3Array` faces **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -33,13 +33,13 @@ Concave polygon shape resource, which can be set into a :ref:`PhysicsBody` **get_faces** **(** **)** const Return the faces (an array of triangles). -.. _class_ConcavePolygonShape_set_faces: +.. _class_ConcavePolygonShape_method_set_faces: - void **set_faces** **(** :ref:`PoolVector3Array` faces **)** diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index aea8f13fd..bc562b77d 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -19,9 +19,9 @@ Concave polygon 2D shape resource for physics. Properties ---------- -+-------------------------------------------------+-------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`segments` | -+-------------------------------------------------+-------------------------------------------------------+ ++-------------------------------------------------+----------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`segments` | ++-------------------------------------------------+----------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ The main difference between a :ref:`ConvexPolygonShape2D` **segments** diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index e6cb0293b..329e5ad26 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -19,23 +19,35 @@ A twist joint between two 3D bodies. Properties ---------- -+---------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`bias` | -+---------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`relaxation` | -+---------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`softness` | -+---------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`swing_span` | -+---------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`twist_span` | -+---------------------------+----------------------------------------------------+ ++---------------------------+-------------------------------------------------------------+ +| :ref:`float` | :ref:`bias` | ++---------------------------+-------------------------------------------------------------+ +| :ref:`float` | :ref:`relaxation` | ++---------------------------+-------------------------------------------------------------+ +| :ref:`float` | :ref:`softness` | ++---------------------------+-------------------------------------------------------------+ +| :ref:`float` | :ref:`swing_span` | ++---------------------------+-------------------------------------------------------------+ +| :ref:`float` | :ref:`twist_span` | ++---------------------------+-------------------------------------------------------------+ Enumerations ------------ .. _enum_ConeTwistJoint_Param: +.. _class_ConeTwistJoint_constant_PARAM_SWING_SPAN: + +.. _class_ConeTwistJoint_constant_PARAM_TWIST_SPAN: + +.. _class_ConeTwistJoint_constant_PARAM_BIAS: + +.. _class_ConeTwistJoint_constant_PARAM_SOFTNESS: + +.. _class_ConeTwistJoint_constant_PARAM_RELAXATION: + +.. _class_ConeTwistJoint_constant_PARAM_MAX: + enum **Param**: - **PARAM_SWING_SPAN** = **0** --- Swing is rotation from side to side, around the axis perpendicular to the twist axis. @@ -72,7 +84,7 @@ Once the Bodies swing, the twist axis is calculated as the middle of the x-axes Property Descriptions --------------------- -.. _class_ConeTwistJoint_bias: +.. _class_ConeTwistJoint_property_bias: - :ref:`float` **bias** @@ -86,7 +98,7 @@ The speed with which the swing or twist will take place. The higher, the faster. -.. _class_ConeTwistJoint_relaxation: +.. _class_ConeTwistJoint_property_relaxation: - :ref:`float` **relaxation** @@ -98,7 +110,7 @@ The higher, the faster. Defines, how fast the swing- and twist-speed-difference on both sides gets synced. -.. _class_ConeTwistJoint_softness: +.. _class_ConeTwistJoint_property_softness: - :ref:`float` **softness** @@ -110,7 +122,7 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synce The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. -.. _class_ConeTwistJoint_swing_span: +.. _class_ConeTwistJoint_property_swing_span: - :ref:`float` **swing_span** @@ -122,7 +134,7 @@ Could be defined as looseness in the ``ConeTwistJoint``. If below 0.05, this behaviour is locked. Default value: ``PI/4``. -.. _class_ConeTwistJoint_twist_span: +.. _class_ConeTwistJoint_property_twist_span: - :ref:`float` **twist_span** diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 090e5b3ec..07e030767 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -19,25 +19,25 @@ Helper class to handle INI-style files. Methods ------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_section` **(** :ref:`String` section **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`save` **(** :ref:`String` path **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_section` **(** :ref:`String` section **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`save` **(** :ref:`String` path **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -73,55 +73,55 @@ Keep in mind that section and property names can't contain spaces. Anything afte Method Descriptions ------------------- -.. _class_ConfigFile_erase_section: +.. _class_ConfigFile_method_erase_section: - void **erase_section** **(** :ref:`String` section **)** Deletes the specified section along with all the key-value pairs inside. -.. _class_ConfigFile_get_section_keys: +.. _class_ConfigFile_method_get_section_keys: - :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** const Returns an array of all defined key identifiers in the specified section. -.. _class_ConfigFile_get_sections: +.. _class_ConfigFile_method_get_sections: - :ref:`PoolStringArray` **get_sections** **(** **)** const Returns an array of all defined section identifiers. -.. _class_ConfigFile_get_value: +.. _class_ConfigFile_method_get_value: - :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 the section and/or the key do not exist, the method returns the value of the optional ``default`` argument, or ``null`` if it is omitted. -.. _class_ConfigFile_has_section: +.. _class_ConfigFile_method_has_section: - :ref:`bool` **has_section** **(** :ref:`String` section **)** const Returns ``true`` if the specified section exists. -.. _class_ConfigFile_has_section_key: +.. _class_ConfigFile_method_has_section_key: - :ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** const Returns ``true`` if the specified section-key pair exists. -.. _class_ConfigFile_load: +.. _class_ConfigFile_method_load: - :ref:`Error` **load** **(** :ref:`String` path **)** Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. -.. _class_ConfigFile_save: +.. _class_ConfigFile_method_save: - :ref:`Error` **save** **(** :ref:`String` path **)** Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. -.. _class_ConfigFile_set_value: +.. _class_ConfigFile_method_set_value: - void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 255e9f607..238142cd8 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -21,9 +21,9 @@ Dialog for confirmation of actions. Methods ------- -+------------------------------+--------------------------------------------------------------------+ -| :ref:`Button` | :ref:`get_cancel` **(** **)** | -+------------------------------+--------------------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`get_cancel` **(** **)** | ++-----------------------------+---------------------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Dialog for confirmation of actions. This dialog inherits from :ref:`AcceptDialog Method Descriptions ------------------- -.. _class_ConfirmationDialog_get_cancel: +.. _class_ConfirmationDialog_method_get_cancel: - :ref:`Button` **get_cancel** **(** **)** diff --git a/classes/class_container.rst b/classes/class_container.rst index 4891e49e3..86f3e3a0e 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -21,16 +21,16 @@ Base node for containers. Methods ------- -+-------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fit_child_in_rect` **(** :ref:`Control` child, :ref:`Rect2` rect **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_sort` **(** **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fit_child_in_rect` **(** :ref:`Control` child, :ref:`Rect2` rect **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_sort` **(** **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Container_sort_children: +.. _class_Container_signal_sort_children: - **sort_children** **(** **)** @@ -39,6 +39,8 @@ Emitted when sorting the children is needed. Constants --------- +.. _class_Container_constant_NOTIFICATION_SORT_CHILDREN: + - **NOTIFICATION_SORT_CHILDREN** = **50** --- Notification for when sorting the children, it must be obeyed immediately. Description @@ -51,13 +53,13 @@ A Control can inherit this to create custom container classes. Method Descriptions ------------------- -.. _class_Container_fit_child_in_rect: +.. _class_Container_method_fit_child_in_rect: - void **fit_child_in_rect** **(** :ref:`Control` child, :ref:`Rect2` rect **)** Fit a child control in a given rect. This is mainly a helper for creating custom container classes. -.. _class_Container_queue_sort: +.. _class_Container_method_queue_sort: - void **queue_sort** **(** **)** diff --git a/classes/class_control.rst b/classes/class_control.rst index 40542aca4..a48799aea 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -21,274 +21,314 @@ All User Interface nodes inherit from Control. A control's anchors and margins a Properties ---------- -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anchor_bottom` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anchor_left` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anchor_right` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anchor_top` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`FocusMode` | :ref:`focus_mode` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_neighbour_bottom` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_neighbour_left` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_neighbour_right` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_neighbour_top` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_next` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`focus_previous` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`GrowDirection` | :ref:`grow_horizontal` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`GrowDirection` | :ref:`grow_vertical` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`hint_tooltip` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_bottom` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_left` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_right` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_top` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`MouseFilter` | :ref:`mouse_filter` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rect_clip_content` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_global_position` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_min_size` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_pivot_offset` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_position` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rect_rotation` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_scale` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rect_size` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size_flags_horizontal` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`size_flags_stretch_ratio` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size_flags_vertical` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Theme` | :ref:`theme` | -+--------------------------------------------------+-----------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anchor_bottom` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anchor_left` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anchor_right` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anchor_top` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`FocusMode` | :ref:`focus_mode` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`focus_neighbour_bottom` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`focus_neighbour_left` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`focus_neighbour_right` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`focus_neighbour_top` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`focus_next` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`focus_previous` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`GrowDirection` | :ref:`grow_horizontal` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`GrowDirection` | :ref:`grow_vertical` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`hint_tooltip` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin_bottom` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin_left` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin_right` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin_top` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`MouseFilter` | :ref:`mouse_filter` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rect_clip_content` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`rect_global_position` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`rect_min_size` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`rect_pivot_offset` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`rect_position` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rect_rotation` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`rect_scale` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`rect_size` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size_flags_horizontal` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`size_flags_stretch_ratio` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size_flags_vertical` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Theme` | :ref:`theme` | ++--------------------------------------------------+--------------------------------------------------------------------------------------+ Methods ------- -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_clips_input` **(** **)** virtual | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`_make_custom_tooltip` **(** :ref:`String` for_text **)** virtual | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`accept_event` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_stylebox_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** 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:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** virtual | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_end` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** 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 | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_override` **(** :ref:`String` name **)** 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_focus` **(** **)** 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_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_override` **(** :ref:`String` name **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`minimum_size_changed` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`release_focus` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor` **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_and_margin` **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchors_and_margins_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchors_preset` **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end` **(** :ref:`Vector2` position **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margins_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_clips_input` **(** **)** virtual | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`_make_custom_tooltip` **(** :ref:`String` for_text **)** virtual | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`accept_event` **(** **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_stylebox_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** 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:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** virtual | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_end` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** 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 | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_override` **(** :ref:`String` name **)** 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_focus` **(** **)** 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_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_override` **(** :ref:`String` name **)** const | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`minimum_size_changed` **(** **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`release_focus` **(** **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor` **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_and_margin` **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchors_and_margins_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchors_preset` **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end` **(** :ref:`Vector2` position **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margins_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | ++----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Control_focus_entered: +.. _class_Control_signal_focus_entered: - **focus_entered** **(** **)** Emitted when the node gains keyboard focus. -.. _class_Control_focus_exited: +.. _class_Control_signal_focus_exited: - **focus_exited** **(** **)** Emitted when the node loses keyboard focus. -.. _class_Control_gui_input: +.. _class_Control_signal_gui_input: - **gui_input** **(** :ref:`InputEvent` event **)** Emitted when the node receives an :ref:`InputEvent`. -.. _class_Control_minimum_size_changed: +.. _class_Control_signal_minimum_size_changed: - **minimum_size_changed** **(** **)** Emitted when the node's minimum size changes. -.. _class_Control_modal_closed: +.. _class_Control_signal_modal_closed: - **modal_closed** **(** **)** -Emitted when a modal ``Control`` is closed. See :ref:`show_modal`. +Emitted when a modal ``Control`` is closed. See :ref:`show_modal`. -.. _class_Control_mouse_entered: +.. _class_Control_signal_mouse_entered: - **mouse_entered** **(** **)** -Emitted when the mouse enters the control's ``Rect`` area, provided its :ref:`mouse_filter` lets the event reach it. +Emitted when the mouse enters the control's ``Rect`` area, provided its :ref:`mouse_filter` lets the event reach it. -.. _class_Control_mouse_exited: +.. _class_Control_signal_mouse_exited: - **mouse_exited** **(** **)** -Emitted when the mouse leaves the control's ``Rect`` area, provided its :ref:`mouse_filter` lets the event reach it. +Emitted when the mouse leaves the control's ``Rect`` area, provided its :ref:`mouse_filter` lets the event reach it. -.. _class_Control_resized: +.. _class_Control_signal_resized: - **resized** **(** **)** Emitted when the control changes size. -.. _class_Control_size_flags_changed: +.. _class_Control_signal_size_flags_changed: - **size_flags_changed** **(** **)** -Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. Enumerations ------------ .. _enum_Control_FocusMode: +.. _class_Control_constant_FOCUS_NONE: + +.. _class_Control_constant_FOCUS_CLICK: + +.. _class_Control_constant_FOCUS_ALL: + enum **FocusMode**: -- **FOCUS_NONE** = **0** --- The node cannot grab focus. Use with :ref:`focus_mode`. +- **FOCUS_NONE** = **0** --- The node cannot grab focus. Use with :ref:`focus_mode`. -- **FOCUS_CLICK** = **1** --- The node can only grab focus on mouse clicks. Use with :ref:`focus_mode`. +- **FOCUS_CLICK** = **1** --- The node can only grab focus on mouse clicks. Use with :ref:`focus_mode`. -- **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`focus_mode`. +- **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`focus_mode`. .. _enum_Control_CursorShape: +.. _class_Control_constant_CURSOR_ARROW: + +.. _class_Control_constant_CURSOR_IBEAM: + +.. _class_Control_constant_CURSOR_POINTING_HAND: + +.. _class_Control_constant_CURSOR_CROSS: + +.. _class_Control_constant_CURSOR_WAIT: + +.. _class_Control_constant_CURSOR_BUSY: + +.. _class_Control_constant_CURSOR_DRAG: + +.. _class_Control_constant_CURSOR_CAN_DROP: + +.. _class_Control_constant_CURSOR_FORBIDDEN: + +.. _class_Control_constant_CURSOR_VSIZE: + +.. _class_Control_constant_CURSOR_HSIZE: + +.. _class_Control_constant_CURSOR_BDIAGSIZE: + +.. _class_Control_constant_CURSOR_FDIAGSIZE: + +.. _class_Control_constant_CURSOR_MOVE: + +.. _class_Control_constant_CURSOR_VSPLIT: + +.. _class_Control_constant_CURSOR_HSPLIT: + +.. _class_Control_constant_CURSOR_HELP: + enum **CursorShape**: -- **CURSOR_ARROW** = **0** --- Show the system's arrow mouse cursor when the user hovers the node. Use with :ref:`mouse_default_cursor_shape`. +- **CURSOR_ARROW** = **0** --- Show the system's arrow mouse cursor when the user hovers the node. Use with :ref:`mouse_default_cursor_shape`. - **CURSOR_IBEAM** = **1** --- Show the system's I-beam mouse cursor when the user hovers the node. The I-beam pointer has a shape similar to "I". It tells the user they can highlight or insert text. @@ -324,42 +364,82 @@ enum **CursorShape**: .. _enum_Control_LayoutPreset: +.. _class_Control_constant_PRESET_TOP_LEFT: + +.. _class_Control_constant_PRESET_TOP_RIGHT: + +.. _class_Control_constant_PRESET_BOTTOM_LEFT: + +.. _class_Control_constant_PRESET_BOTTOM_RIGHT: + +.. _class_Control_constant_PRESET_CENTER_LEFT: + +.. _class_Control_constant_PRESET_CENTER_TOP: + +.. _class_Control_constant_PRESET_CENTER_RIGHT: + +.. _class_Control_constant_PRESET_CENTER_BOTTOM: + +.. _class_Control_constant_PRESET_CENTER: + +.. _class_Control_constant_PRESET_LEFT_WIDE: + +.. _class_Control_constant_PRESET_TOP_WIDE: + +.. _class_Control_constant_PRESET_RIGHT_WIDE: + +.. _class_Control_constant_PRESET_BOTTOM_WIDE: + +.. _class_Control_constant_PRESET_VCENTER_WIDE: + +.. _class_Control_constant_PRESET_HCENTER_WIDE: + +.. _class_Control_constant_PRESET_WIDE: + enum **LayoutPreset**: -- **PRESET_TOP_LEFT** = **0** --- Snap all 4 anchors to the top-left of the parent control's bounds. Use with :ref:`set_anchors_preset`. +- **PRESET_TOP_LEFT** = **0** --- Snap all 4 anchors to the top-left of the parent control's bounds. Use with :ref:`set_anchors_preset`. -- **PRESET_TOP_RIGHT** = **1** --- Snap all 4 anchors to the top-right of the parent control's bounds. Use with :ref:`set_anchors_preset`. +- **PRESET_TOP_RIGHT** = **1** --- Snap all 4 anchors to the top-right of the parent control's bounds. Use with :ref:`set_anchors_preset`. -- **PRESET_BOTTOM_LEFT** = **2** --- Snap all 4 anchors to the bottom-left of the parent control's bounds. Use with :ref:`set_anchors_preset`. +- **PRESET_BOTTOM_LEFT** = **2** --- Snap all 4 anchors to the bottom-left of the parent control's bounds. Use with :ref:`set_anchors_preset`. -- **PRESET_BOTTOM_RIGHT** = **3** --- Snap all 4 anchors to the bottom-right of the parent control's bounds. Use with :ref:`set_anchors_preset`. +- **PRESET_BOTTOM_RIGHT** = **3** --- Snap all 4 anchors to the bottom-right of the parent control's bounds. Use with :ref:`set_anchors_preset`. -- **PRESET_CENTER_LEFT** = **4** --- Snap all 4 anchors to the center of the left edge of the parent control's bounds. Use with :ref:`set_anchors_preset`. +- **PRESET_CENTER_LEFT** = **4** --- Snap all 4 anchors to the center of the left edge of the parent control's bounds. Use with :ref:`set_anchors_preset`. -- **PRESET_CENTER_TOP** = **5** --- Snap all 4 anchors to the center of the top edge of the parent control's bounds. Use with :ref:`set_anchors_preset`. +- **PRESET_CENTER_TOP** = **5** --- Snap all 4 anchors to the center of the top edge of the parent control's bounds. Use with :ref:`set_anchors_preset`. -- **PRESET_CENTER_RIGHT** = **6** --- Snap all 4 anchors to the center of the right edge of the parent control's bounds. Use with :ref:`set_anchors_preset`. +- **PRESET_CENTER_RIGHT** = **6** --- Snap all 4 anchors to the center of the right edge of the parent control's bounds. Use with :ref:`set_anchors_preset`. -- **PRESET_CENTER_BOTTOM** = **7** --- Snap all 4 anchors to the center of the bottom edge of the parent control's bounds. Use with :ref:`set_anchors_preset`. +- **PRESET_CENTER_BOTTOM** = **7** --- Snap all 4 anchors to the center of the bottom edge of the parent control's bounds. Use with :ref:`set_anchors_preset`. -- **PRESET_CENTER** = **8** --- Snap all 4 anchors to the center of the parent control's bounds. Use with :ref:`set_anchors_preset`. +- **PRESET_CENTER** = **8** --- Snap all 4 anchors to the center of the parent control's bounds. Use with :ref:`set_anchors_preset`. -- **PRESET_LEFT_WIDE** = **9** --- Snap all 4 anchors to the left edge of the parent control. The left margin becomes relative to the left edge and the top margin relative to the top left corner of the node's parent. Use with :ref:`set_anchors_preset`. +- **PRESET_LEFT_WIDE** = **9** --- Snap all 4 anchors to the left edge of the parent control. The left margin becomes relative to the left edge and the top margin relative to the top left corner of the node's parent. Use with :ref:`set_anchors_preset`. -- **PRESET_TOP_WIDE** = **10** --- Snap all 4 anchors to the top edge of the parent control. The left margin becomes relative to the top left corner, the top margin relative to the top edge, and the right margin relative to the top right corner of the node's parent. Use with :ref:`set_anchors_preset`. +- **PRESET_TOP_WIDE** = **10** --- Snap all 4 anchors to the top edge of the parent control. The left margin becomes relative to the top left corner, the top margin relative to the top edge, and the right margin relative to the top right corner of the node's parent. Use with :ref:`set_anchors_preset`. -- **PRESET_RIGHT_WIDE** = **11** --- Snap all 4 anchors to the right edge of the parent control. The right margin becomes relative to the right edge and the top margin relative to the top right corner of the node's parent. Use with :ref:`set_anchors_preset`. +- **PRESET_RIGHT_WIDE** = **11** --- Snap all 4 anchors to the right edge of the parent control. The right margin becomes relative to the right edge and the top margin relative to the top right corner of the node's parent. Use with :ref:`set_anchors_preset`. -- **PRESET_BOTTOM_WIDE** = **12** --- Snap all 4 anchors to the bottom edge of the parent control. The left margin becomes relative to the bottom left corner, the bottom margin relative to the bottom edge, and the right margin relative to the bottom right corner of the node's parent. Use with :ref:`set_anchors_preset`. +- **PRESET_BOTTOM_WIDE** = **12** --- Snap all 4 anchors to the bottom edge of the parent control. The left margin becomes relative to the bottom left corner, the bottom margin relative to the bottom edge, and the right margin relative to the bottom right corner of the node's parent. Use with :ref:`set_anchors_preset`. -- **PRESET_VCENTER_WIDE** = **13** --- Snap all 4 anchors to a vertical line that cuts the parent control in half. Use with :ref:`set_anchors_preset`. +- **PRESET_VCENTER_WIDE** = **13** --- Snap all 4 anchors to a vertical line that cuts the parent control in half. Use with :ref:`set_anchors_preset`. -- **PRESET_HCENTER_WIDE** = **14** --- Snap all 4 anchors to a horizontal line that cuts the parent control in half. Use with :ref:`set_anchors_preset`. +- **PRESET_HCENTER_WIDE** = **14** --- Snap all 4 anchors to a horizontal line that cuts the parent control in half. Use with :ref:`set_anchors_preset`. -- **PRESET_WIDE** = **15** --- Snap all 4 anchors to the respective corners of the parent control. Set all 4 margins to 0 after you applied this preset and the ``Control`` will fit its parent control. This is equivalent to to the "Full Rect" layout option in the editor. Use with :ref:`set_anchors_preset`. +- **PRESET_WIDE** = **15** --- Snap all 4 anchors to the respective corners of the parent control. Set all 4 margins to 0 after you applied this preset and the ``Control`` will fit its parent control. This is equivalent to to the "Full Rect" layout option in the editor. Use with :ref:`set_anchors_preset`. .. _enum_Control_LayoutPresetMode: +.. _class_Control_constant_PRESET_MODE_MINSIZE: + +.. _class_Control_constant_PRESET_MODE_KEEP_WIDTH: + +.. _class_Control_constant_PRESET_MODE_KEEP_HEIGHT: + +.. _class_Control_constant_PRESET_MODE_KEEP_SIZE: + enum **LayoutPresetMode**: - **PRESET_MODE_MINSIZE** = **0** @@ -372,30 +452,52 @@ enum **LayoutPresetMode**: .. _enum_Control_SizeFlags: +.. _class_Control_constant_SIZE_FILL: + +.. _class_Control_constant_SIZE_EXPAND: + +.. _class_Control_constant_SIZE_EXPAND_FILL: + +.. _class_Control_constant_SIZE_SHRINK_CENTER: + +.. _class_Control_constant_SIZE_SHRINK_END: + enum **SizeFlags**: -- **SIZE_FILL** = **1** --- Tells the parent :ref:`Container` to expand the bounds of this node to fill all the available space without pushing any other node. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_FILL** = **1** --- Tells the parent :ref:`Container` to expand the bounds of this node to fill all the available space without pushing any other node. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. -- **SIZE_EXPAND** = **2** --- Tells the parent :ref:`Container` to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See :ref:`size_flags_stretch_ratio`. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_EXPAND** = **2** --- Tells the parent :ref:`Container` to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See :ref:`size_flags_stretch_ratio`. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. - **SIZE_EXPAND_FILL** = **3** --- Sets the node's size flags to both fill and expand. See the 2 constants above for more information. -- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. -- **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. .. _enum_Control_MouseFilter: +.. _class_Control_constant_MOUSE_FILTER_STOP: + +.. _class_Control_constant_MOUSE_FILTER_PASS: + +.. _class_Control_constant_MOUSE_FILTER_IGNORE: + enum **MouseFilter**: -- **MOUSE_FILTER_STOP** = **0** --- The control will receive mouse button input events through :ref:`_gui_input` if clicked on. These events are automatically marked as handled and they will not propagate further to other controls. +- **MOUSE_FILTER_STOP** = **0** --- The control will receive mouse button input events through :ref:`_gui_input` if clicked on. These events are automatically marked as handled and they will not propagate further to other controls. -- **MOUSE_FILTER_PASS** = **1** --- The control will receive mouse button input events through :ref:`_gui_input` if clicked on. If this control does not handle the event, the parent control (if any) will be considered for a mouse click, and so on until there is no more parent control to potentially handle it. Even if no control handled it at all, the event will still be handled automatically, so unhandled input will not be fired. +- **MOUSE_FILTER_PASS** = **1** --- The control will receive mouse button input events through :ref:`_gui_input` if clicked on. If this control does not handle the event, the parent control (if any) will be considered for a mouse click, and so on until there is no more parent control to potentially handle it. Even if no control handled it at all, the event will still be handled automatically, so unhandled input will not be fired. -- **MOUSE_FILTER_IGNORE** = **2** --- The control will not receive mouse button input events through :ref:`_gui_input` and will not block other controls from receiving these events. These events will also not be handled automatically. +- **MOUSE_FILTER_IGNORE** = **2** --- The control will not receive mouse button input events through :ref:`_gui_input` and will not block other controls from receiving these events. These events will also not be handled automatically. .. _enum_Control_GrowDirection: +.. _class_Control_constant_GROW_DIRECTION_BEGIN: + +.. _class_Control_constant_GROW_DIRECTION_END: + +.. _class_Control_constant_GROW_DIRECTION_BOTH: + enum **GrowDirection**: - **GROW_DIRECTION_BEGIN** = **0** --- The control will grow to the left or top to make up if its minimum size is changed to be greater than its current size on the respective axis. @@ -406,16 +508,38 @@ enum **GrowDirection**: .. _enum_Control_Anchor: +.. _class_Control_constant_ANCHOR_BEGIN: + +.. _class_Control_constant_ANCHOR_END: + enum **Anchor**: -- **ANCHOR_BEGIN** = **0** --- Snaps one of the 4 anchor's sides to the origin of the node's ``Rect``, in the top left. Use it with one of the ``anchor_*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. +- **ANCHOR_BEGIN** = **0** --- Snaps one of the 4 anchor's sides to the origin of the node's ``Rect``, in the top left. Use it with one of the ``anchor_*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. -- **ANCHOR_END** = **1** --- Snaps one of the 4 anchor's sides to the end of the node's ``Rect``, in the bottom right. Use it with one of the ``anchor_*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. +- **ANCHOR_END** = **1** --- Snaps one of the 4 anchor's sides to the end of the node's ``Rect``, in the bottom right. Use it with one of the ``anchor_*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. Constants --------- -- **NOTIFICATION_RESIZED** = **40** --- Sent when the node changes size. Use :ref:`rect_size` to get the new size. +.. _class_Control_constant_NOTIFICATION_RESIZED: + +.. _class_Control_constant_NOTIFICATION_MOUSE_ENTER: + +.. _class_Control_constant_NOTIFICATION_MOUSE_EXIT: + +.. _class_Control_constant_NOTIFICATION_FOCUS_ENTER: + +.. _class_Control_constant_NOTIFICATION_FOCUS_EXIT: + +.. _class_Control_constant_NOTIFICATION_THEME_CHANGED: + +.. _class_Control_constant_NOTIFICATION_MODAL_CLOSE: + +.. _class_Control_constant_NOTIFICATION_SCROLL_BEGIN: + +.. _class_Control_constant_NOTIFICATION_SCROLL_END: + +- **NOTIFICATION_RESIZED** = **40** --- Sent when the node changes size. Use :ref:`rect_size` to get the new size. - **NOTIFICATION_MOUSE_ENTER** = **41** --- Sent when the mouse pointer enters the node. @@ -425,9 +549,9 @@ Constants - **NOTIFICATION_FOCUS_EXIT** = **44** --- Sent when the node loses focus. -- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the control. Happens when you call one of the ``add_*_override`` methods. +- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the control. Happens when you call one of the ``add_*_override`` methods. -- **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. +- **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. - **NOTIFICATION_SCROLL_BEGIN** = **47** --- Sent when this node is inside a :ref:`ScrollContainer` which has begun being scrolled. @@ -442,13 +566,13 @@ For more information on Godot's UI system, anchors, margins, and containers, see **User Interface nodes and input** -Godot sends input events to the scene's root node first, by calling :ref:`Node._input`. :ref:`Node._input` forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls :ref:`MainLoop._input_event`. Call :ref:`accept_event` so no other node receives the event. Once you accepted an input, it becomes handled so :ref:`Node._unhandled_input` will not process it. +Godot sends input events to the scene's root node first, by calling :ref:`Node._input`. :ref:`Node._input` forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls :ref:`MainLoop._input_event`. Call :ref:`accept_event` so no other node receives the event. Once you accepted an input, it becomes handled so :ref:`Node._unhandled_input` will not process it. -Only one ``Control`` node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the focus, call :ref:`grab_focus`. ``Control`` nodes lose focus when another node grabs it, or if you hide the node in focus. +Only one ``Control`` node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the focus, call :ref:`grab_focus`. ``Control`` nodes lose focus when another node grabs it, or if you hide the node in focus. -Set :ref:`mouse_filter` to MOUSE_FILTER_IGNORE to tell a ``Control`` node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. +Set :ref:`mouse_filter` to MOUSE_FILTER_IGNORE to tell a ``Control`` node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. -: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. +: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. Tutorials --------- @@ -460,7 +584,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Control_anchor_bottom: +.. _class_Control_property_anchor_bottom: - :ref:`float` **anchor_bottom** @@ -470,7 +594,7 @@ Property Descriptions Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: ``ANCHOR_BEGIN``. -.. _class_Control_anchor_left: +.. _class_Control_property_anchor_left: - :ref:`float` **anchor_left** @@ -480,7 +604,7 @@ Anchors the bottom edge of the node to the origin, the center, or the end of its Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience.Default value: ``ANCHOR_BEGIN``. -.. _class_Control_anchor_right: +.. _class_Control_property_anchor_right: - :ref:`float` **anchor_right** @@ -490,7 +614,7 @@ Anchors the left edge of the node to the origin, the center or the end of its pa Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: ``ANCHOR_BEGIN``. -.. _class_Control_anchor_top: +.. _class_Control_property_anchor_top: - :ref:`float` **anchor_top** @@ -500,7 +624,7 @@ Anchors the right edge of the node to the origin, the center or the end of its p Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the ``ANCHOR_*`` constants for convenience. Default value: ``ANCHOR_BEGIN``. -.. _class_Control_focus_mode: +.. _class_Control_property_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -512,7 +636,7 @@ Anchors the top edge of the node to the origin, the center or the end of its par The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals. -.. _class_Control_focus_neighbour_bottom: +.. _class_Control_property_focus_neighbour_bottom: - :ref:`NodePath` **focus_neighbour_bottom** @@ -524,7 +648,7 @@ The focus access mode for the control (None, Click or All). Only one Control can Tells Godot which node it should give keyboard focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the ``ui_down`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. -.. _class_Control_focus_neighbour_left: +.. _class_Control_property_focus_neighbour_left: - :ref:`NodePath` **focus_neighbour_left** @@ -536,7 +660,7 @@ Tells Godot which node it should give keyboard focus to if the user presses the Tells Godot which node it should give keyboard focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the ``ui_left`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one. -.. _class_Control_focus_neighbour_right: +.. _class_Control_property_focus_neighbour_right: - :ref:`NodePath` **focus_neighbour_right** @@ -548,7 +672,7 @@ Tells Godot which node it should give keyboard focus to if the user presses the Tells Godot which node it should give keyboard focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the ``ui_right`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. -.. _class_Control_focus_neighbour_top: +.. _class_Control_property_focus_neighbour_top: - :ref:`NodePath` **focus_neighbour_top** @@ -560,7 +684,7 @@ Tells Godot which node it should give keyboard focus to if the user presses the Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the ``ui_top`` input action. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. -.. _class_Control_focus_next: +.. _class_Control_property_focus_next: - :ref:`NodePath` **focus_next** @@ -574,7 +698,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Tab If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree. -.. _class_Control_focus_previous: +.. _class_Control_property_focus_previous: - :ref:`NodePath` **focus_previous** @@ -588,7 +712,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Shif If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree. -.. _class_Control_grow_horizontal: +.. _class_Control_property_grow_horizontal: - :ref:`GrowDirection` **grow_horizontal** @@ -600,7 +724,7 @@ If this property is not set, Godot will select a "best guess" based on surroundi Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. -.. _class_Control_grow_vertical: +.. _class_Control_property_grow_vertical: - :ref:`GrowDirection` **grow_vertical** @@ -612,7 +736,7 @@ Controls the direction on the horizontal axis in which the control should grow i Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. -.. _class_Control_hint_tooltip: +.. _class_Control_property_hint_tooltip: - :ref:`String` **hint_tooltip** @@ -622,7 +746,7 @@ Controls the direction on the vertical axis in which the control should grow if Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments. -.. _class_Control_margin_bottom: +.. _class_Control_property_margin_bottom: - :ref:`float` **margin_bottom** @@ -632,11 +756,11 @@ Changes the tooltip text. The tooltip appears when the user's mouse cursor stays | *Getter* | get_margin() | +----------+-------------------+ -Distance between the node's bottom edge and its parent control, based on :ref:`anchor_bottom`. +Distance between the node's bottom edge and its parent control, based on :ref:`anchor_bottom`. Margins are often controlled by one or multiple parent :ref:`Container` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container`. Margins update automatically when you move or resize the node. -.. _class_Control_margin_left: +.. _class_Control_property_margin_left: - :ref:`float` **margin_left** @@ -646,11 +770,11 @@ Margins are often controlled by one or multiple parent :ref:`Container`. +Distance between the node's left edge and its parent control, based on :ref:`anchor_left`. Margins are often controlled by one or multiple parent :ref:`Container` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container`. Margins update automatically when you move or resize the node. -.. _class_Control_margin_right: +.. _class_Control_property_margin_right: - :ref:`float` **margin_right** @@ -660,11 +784,11 @@ Margins are often controlled by one or multiple parent :ref:`Container`. +Distance between the node's right edge and its parent control, based on :ref:`anchor_right`. Margins are often controlled by one or multiple parent :ref:`Container` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container`. Margins update automatically when you move or resize the node. -.. _class_Control_margin_top: +.. _class_Control_property_margin_top: - :ref:`float` **margin_top** @@ -674,11 +798,11 @@ Margins are often controlled by one or multiple parent :ref:`Container`. +Distance between the node's top edge and its parent control, based on :ref:`anchor_top`. Margins are often controlled by one or multiple parent :ref:`Container` nodes, so you should not modify them manually if your node is a direct child of a :ref:`Container`. Margins update automatically when you move or resize the node. -.. _class_Control_mouse_default_cursor_shape: +.. _class_Control_property_mouse_default_cursor_shape: - :ref:`CursorShape` **mouse_default_cursor_shape** @@ -692,7 +816,7 @@ The default cursor shape for this control. Useful for Godot plugins and applicat **Note:** On Linux, shapes may vary depending on the cursor theme of the system. -.. _class_Control_mouse_filter: +.. _class_Control_property_mouse_filter: - :ref:`MouseFilter` **mouse_filter** @@ -702,9 +826,9 @@ The default cursor shape for this control. Useful for Godot plugins and applicat | *Getter* | get_mouse_filter() | +----------+-------------------------+ -Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input` and how these events should be handled. See the constants to learn what each does. +Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input` and how these events should be handled. See the constants to learn what each does. -.. _class_Control_rect_clip_content: +.. _class_Control_property_rect_clip_content: - :ref:`bool` **rect_clip_content** @@ -716,7 +840,7 @@ Controls whether the control will be able to receive mouse button input events t Enables whether rendering of children should be clipped to this control's rectangle. If true, parts of a child which would be visibly outside of this control's rectangle will not be rendered. -.. _class_Control_rect_global_position: +.. _class_Control_property_rect_global_position: - :ref:`Vector2` **rect_global_position** @@ -728,7 +852,7 @@ Enables whether rendering of children should be clipped to this control's rectan The node's global position, relative to the world (usually to the top-left corner of the window). -.. _class_Control_rect_min_size: +.. _class_Control_property_rect_min_size: - :ref:`Vector2` **rect_min_size** @@ -740,7 +864,7 @@ The node's global position, relative to the world (usually to the top-left corne The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes. -.. _class_Control_rect_pivot_offset: +.. _class_Control_property_rect_pivot_offset: - :ref:`Vector2` **rect_pivot_offset** @@ -750,9 +874,9 @@ The minimum size of the node's bounding rectangle. If you set it to a value grea | *Getter* | get_pivot_offset() | +----------+-------------------------+ -By default, the node's pivot is its top-left corner. When you change its :ref:`rect_scale`, it will scale around this pivot. Set this property to :ref:`rect_size` / 2 to center the pivot in the node's rectangle. +By default, the node's pivot is its top-left corner. When you change its :ref:`rect_scale`, it will scale around this pivot. Set this property to :ref:`rect_size` / 2 to center the pivot in the node's rectangle. -.. _class_Control_rect_position: +.. _class_Control_property_rect_position: - :ref:`Vector2` **rect_position** @@ -762,9 +886,9 @@ By default, the node's pivot is its top-left corner. When you change its :ref:`r | *Getter* | get_position() | +----------+---------------------+ -The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset`. +The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset`. -.. _class_Control_rect_rotation: +.. _class_Control_property_rect_rotation: - :ref:`float` **rect_rotation** @@ -774,9 +898,9 @@ The node's position, relative to its parent. It corresponds to the rectangle's t | *Getter* | get_rotation_degrees() | +----------+-----------------------------+ -The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` to change the pivot's position. +The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` to change the pivot's position. -.. _class_Control_rect_scale: +.. _class_Control_property_rect_scale: - :ref:`Vector2` **rect_scale** @@ -786,9 +910,9 @@ The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset`. Change this property to scale the node around its :ref:`rect_pivot_offset`. +The node's scale, relative to its :ref:`rect_size`. Change this property to scale the node around its :ref:`rect_pivot_offset`. -.. _class_Control_rect_size: +.. _class_Control_property_rect_size: - :ref:`Vector2` **rect_size** @@ -800,7 +924,7 @@ The node's scale, relative to its :ref:`rect_size`. Cha The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes update this property automatically. -.. _class_Control_size_flags_horizontal: +.. _class_Control_property_size_flags_horizontal: - :ref:`int` **size_flags_horizontal** @@ -812,7 +936,7 @@ The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. -.. _class_Control_size_flags_stretch_ratio: +.. _class_Control_property_size_flags_stretch_ratio: - :ref:`float` **size_flags_stretch_ratio** @@ -824,7 +948,7 @@ Tells the parent :ref:`Container` nodes how they should resize If the node and at least one of its neighbours uses the ``SIZE_EXPAND`` size flag, the parent :ref:`Container` will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space. -.. _class_Control_size_flags_vertical: +.. _class_Control_property_size_flags_vertical: - :ref:`int` **size_flags_vertical** @@ -836,7 +960,7 @@ If the node and at least one of its neighbours uses the ``SIZE_EXPAND`` size fla Tells the parent :ref:`Container` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. -.. _class_Control_theme: +.. _class_Control_property_theme: - :ref:`Theme` **theme** @@ -851,77 +975,77 @@ Changing this property replaces the current :ref:`Theme` resource t Method Descriptions ------------------- -.. _class_Control__clips_input: +.. _class_Control_method__clips_input: - :ref:`bool` **_clips_input** **(** **)** virtual -.. _class_Control__get_minimum_size: +.. _class_Control_method__get_minimum_size: - :ref:`Vector2` **_get_minimum_size** **(** **)** virtual -Returns the minimum size for this control. See :ref:`rect_min_size`. +Returns the minimum size for this control. See :ref:`rect_min_size`. -.. _class_Control__gui_input: +.. _class_Control_method__gui_input: - void **_gui_input** **(** :ref:`InputEvent` event **)** virtual -Use this method to process and accept inputs on UI elements. See :ref:`accept_event`. +Use this method to process and accept inputs on UI elements. See :ref:`accept_event`. Replaces Godot 2's ``_input_event``. -.. _class_Control__make_custom_tooltip: +.. _class_Control_method__make_custom_tooltip: - :ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** virtual -.. _class_Control_accept_event: +.. _class_Control_method_accept_event: - void **accept_event** **(** **)** -Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. +Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. -.. _class_Control_add_color_override: +.. _class_Control_method_add_color_override: - void **add_color_override** **(** :ref:`String` name, :ref:`Color` color **)** -Overrides the color in the :ref:`theme` resource the node uses. +Overrides the color in the :ref:`theme` resource the node uses. -.. _class_Control_add_constant_override: +.. _class_Control_method_add_constant_override: - void **add_constant_override** **(** :ref:`String` name, :ref:`int` constant **)** -Overrides an integer constant in the :ref:`theme` resource the node uses. If the ``constant`` is invalid, Godot clears the override. +Overrides an integer constant in the :ref:`theme` resource the node uses. If the ``constant`` is invalid, Godot clears the override. -.. _class_Control_add_font_override: +.. _class_Control_method_add_font_override: - void **add_font_override** **(** :ref:`String` name, :ref:`Font` font **)** -Overrides the ``name`` font in the :ref:`theme` resource the node uses. If ``font`` is empty, Godot clears the override. +Overrides the ``name`` font in the :ref:`theme` resource the node uses. If ``font`` is empty, Godot clears the override. -.. _class_Control_add_icon_override: +.. _class_Control_method_add_icon_override: - void **add_icon_override** **(** :ref:`String` name, :ref:`Texture` texture **)** -Overrides the ``name`` icon in the :ref:`theme` resource the node uses. If ``icon`` is empty, Godot clears the override. +Overrides the ``name`` icon in the :ref:`theme` resource the node uses. If ``icon`` is empty, Godot clears the override. -.. _class_Control_add_shader_override: +.. _class_Control_method_add_shader_override: - void **add_shader_override** **(** :ref:`String` name, :ref:`Shader` shader **)** -Overrides the ``name`` shader in the :ref:`theme` resource the node uses. If ``shader`` is empty, Godot clears the override. +Overrides the ``name`` shader in the :ref:`theme` resource the node uses. If ``shader`` is empty, Godot clears the override. -.. _class_Control_add_stylebox_override: +.. _class_Control_method_add_stylebox_override: - void **add_stylebox_override** **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** -Overrides the ``name`` :ref:`StyleBox` in the :ref:`theme` resource the node uses. If ``stylebox`` is empty, Godot clears the override. +Overrides the ``name`` :ref:`StyleBox` in the :ref:`theme` resource the node uses. If ``stylebox`` is empty, Godot clears the override. -.. _class_Control_can_drop_data: +.. _class_Control_method_can_drop_data: - :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. +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. -This method should only be used to test the data. Process the data in :ref:`drop_data`. +This method should only be used to test the data. Process the data in :ref:`drop_data`. :: @@ -932,11 +1056,11 @@ This method should only be used to test the data. Process the data in :ref:`drop # otherwise just check data return typeof(data) == TYPE_DICTIONARY and data.has('expected') -.. _class_Control_drop_data: +.. _class_Control_method_drop_data: - 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. +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. :: @@ -948,45 +1072,45 @@ Godot calls this method to pass you the ``data`` from a control's :ref:`get_drag func drop_data(position, data): color = data['color'] -.. _class_Control_force_drag: +.. _class_Control_method_force_drag: - void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** -Forces drag and bypasses :ref:`get_drag_data` and :ref:`set_drag_preview` by passing ``data`` and ``preview``. Drag will start even if the mouse is neither over nor pressed on this control. +Forces drag and bypasses :ref:`get_drag_data` and :ref:`set_drag_preview` by passing ``data`` and ``preview``. Drag will start even if the mouse is neither over nor pressed on this control. -The methods :ref:`can_drop_data` and :ref:`drop_data` must be implemented on controls that want to receive drop data. +The methods :ref:`can_drop_data` and :ref:`drop_data` must be implemented on controls that want to receive drop data. -.. _class_Control_get_begin: +.. _class_Control_method_get_begin: - :ref:`Vector2` **get_begin** **(** **)** const -Returns :ref:`margin_left` and :ref:`margin_top`. See also :ref:`rect_position`. +Returns :ref:`margin_left` and :ref:`margin_top`. See also :ref:`rect_position`. -.. _class_Control_get_color: +.. _class_Control_method_get_color: - :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_combined_minimum_size: +.. _class_Control_method_get_combined_minimum_size: - :ref:`Vector2` **get_combined_minimum_size** **(** **)** const -.. _class_Control_get_constant: +.. _class_Control_method_get_constant: - :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_cursor_shape: +.. _class_Control_method_get_cursor_shape: - :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`. +Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape`. -.. _class_Control_get_drag_data: +.. _class_Control_method_get_drag_data: - :ref:`Object` **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. Return 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`. +Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Return 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`. -A preview that will follow the mouse that should represent the data can be set with :ref:`set_drag_preview`. A good time to set the preview is in this method. +A preview that will follow the mouse that should represent the data can be set with :ref:`set_drag_preview`. A good time to set the preview is in this method. :: @@ -997,175 +1121,175 @@ A preview that will follow the mouse that should represent the data can be set w set_drag_preview(make_preview(mydata)) return mydata -.. _class_Control_get_end: +.. _class_Control_method_get_end: - :ref:`Vector2` **get_end** **(** **)** const -Returns :ref:`margin_right` and :ref:`margin_bottom`. +Returns :ref:`margin_right` and :ref:`margin_bottom`. -.. _class_Control_get_focus_owner: +.. _class_Control_method_get_focus_owner: - :ref:`Control` **get_focus_owner** **(** **)** const Returns the control that has the keyboard focus or ``null`` if none. -.. _class_Control_get_font: +.. _class_Control_method_get_font: - :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_global_rect: +.. _class_Control_method_get_global_rect: - :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`. +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`. -.. _class_Control_get_icon: +.. _class_Control_method_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_minimum_size: +.. _class_Control_method_get_minimum_size: - :ref:`Vector2` **get_minimum_size** **(** **)** const -Returns the minimum size for this control. See :ref:`rect_min_size`. +Returns the minimum size for this control. See :ref:`rect_min_size`. -.. _class_Control_get_parent_area_size: +.. _class_Control_method_get_parent_area_size: - :ref:`Vector2` **get_parent_area_size** **(** **)** const Returns the width/height occupied in the parent control. -.. _class_Control_get_parent_control: +.. _class_Control_method_get_parent_control: - :ref:`Control` **get_parent_control** **(** **)** const Returns the parent control node. -.. _class_Control_get_rect: +.. _class_Control_method_get_rect: - :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`. +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`. -.. _class_Control_get_rotation: +.. _class_Control_method_get_rotation: - :ref:`float` **get_rotation** **(** **)** const Returns the rotation (in radians). -.. _class_Control_get_stylebox: +.. _class_Control_method_get_stylebox: - :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_tooltip: +.. _class_Control_method_get_tooltip: - :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. -.. _class_Control_grab_click_focus: +.. _class_Control_method_grab_click_focus: - void **grab_click_focus** **(** **)** -.. _class_Control_grab_focus: +.. _class_Control_method_grab_focus: - void **grab_focus** **(** **)** -Steal the focus from another control and become the focused control (see :ref:`focus_mode`). +Steal the focus from another control and become the focused control (see :ref:`focus_mode`). -.. _class_Control_has_color: +.. _class_Control_method_has_color: - :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_color_override: +.. _class_Control_method_has_color_override: - :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const -.. _class_Control_has_constant: +.. _class_Control_method_has_constant: - :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_constant_override: +.. _class_Control_method_has_constant_override: - :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const -.. _class_Control_has_focus: +.. _class_Control_method_has_focus: - :ref:`bool` **has_focus** **(** **)** const -Returns ``true`` if this is the current focused control. See :ref:`focus_mode`. +Returns ``true`` if this is the current focused control. See :ref:`focus_mode`. -.. _class_Control_has_font: +.. _class_Control_method_has_font: - :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_font_override: +.. _class_Control_method_has_font_override: - :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const -.. _class_Control_has_icon: +.. _class_Control_method_has_icon: - :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_icon_override: +.. _class_Control_method_has_icon_override: - :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const -.. _class_Control_has_point: +.. _class_Control_method_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual -.. _class_Control_has_shader_override: +.. _class_Control_method_has_shader_override: - :ref:`bool` **has_shader_override** **(** :ref:`String` name **)** const -.. _class_Control_has_stylebox: +.. _class_Control_method_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_stylebox_override: +.. _class_Control_method_has_stylebox_override: - :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const -.. _class_Control_minimum_size_changed: +.. _class_Control_method_minimum_size_changed: - void **minimum_size_changed** **(** **)** -.. _class_Control_release_focus: +.. _class_Control_method_release_focus: - void **release_focus** **(** **)** Give up the focus. No other control will be able to receive keyboard input. -.. _class_Control_set_anchor: +.. _class_Control_method_set_anchor: - void **set_anchor** **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** -.. _class_Control_set_anchor_and_margin: +.. _class_Control_method_set_anchor_and_margin: - void **set_anchor_and_margin** **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** -.. _class_Control_set_anchors_and_margins_preset: +.. _class_Control_method_set_anchors_and_margins_preset: - void **set_anchors_and_margins_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** -.. _class_Control_set_anchors_preset: +.. _class_Control_method_set_anchors_preset: - void **set_anchors_preset** **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** -.. _class_Control_set_begin: +.. _class_Control_method_set_begin: - void **set_begin** **(** :ref:`Vector2` position **)** -Sets :ref:`margin_left` and :ref:`margin_top` at the same time. +Sets :ref:`margin_left` and :ref:`margin_top` at the same time. -.. _class_Control_set_drag_forwarding: +.. _class_Control_method_set_drag_forwarding: - void **set_drag_forwarding** **(** :ref:`Control` target **)** Forwards the handling of this control's drag and drop to ``target`` control. -Forwarding can be implemented in the target control similar to the methods :ref:`get_drag_data`, :ref:`can_drop_data`, and :ref:`drop_data` but with two differences: +Forwarding can be implemented in the target control similar to the methods :ref:`get_drag_data`, :ref:`can_drop_data`, and :ref:`drop_data` but with two differences: 1. The function name must be suffixed with **_fw** @@ -1190,35 +1314,35 @@ Forwarding can be implemented in the target control similar to the methods :ref: set_drag_preview(my_preview) return my_data() -.. _class_Control_set_drag_preview: +.. _class_Control_method_set_drag_preview: - void **set_drag_preview** **(** :ref:`Control` control **)** -Shows the given control at the mouse pointer. A good time to call this method is in :ref:`get_drag_data`. +Shows the given control at the mouse pointer. A good time to call this method is in :ref:`get_drag_data`. -.. _class_Control_set_end: +.. _class_Control_method_set_end: - void **set_end** **(** :ref:`Vector2` position **)** -Sets :ref:`margin_right` and :ref:`margin_bottom` at the same time. +Sets :ref:`margin_right` and :ref:`margin_bottom` at the same time. -.. _class_Control_set_margins_preset: +.. _class_Control_method_set_margins_preset: - void **set_margins_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** -.. _class_Control_set_rotation: +.. _class_Control_method_set_rotation: - void **set_rotation** **(** :ref:`float` radians **)** Sets the rotation (in radians). -.. _class_Control_show_modal: +.. _class_Control_method_show_modal: - void **show_modal** **(** :ref:`bool` exclusive=false **)** Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. -.. _class_Control_warp_mouse: +.. _class_Control_method_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 5faad0172..7385d4227 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -19,9 +19,9 @@ Convex polygon shape for 3D physics. Properties ---------- -+-------------------------------------------------+------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`points` | -+-------------------------------------------------+------------------------------------------------+ ++-------------------------------------------------+---------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`points` | ++-------------------------------------------------+---------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Convex polygon shape resource, which can be added to a :ref:`PhysicsBody` **points** diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 1ca8d52a7..4c536e0f2 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -19,16 +19,16 @@ Convex Polygon Shape for 2D physics. Properties ---------- -+-------------------------------------------------+--------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`points` | -+-------------------------------------------------+--------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`points` | ++-------------------------------------------------+-----------------------------------------------------------+ Methods ------- -+-------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -40,7 +40,7 @@ The main difference between a ``ConvexPolygonShape2D`` and a :ref:`ConcavePolygo Property Descriptions --------------------- -.. _class_ConvexPolygonShape2D_points: +.. _class_ConvexPolygonShape2D_property_points: - :ref:`PoolVector2Array` **points** @@ -55,9 +55,9 @@ The polygon's list of vertices. Can be in either clockwise or counterclockwise o Method Descriptions ------------------- -.. _class_ConvexPolygonShape2D_set_point_cloud: +.. _class_ConvexPolygonShape2D_method_set_point_cloud: - void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** -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. +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. diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index ddb19c3a2..a0d4f4090 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -19,140 +19,146 @@ Brief Description Properties ---------- -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`amount` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`angle_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`angular_velocity_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`anim_offset_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`anim_speed_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`color_ramp` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`damping_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`DrawOrder` | :ref:`draw_order` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`emission_box_extents` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`emission_colors` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`emission_normals` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`emission_points` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`EmissionShape` | :ref:`emission_shape` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_sphere_radius` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emitting` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`explosiveness` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_fps` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_align_y` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_disable_z` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_rotate_y` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`flatness` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fract_delta` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`gravity` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`hue_variation_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lifetime` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`linear_accel_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`local_coords` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`preprocess` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`radial_accel_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randomness` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_amount` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`scale_amount_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_amount_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spread` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`tangential_accel_curve` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel_random` | -+-------------------------------------------------------+----------------------------------------------------------------------------+ ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`amount` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`angle_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`angular_velocity_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_offset` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`anim_offset_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_offset_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_speed` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`anim_speed_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_speed_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`color_ramp` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`damping_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`DrawOrder` | :ref:`draw_order` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`emission_box_extents` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`emission_colors` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`emission_normals` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`emission_points` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`EmissionShape` | :ref:`emission_shape` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`emission_sphere_radius` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`emitting` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`explosiveness` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`fixed_fps` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flag_align_y` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flag_disable_z` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flag_rotate_y` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`flatness` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fract_delta` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`gravity` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`hue_variation` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`hue_variation_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`hue_variation_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`initial_velocity` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`initial_velocity_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lifetime` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_accel` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`linear_accel_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_accel_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`local_coords` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`one_shot` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`preprocess` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_accel` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`radial_accel_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_accel_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randomness` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`scale_amount` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`scale_amount_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`scale_amount_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`speed_scale` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`spread` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tangential_accel` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`tangential_accel_curve` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tangential_accel_random` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+ Methods ------- -+-------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | -+-------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`restart` **(** **)** | -+-------+------------------------------------------------------------------------------------------------------------------------+ ++------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_CPUParticles_DrawOrder: +.. _class_CPUParticles_constant_DRAW_ORDER_INDEX: + +.. _class_CPUParticles_constant_DRAW_ORDER_LIFETIME: + +.. _class_CPUParticles_constant_DRAW_ORDER_VIEW_DEPTH: + enum **DrawOrder**: - **DRAW_ORDER_INDEX** = **0** @@ -163,6 +169,30 @@ enum **DrawOrder**: .. _enum_CPUParticles_Parameter: +.. _class_CPUParticles_constant_PARAM_INITIAL_LINEAR_VELOCITY: + +.. _class_CPUParticles_constant_PARAM_ANGULAR_VELOCITY: + +.. _class_CPUParticles_constant_PARAM_LINEAR_ACCEL: + +.. _class_CPUParticles_constant_PARAM_RADIAL_ACCEL: + +.. _class_CPUParticles_constant_PARAM_TANGENTIAL_ACCEL: + +.. _class_CPUParticles_constant_PARAM_DAMPING: + +.. _class_CPUParticles_constant_PARAM_ANGLE: + +.. _class_CPUParticles_constant_PARAM_SCALE: + +.. _class_CPUParticles_constant_PARAM_HUE_VARIATION: + +.. _class_CPUParticles_constant_PARAM_ANIM_SPEED: + +.. _class_CPUParticles_constant_PARAM_ANIM_OFFSET: + +.. _class_CPUParticles_constant_PARAM_MAX: + enum **Parameter**: - **PARAM_INITIAL_LINEAR_VELOCITY** = **0** @@ -191,6 +221,12 @@ enum **Parameter**: .. _enum_CPUParticles_Flags: +.. _class_CPUParticles_constant_FLAG_ALIGN_Y_TO_VELOCITY: + +.. _class_CPUParticles_constant_FLAG_ROTATE_Y: + +.. _class_CPUParticles_constant_FLAG_MAX: + enum **Flags**: - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** @@ -201,6 +237,16 @@ enum **Flags**: .. _enum_CPUParticles_EmissionShape: +.. _class_CPUParticles_constant_EMISSION_SHAPE_POINT: + +.. _class_CPUParticles_constant_EMISSION_SHAPE_SPHERE: + +.. _class_CPUParticles_constant_EMISSION_SHAPE_BOX: + +.. _class_CPUParticles_constant_EMISSION_SHAPE_POINTS: + +.. _class_CPUParticles_constant_EMISSION_SHAPE_DIRECTED_POINTS: + enum **EmissionShape**: - **EMISSION_SHAPE_POINT** = **0** @@ -216,7 +262,7 @@ enum **EmissionShape**: Property Descriptions --------------------- -.. _class_CPUParticles_amount: +.. _class_CPUParticles_property_amount: - :ref:`int` **amount** @@ -226,7 +272,7 @@ Property Descriptions | *Getter* | get_amount() | +----------+-------------------+ -.. _class_CPUParticles_angle: +.. _class_CPUParticles_property_angle: - :ref:`float` **angle** @@ -236,7 +282,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_angle_curve: +.. _class_CPUParticles_property_angle_curve: - :ref:`Curve` **angle_curve** @@ -246,7 +292,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_angle_random: +.. _class_CPUParticles_property_angle_random: - :ref:`float` **angle_random** @@ -256,7 +302,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_angular_velocity: +.. _class_CPUParticles_property_angular_velocity: - :ref:`float` **angular_velocity** @@ -266,7 +312,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_angular_velocity_curve: +.. _class_CPUParticles_property_angular_velocity_curve: - :ref:`Curve` **angular_velocity_curve** @@ -276,7 +322,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_angular_velocity_random: +.. _class_CPUParticles_property_angular_velocity_random: - :ref:`float` **angular_velocity_random** @@ -286,7 +332,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_anim_offset: +.. _class_CPUParticles_property_anim_offset: - :ref:`float` **anim_offset** @@ -296,7 +342,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_anim_offset_curve: +.. _class_CPUParticles_property_anim_offset_curve: - :ref:`Curve` **anim_offset_curve** @@ -306,7 +352,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_anim_offset_random: +.. _class_CPUParticles_property_anim_offset_random: - :ref:`float` **anim_offset_random** @@ -316,7 +362,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_anim_speed: +.. _class_CPUParticles_property_anim_speed: - :ref:`float` **anim_speed** @@ -326,7 +372,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_anim_speed_curve: +.. _class_CPUParticles_property_anim_speed_curve: - :ref:`Curve` **anim_speed_curve** @@ -336,7 +382,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_anim_speed_random: +.. _class_CPUParticles_property_anim_speed_random: - :ref:`float` **anim_speed_random** @@ -346,7 +392,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_color: +.. _class_CPUParticles_property_color: - :ref:`Color` **color** @@ -356,7 +402,7 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ -.. _class_CPUParticles_color_ramp: +.. _class_CPUParticles_property_color_ramp: - :ref:`Gradient` **color_ramp** @@ -366,7 +412,7 @@ Property Descriptions | *Getter* | get_color_ramp() | +----------+-----------------------+ -.. _class_CPUParticles_damping: +.. _class_CPUParticles_property_damping: - :ref:`float` **damping** @@ -376,7 +422,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_damping_curve: +.. _class_CPUParticles_property_damping_curve: - :ref:`Curve` **damping_curve** @@ -386,7 +432,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_damping_random: +.. _class_CPUParticles_property_damping_random: - :ref:`float` **damping_random** @@ -396,7 +442,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_draw_order: +.. _class_CPUParticles_property_draw_order: - :ref:`DrawOrder` **draw_order** @@ -406,7 +452,7 @@ Property Descriptions | *Getter* | get_draw_order() | +----------+-----------------------+ -.. _class_CPUParticles_emission_box_extents: +.. _class_CPUParticles_property_emission_box_extents: - :ref:`Vector3` **emission_box_extents** @@ -416,7 +462,7 @@ Property Descriptions | *Getter* | get_emission_box_extents() | +----------+---------------------------------+ -.. _class_CPUParticles_emission_colors: +.. _class_CPUParticles_property_emission_colors: - :ref:`PoolColorArray` **emission_colors** @@ -426,7 +472,7 @@ Property Descriptions | *Getter* | get_emission_colors() | +----------+----------------------------+ -.. _class_CPUParticles_emission_normals: +.. _class_CPUParticles_property_emission_normals: - :ref:`PoolVector3Array` **emission_normals** @@ -436,7 +482,7 @@ Property Descriptions | *Getter* | get_emission_normals() | +----------+-----------------------------+ -.. _class_CPUParticles_emission_points: +.. _class_CPUParticles_property_emission_points: - :ref:`PoolVector3Array` **emission_points** @@ -446,7 +492,7 @@ Property Descriptions | *Getter* | get_emission_points() | +----------+----------------------------+ -.. _class_CPUParticles_emission_shape: +.. _class_CPUParticles_property_emission_shape: - :ref:`EmissionShape` **emission_shape** @@ -456,7 +502,7 @@ Property Descriptions | *Getter* | get_emission_shape() | +----------+---------------------------+ -.. _class_CPUParticles_emission_sphere_radius: +.. _class_CPUParticles_property_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** @@ -466,7 +512,7 @@ Property Descriptions | *Getter* | get_emission_sphere_radius() | +----------+-----------------------------------+ -.. _class_CPUParticles_emitting: +.. _class_CPUParticles_property_emitting: - :ref:`bool` **emitting** @@ -476,7 +522,7 @@ Property Descriptions | *Getter* | is_emitting() | +----------+---------------------+ -.. _class_CPUParticles_explosiveness: +.. _class_CPUParticles_property_explosiveness: - :ref:`float` **explosiveness** @@ -486,7 +532,7 @@ Property Descriptions | *Getter* | get_explosiveness_ratio() | +----------+--------------------------------+ -.. _class_CPUParticles_fixed_fps: +.. _class_CPUParticles_property_fixed_fps: - :ref:`int` **fixed_fps** @@ -496,7 +542,7 @@ Property Descriptions | *Getter* | get_fixed_fps() | +----------+----------------------+ -.. _class_CPUParticles_flag_align_y: +.. _class_CPUParticles_property_flag_align_y: - :ref:`bool` **flag_align_y** @@ -506,7 +552,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ -.. _class_CPUParticles_flag_disable_z: +.. _class_CPUParticles_property_flag_disable_z: - :ref:`bool` **flag_disable_z** @@ -516,7 +562,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ -.. _class_CPUParticles_flag_rotate_y: +.. _class_CPUParticles_property_flag_rotate_y: - :ref:`bool` **flag_rotate_y** @@ -526,7 +572,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ -.. _class_CPUParticles_flatness: +.. _class_CPUParticles_property_flatness: - :ref:`float` **flatness** @@ -536,7 +582,7 @@ Property Descriptions | *Getter* | get_flatness() | +----------+---------------------+ -.. _class_CPUParticles_fract_delta: +.. _class_CPUParticles_property_fract_delta: - :ref:`bool` **fract_delta** @@ -546,7 +592,7 @@ Property Descriptions | *Getter* | get_fractional_delta() | +----------+-----------------------------+ -.. _class_CPUParticles_gravity: +.. _class_CPUParticles_property_gravity: - :ref:`Vector3` **gravity** @@ -556,7 +602,7 @@ Property Descriptions | *Getter* | get_gravity() | +----------+--------------------+ -.. _class_CPUParticles_hue_variation: +.. _class_CPUParticles_property_hue_variation: - :ref:`float` **hue_variation** @@ -566,7 +612,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_hue_variation_curve: +.. _class_CPUParticles_property_hue_variation_curve: - :ref:`Curve` **hue_variation_curve** @@ -576,7 +622,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_hue_variation_random: +.. _class_CPUParticles_property_hue_variation_random: - :ref:`float` **hue_variation_random** @@ -586,7 +632,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_initial_velocity: +.. _class_CPUParticles_property_initial_velocity: - :ref:`float` **initial_velocity** @@ -596,7 +642,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_initial_velocity_random: +.. _class_CPUParticles_property_initial_velocity_random: - :ref:`float` **initial_velocity_random** @@ -606,7 +652,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_lifetime: +.. _class_CPUParticles_property_lifetime: - :ref:`float` **lifetime** @@ -616,7 +662,7 @@ Property Descriptions | *Getter* | get_lifetime() | +----------+---------------------+ -.. _class_CPUParticles_linear_accel: +.. _class_CPUParticles_property_linear_accel: - :ref:`float` **linear_accel** @@ -626,7 +672,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_linear_accel_curve: +.. _class_CPUParticles_property_linear_accel_curve: - :ref:`Curve` **linear_accel_curve** @@ -636,7 +682,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_linear_accel_random: +.. _class_CPUParticles_property_linear_accel_random: - :ref:`float` **linear_accel_random** @@ -646,7 +692,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_local_coords: +.. _class_CPUParticles_property_local_coords: - :ref:`bool` **local_coords** @@ -656,7 +702,7 @@ Property Descriptions | *Getter* | get_use_local_coordinates() | +----------+----------------------------------+ -.. _class_CPUParticles_mesh: +.. _class_CPUParticles_property_mesh: - :ref:`Mesh` **mesh** @@ -666,7 +712,7 @@ Property Descriptions | *Getter* | get_mesh() | +----------+-----------------+ -.. _class_CPUParticles_one_shot: +.. _class_CPUParticles_property_one_shot: - :ref:`bool` **one_shot** @@ -676,7 +722,7 @@ Property Descriptions | *Getter* | get_one_shot() | +----------+---------------------+ -.. _class_CPUParticles_preprocess: +.. _class_CPUParticles_property_preprocess: - :ref:`float` **preprocess** @@ -686,7 +732,7 @@ Property Descriptions | *Getter* | get_pre_process_time() | +----------+-----------------------------+ -.. _class_CPUParticles_radial_accel: +.. _class_CPUParticles_property_radial_accel: - :ref:`float` **radial_accel** @@ -696,7 +742,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_radial_accel_curve: +.. _class_CPUParticles_property_radial_accel_curve: - :ref:`Curve` **radial_accel_curve** @@ -706,7 +752,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_radial_accel_random: +.. _class_CPUParticles_property_radial_accel_random: - :ref:`float` **radial_accel_random** @@ -716,7 +762,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_randomness: +.. _class_CPUParticles_property_randomness: - :ref:`float` **randomness** @@ -726,7 +772,7 @@ Property Descriptions | *Getter* | get_randomness_ratio() | +----------+-----------------------------+ -.. _class_CPUParticles_scale_amount: +.. _class_CPUParticles_property_scale_amount: - :ref:`float` **scale_amount** @@ -736,7 +782,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_scale_amount_curve: +.. _class_CPUParticles_property_scale_amount_curve: - :ref:`Curve` **scale_amount_curve** @@ -746,7 +792,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_scale_amount_random: +.. _class_CPUParticles_property_scale_amount_random: - :ref:`float` **scale_amount_random** @@ -756,7 +802,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles_speed_scale: +.. _class_CPUParticles_property_speed_scale: - :ref:`float` **speed_scale** @@ -766,7 +812,7 @@ Property Descriptions | *Getter* | get_speed_scale() | +----------+------------------------+ -.. _class_CPUParticles_spread: +.. _class_CPUParticles_property_spread: - :ref:`float` **spread** @@ -776,7 +822,7 @@ Property Descriptions | *Getter* | get_spread() | +----------+-------------------+ -.. _class_CPUParticles_tangential_accel: +.. _class_CPUParticles_property_tangential_accel: - :ref:`float` **tangential_accel** @@ -786,7 +832,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles_tangential_accel_curve: +.. _class_CPUParticles_property_tangential_accel_curve: - :ref:`Curve` **tangential_accel_curve** @@ -796,7 +842,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles_tangential_accel_random: +.. _class_CPUParticles_property_tangential_accel_random: - :ref:`float` **tangential_accel_random** @@ -809,11 +855,11 @@ Property Descriptions Method Descriptions ------------------- -.. _class_CPUParticles_convert_from_particles: +.. _class_CPUParticles_method_convert_from_particles: - void **convert_from_particles** **(** :ref:`Node` particles **)** -.. _class_CPUParticles_restart: +.. _class_CPUParticles_method_restart: - void **restart** **(** **)** diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index cb501f0fb..d669f4331 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -19,138 +19,142 @@ Brief Description Properties ---------- -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`amount` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`angle_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`angular_velocity_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`anim_offset_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`anim_speed_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`color_ramp` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`damping_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`DrawOrder` | :ref:`draw_order` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`emission_colors` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`emission_normals` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`emission_points` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`emission_rect_extents` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`EmissionShape` | :ref:`emission_shape` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_sphere_radius` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emitting` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`explosiveness` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_fps` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_align_y` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`flatness` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fract_delta` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`gravity` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`hue_variation_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lifetime` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`linear_accel_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`local_coords` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normalmap` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`preprocess` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`radial_accel_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randomness` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_amount` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`scale_amount_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_amount_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spread` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Curve` | :ref:`tangential_accel_curve` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel_random` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+---------------------------------------------------------+------------------------------------------------------------------------------+ ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`amount` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`angle_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`angular_velocity_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_offset` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`anim_offset_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_offset_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_speed` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`anim_speed_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_speed_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`color_ramp` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`damping_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`DrawOrder` | :ref:`draw_order` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`emission_colors` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`emission_normals` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`emission_points` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`emission_rect_extents` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`EmissionShape` | :ref:`emission_shape` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`emission_sphere_radius` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`emitting` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`explosiveness` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`fixed_fps` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flag_align_y` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`flatness` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fract_delta` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`gravity` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`hue_variation` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`hue_variation_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`hue_variation_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`initial_velocity` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`initial_velocity_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lifetime` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_accel` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`linear_accel_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_accel_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`local_coords` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`normalmap` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`one_shot` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`preprocess` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_accel` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`radial_accel_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_accel_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randomness` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`scale_amount` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`scale_amount_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`scale_amount_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`speed_scale` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`spread` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tangential_accel` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`tangential_accel_curve` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tangential_accel_random` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+ Methods ------- -+-------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`restart` **(** **)** | -+-------+--------------------------------------------------------------------------------------------------------------------------+ ++------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_CPUParticles2D_DrawOrder: +.. _class_CPUParticles2D_constant_DRAW_ORDER_INDEX: + +.. _class_CPUParticles2D_constant_DRAW_ORDER_LIFETIME: + enum **DrawOrder**: - **DRAW_ORDER_INDEX** = **0** @@ -159,6 +163,32 @@ enum **DrawOrder**: .. _enum_CPUParticles2D_Parameter: +.. _class_CPUParticles2D_constant_PARAM_INITIAL_LINEAR_VELOCITY: + +.. _class_CPUParticles2D_constant_PARAM_ANGULAR_VELOCITY: + +.. _class_CPUParticles2D_constant_PARAM_ORBIT_VELOCITY: + +.. _class_CPUParticles2D_constant_PARAM_LINEAR_ACCEL: + +.. _class_CPUParticles2D_constant_PARAM_RADIAL_ACCEL: + +.. _class_CPUParticles2D_constant_PARAM_TANGENTIAL_ACCEL: + +.. _class_CPUParticles2D_constant_PARAM_DAMPING: + +.. _class_CPUParticles2D_constant_PARAM_ANGLE: + +.. _class_CPUParticles2D_constant_PARAM_SCALE: + +.. _class_CPUParticles2D_constant_PARAM_HUE_VARIATION: + +.. _class_CPUParticles2D_constant_PARAM_ANIM_SPEED: + +.. _class_CPUParticles2D_constant_PARAM_ANIM_OFFSET: + +.. _class_CPUParticles2D_constant_PARAM_MAX: + enum **Parameter**: - **PARAM_INITIAL_LINEAR_VELOCITY** = **0** @@ -189,6 +219,10 @@ enum **Parameter**: .. _enum_CPUParticles2D_Flags: +.. _class_CPUParticles2D_constant_FLAG_ALIGN_Y_TO_VELOCITY: + +.. _class_CPUParticles2D_constant_FLAG_MAX: + enum **Flags**: - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** @@ -197,6 +231,16 @@ enum **Flags**: .. _enum_CPUParticles2D_EmissionShape: +.. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINT: + +.. _class_CPUParticles2D_constant_EMISSION_SHAPE_CIRCLE: + +.. _class_CPUParticles2D_constant_EMISSION_SHAPE_RECTANGLE: + +.. _class_CPUParticles2D_constant_EMISSION_SHAPE_POINTS: + +.. _class_CPUParticles2D_constant_EMISSION_SHAPE_DIRECTED_POINTS: + enum **EmissionShape**: - **EMISSION_SHAPE_POINT** = **0** @@ -212,7 +256,7 @@ enum **EmissionShape**: Property Descriptions --------------------- -.. _class_CPUParticles2D_amount: +.. _class_CPUParticles2D_property_amount: - :ref:`int` **amount** @@ -222,7 +266,7 @@ Property Descriptions | *Getter* | get_amount() | +----------+-------------------+ -.. _class_CPUParticles2D_angle: +.. _class_CPUParticles2D_property_angle: - :ref:`float` **angle** @@ -232,7 +276,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_angle_curve: +.. _class_CPUParticles2D_property_angle_curve: - :ref:`Curve` **angle_curve** @@ -242,7 +286,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_angle_random: +.. _class_CPUParticles2D_property_angle_random: - :ref:`float` **angle_random** @@ -252,7 +296,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_angular_velocity: +.. _class_CPUParticles2D_property_angular_velocity: - :ref:`float` **angular_velocity** @@ -262,7 +306,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_angular_velocity_curve: +.. _class_CPUParticles2D_property_angular_velocity_curve: - :ref:`Curve` **angular_velocity_curve** @@ -272,7 +316,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_angular_velocity_random: +.. _class_CPUParticles2D_property_angular_velocity_random: - :ref:`float` **angular_velocity_random** @@ -282,7 +326,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_anim_offset: +.. _class_CPUParticles2D_property_anim_offset: - :ref:`float` **anim_offset** @@ -292,7 +336,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_anim_offset_curve: +.. _class_CPUParticles2D_property_anim_offset_curve: - :ref:`Curve` **anim_offset_curve** @@ -302,7 +346,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_anim_offset_random: +.. _class_CPUParticles2D_property_anim_offset_random: - :ref:`float` **anim_offset_random** @@ -312,7 +356,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_anim_speed: +.. _class_CPUParticles2D_property_anim_speed: - :ref:`float` **anim_speed** @@ -322,7 +366,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_anim_speed_curve: +.. _class_CPUParticles2D_property_anim_speed_curve: - :ref:`Curve` **anim_speed_curve** @@ -332,7 +376,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_anim_speed_random: +.. _class_CPUParticles2D_property_anim_speed_random: - :ref:`float` **anim_speed_random** @@ -342,7 +386,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_color: +.. _class_CPUParticles2D_property_color: - :ref:`Color` **color** @@ -352,7 +396,7 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ -.. _class_CPUParticles2D_color_ramp: +.. _class_CPUParticles2D_property_color_ramp: - :ref:`Gradient` **color_ramp** @@ -362,7 +406,7 @@ Property Descriptions | *Getter* | get_color_ramp() | +----------+-----------------------+ -.. _class_CPUParticles2D_damping: +.. _class_CPUParticles2D_property_damping: - :ref:`float` **damping** @@ -372,7 +416,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_damping_curve: +.. _class_CPUParticles2D_property_damping_curve: - :ref:`Curve` **damping_curve** @@ -382,7 +426,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_damping_random: +.. _class_CPUParticles2D_property_damping_random: - :ref:`float` **damping_random** @@ -392,7 +436,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_draw_order: +.. _class_CPUParticles2D_property_draw_order: - :ref:`DrawOrder` **draw_order** @@ -402,7 +446,7 @@ Property Descriptions | *Getter* | get_draw_order() | +----------+-----------------------+ -.. _class_CPUParticles2D_emission_colors: +.. _class_CPUParticles2D_property_emission_colors: - :ref:`PoolColorArray` **emission_colors** @@ -412,7 +456,7 @@ Property Descriptions | *Getter* | get_emission_colors() | +----------+----------------------------+ -.. _class_CPUParticles2D_emission_normals: +.. _class_CPUParticles2D_property_emission_normals: - :ref:`PoolVector2Array` **emission_normals** @@ -422,7 +466,7 @@ Property Descriptions | *Getter* | get_emission_normals() | +----------+-----------------------------+ -.. _class_CPUParticles2D_emission_points: +.. _class_CPUParticles2D_property_emission_points: - :ref:`PoolVector2Array` **emission_points** @@ -432,7 +476,7 @@ Property Descriptions | *Getter* | get_emission_points() | +----------+----------------------------+ -.. _class_CPUParticles2D_emission_rect_extents: +.. _class_CPUParticles2D_property_emission_rect_extents: - :ref:`Vector2` **emission_rect_extents** @@ -442,7 +486,7 @@ Property Descriptions | *Getter* | get_emission_rect_extents() | +----------+----------------------------------+ -.. _class_CPUParticles2D_emission_shape: +.. _class_CPUParticles2D_property_emission_shape: - :ref:`EmissionShape` **emission_shape** @@ -452,7 +496,7 @@ Property Descriptions | *Getter* | get_emission_shape() | +----------+---------------------------+ -.. _class_CPUParticles2D_emission_sphere_radius: +.. _class_CPUParticles2D_property_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** @@ -462,7 +506,7 @@ Property Descriptions | *Getter* | get_emission_sphere_radius() | +----------+-----------------------------------+ -.. _class_CPUParticles2D_emitting: +.. _class_CPUParticles2D_property_emitting: - :ref:`bool` **emitting** @@ -472,7 +516,7 @@ Property Descriptions | *Getter* | is_emitting() | +----------+---------------------+ -.. _class_CPUParticles2D_explosiveness: +.. _class_CPUParticles2D_property_explosiveness: - :ref:`float` **explosiveness** @@ -482,7 +526,7 @@ Property Descriptions | *Getter* | get_explosiveness_ratio() | +----------+--------------------------------+ -.. _class_CPUParticles2D_fixed_fps: +.. _class_CPUParticles2D_property_fixed_fps: - :ref:`int` **fixed_fps** @@ -492,7 +536,7 @@ Property Descriptions | *Getter* | get_fixed_fps() | +----------+----------------------+ -.. _class_CPUParticles2D_flag_align_y: +.. _class_CPUParticles2D_property_flag_align_y: - :ref:`bool` **flag_align_y** @@ -502,7 +546,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ -.. _class_CPUParticles2D_flatness: +.. _class_CPUParticles2D_property_flatness: - :ref:`float` **flatness** @@ -512,7 +556,7 @@ Property Descriptions | *Getter* | get_flatness() | +----------+---------------------+ -.. _class_CPUParticles2D_fract_delta: +.. _class_CPUParticles2D_property_fract_delta: - :ref:`bool` **fract_delta** @@ -522,7 +566,7 @@ Property Descriptions | *Getter* | get_fractional_delta() | +----------+-----------------------------+ -.. _class_CPUParticles2D_gravity: +.. _class_CPUParticles2D_property_gravity: - :ref:`Vector2` **gravity** @@ -532,7 +576,7 @@ Property Descriptions | *Getter* | get_gravity() | +----------+--------------------+ -.. _class_CPUParticles2D_hue_variation: +.. _class_CPUParticles2D_property_hue_variation: - :ref:`float` **hue_variation** @@ -542,7 +586,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_hue_variation_curve: +.. _class_CPUParticles2D_property_hue_variation_curve: - :ref:`Curve` **hue_variation_curve** @@ -552,7 +596,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_hue_variation_random: +.. _class_CPUParticles2D_property_hue_variation_random: - :ref:`float` **hue_variation_random** @@ -562,7 +606,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_initial_velocity: +.. _class_CPUParticles2D_property_initial_velocity: - :ref:`float` **initial_velocity** @@ -572,7 +616,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_initial_velocity_random: +.. _class_CPUParticles2D_property_initial_velocity_random: - :ref:`float` **initial_velocity_random** @@ -582,7 +626,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_lifetime: +.. _class_CPUParticles2D_property_lifetime: - :ref:`float` **lifetime** @@ -592,7 +636,7 @@ Property Descriptions | *Getter* | get_lifetime() | +----------+---------------------+ -.. _class_CPUParticles2D_linear_accel: +.. _class_CPUParticles2D_property_linear_accel: - :ref:`float` **linear_accel** @@ -602,7 +646,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_linear_accel_curve: +.. _class_CPUParticles2D_property_linear_accel_curve: - :ref:`Curve` **linear_accel_curve** @@ -612,7 +656,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_linear_accel_random: +.. _class_CPUParticles2D_property_linear_accel_random: - :ref:`float` **linear_accel_random** @@ -622,7 +666,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_local_coords: +.. _class_CPUParticles2D_property_local_coords: - :ref:`bool` **local_coords** @@ -632,7 +676,7 @@ Property Descriptions | *Getter* | get_use_local_coordinates() | +----------+----------------------------------+ -.. _class_CPUParticles2D_normalmap: +.. _class_CPUParticles2D_property_normalmap: - :ref:`Texture` **normalmap** @@ -642,7 +686,7 @@ Property Descriptions | *Getter* | get_normalmap() | +----------+----------------------+ -.. _class_CPUParticles2D_one_shot: +.. _class_CPUParticles2D_property_one_shot: - :ref:`bool` **one_shot** @@ -652,7 +696,7 @@ Property Descriptions | *Getter* | get_one_shot() | +----------+---------------------+ -.. _class_CPUParticles2D_preprocess: +.. _class_CPUParticles2D_property_preprocess: - :ref:`float` **preprocess** @@ -662,7 +706,7 @@ Property Descriptions | *Getter* | get_pre_process_time() | +----------+-----------------------------+ -.. _class_CPUParticles2D_radial_accel: +.. _class_CPUParticles2D_property_radial_accel: - :ref:`float` **radial_accel** @@ -672,7 +716,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_radial_accel_curve: +.. _class_CPUParticles2D_property_radial_accel_curve: - :ref:`Curve` **radial_accel_curve** @@ -682,7 +726,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_radial_accel_random: +.. _class_CPUParticles2D_property_radial_accel_random: - :ref:`float` **radial_accel_random** @@ -692,7 +736,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_randomness: +.. _class_CPUParticles2D_property_randomness: - :ref:`float` **randomness** @@ -702,7 +746,7 @@ Property Descriptions | *Getter* | get_randomness_ratio() | +----------+-----------------------------+ -.. _class_CPUParticles2D_scale_amount: +.. _class_CPUParticles2D_property_scale_amount: - :ref:`float` **scale_amount** @@ -712,7 +756,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_scale_amount_curve: +.. _class_CPUParticles2D_property_scale_amount_curve: - :ref:`Curve` **scale_amount_curve** @@ -722,7 +766,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_scale_amount_random: +.. _class_CPUParticles2D_property_scale_amount_random: - :ref:`float` **scale_amount_random** @@ -732,7 +776,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_speed_scale: +.. _class_CPUParticles2D_property_speed_scale: - :ref:`float` **speed_scale** @@ -742,7 +786,7 @@ Property Descriptions | *Getter* | get_speed_scale() | +----------+------------------------+ -.. _class_CPUParticles2D_spread: +.. _class_CPUParticles2D_property_spread: - :ref:`float` **spread** @@ -752,7 +796,7 @@ Property Descriptions | *Getter* | get_spread() | +----------+-------------------+ -.. _class_CPUParticles2D_tangential_accel: +.. _class_CPUParticles2D_property_tangential_accel: - :ref:`float` **tangential_accel** @@ -762,7 +806,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_CPUParticles2D_tangential_accel_curve: +.. _class_CPUParticles2D_property_tangential_accel_curve: - :ref:`Curve` **tangential_accel_curve** @@ -772,7 +816,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ -.. _class_CPUParticles2D_tangential_accel_random: +.. _class_CPUParticles2D_property_tangential_accel_random: - :ref:`float` **tangential_accel_random** @@ -782,7 +826,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ -.. _class_CPUParticles2D_texture: +.. _class_CPUParticles2D_property_texture: - :ref:`Texture` **texture** @@ -795,11 +839,11 @@ Property Descriptions Method Descriptions ------------------- -.. _class_CPUParticles2D_convert_from_particles: +.. _class_CPUParticles2D_method_convert_from_particles: - void **convert_from_particles** **(** :ref:`Node` particles **)** -.. _class_CPUParticles2D_restart: +.. _class_CPUParticles2D_method_restart: - void **restart** **(** **)** diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index 1a92816ab..77052736b 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -19,15 +19,15 @@ A CSG Box shape. Properties ---------- -+---------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`depth` | -+---------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------------+----------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`width` | -+---------------------------------+----------------------------------------+ ++---------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`depth` | ++---------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------------+-------------------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`width` | ++---------------------------------+-------------------------------------------------+ Description ----------- @@ -37,7 +37,7 @@ This node allows you to create a box for use with the CSG system. Property Descriptions --------------------- -.. _class_CSGBox_depth: +.. _class_CSGBox_property_depth: - :ref:`float` **depth** @@ -49,7 +49,7 @@ Property Descriptions Depth of the box measured from the center of the box. -.. _class_CSGBox_height: +.. _class_CSGBox_property_height: - :ref:`float` **height** @@ -61,7 +61,7 @@ Depth of the box measured from the center of the box. Height of the box measured from the center of the box. -.. _class_CSGBox_material: +.. _class_CSGBox_property_material: - :ref:`Material` **material** @@ -73,7 +73,7 @@ Height of the box measured from the center of the box. The material used to render the box. -.. _class_CSGBox_width: +.. _class_CSGBox_property_width: - :ref:`float` **width** diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index 5337609a0..eeb5c8cbd 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -19,19 +19,19 @@ A CSG Cylinder shape. Properties ---------- -+---------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`cone` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`sides` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_faces` | -+---------------------------------+-----------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------+ +| :ref:`bool` | :ref:`cone` | ++---------------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------------+--------------------------------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------------+--------------------------------------------------------------+ +| :ref:`int` | :ref:`sides` | ++---------------------------------+--------------------------------------------------------------+ +| :ref:`bool` | :ref:`smooth_faces` | ++---------------------------------+--------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ This node allows you to create a cylinder (or cone) for use with the CSG system. Property Descriptions --------------------- -.. _class_CSGCylinder_cone: +.. _class_CSGCylinder_property_cone: - :ref:`bool` **cone** @@ -51,9 +51,9 @@ Property Descriptions | *Getter* | is_cone() | +----------+-----------------+ -If true a cone is created, the :ref:`radius` will only apply to one side. +If true a cone is created, the :ref:`radius` will only apply to one side. -.. _class_CSGCylinder_height: +.. _class_CSGCylinder_property_height: - :ref:`float` **height** @@ -65,7 +65,7 @@ If true a cone is created, the :ref:`radius` will only The height of the cylinder. -.. _class_CSGCylinder_material: +.. _class_CSGCylinder_property_material: - :ref:`Material` **material** @@ -77,7 +77,7 @@ The height of the cylinder. The material used to render the cylinder. -.. _class_CSGCylinder_radius: +.. _class_CSGCylinder_property_radius: - :ref:`float` **radius** @@ -89,7 +89,7 @@ The material used to render the cylinder. The radius of the cylinder. -.. _class_CSGCylinder_sides: +.. _class_CSGCylinder_property_sides: - :ref:`int` **sides** @@ -101,7 +101,7 @@ The radius of the cylinder. The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. -.. _class_CSGCylinder_smooth_faces: +.. _class_CSGCylinder_property_smooth_faces: - :ref:`bool` **smooth_faces** diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index 38063ff22..883da7fd7 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -19,9 +19,9 @@ A CSG Mesh shape that uses a mesh resource. Properties ---------- -+-------------------------+---------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+-------------------------+---------------------------------+ ++-------------------------+------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++-------------------------+------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ This CSG node allows you to use any mesh resource as a CSG shape, provided it is Property Descriptions --------------------- -.. _class_CSGMesh_mesh: +.. _class_CSGMesh_property_mesh: - :ref:`Mesh` **mesh** diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index 7f54529ed..54bc61eea 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -19,49 +19,61 @@ Extrudes a 2D polygon shape to create a 3D mesh. Properties ---------- -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`depth` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`path_continuous_u` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`path_interval` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`path_joined` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`path_local` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`path_node` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`PathRotation` | :ref:`path_rotation` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_faces` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`spin_degrees` | -+---------------------------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`spin_sides` | -+---------------------------------------------------+--------------------------------------------------------------+ ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`depth` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`path_continuous_u` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`path_interval` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`path_joined` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`path_local` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`path_node` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`PathRotation` | :ref:`path_rotation` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`smooth_faces` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`spin_degrees` | ++---------------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`int` | :ref:`spin_sides` | ++---------------------------------------------------+-----------------------------------------------------------------------+ Enumerations ------------ .. _enum_CSGPolygon_Mode: +.. _class_CSGPolygon_constant_MODE_DEPTH: + +.. _class_CSGPolygon_constant_MODE_SPIN: + +.. _class_CSGPolygon_constant_MODE_PATH: + enum **Mode**: -- **MODE_DEPTH** = **0** --- Shape is extruded to :ref:`depth`. +- **MODE_DEPTH** = **0** --- Shape is extruded to :ref:`depth`. - **MODE_SPIN** = **1** --- Shape is extruded by rotating it around an axis. -- **MODE_PATH** = **2** --- Shape is extruded along a path set by a :ref:`Shape` set in :ref:`path_node`. +- **MODE_PATH** = **2** --- Shape is extruded along a path set by a :ref:`Shape` set in :ref:`path_node`. .. _enum_CSGPolygon_PathRotation: +.. _class_CSGPolygon_constant_PATH_ROTATION_POLYGON: + +.. _class_CSGPolygon_constant_PATH_ROTATION_PATH: + +.. _class_CSGPolygon_constant_PATH_ROTATION_PATH_FOLLOW: + enum **PathRotation**: - **PATH_ROTATION_POLYGON** = **0** --- Slice is not rotated. @@ -78,7 +90,7 @@ This node takes a 2D polygon shape and extrudes it to create a 3D mesh. Property Descriptions --------------------- -.. _class_CSGPolygon_depth: +.. _class_CSGPolygon_property_depth: - :ref:`float` **depth** @@ -88,9 +100,9 @@ Property Descriptions | *Getter* | get_depth() | +----------+------------------+ -Extrusion depth when :ref:`mode` is constant MODE_DEPTH. +Extrusion depth when :ref:`mode` is :ref:`MODE_DEPTH`. -.. _class_CSGPolygon_material: +.. _class_CSGPolygon_property_material: - :ref:`Material` **material** @@ -102,7 +114,7 @@ Extrusion depth when :ref:`mode` is constant MODE_DEPTH. Material to use for the resulting mesh. -.. _class_CSGPolygon_mode: +.. _class_CSGPolygon_property_mode: - :ref:`Mode` **mode** @@ -114,7 +126,7 @@ Material to use for the resulting mesh. Extrusion mode. -.. _class_CSGPolygon_path_continuous_u: +.. _class_CSGPolygon_property_path_continuous_u: - :ref:`bool` **path_continuous_u** @@ -124,9 +136,9 @@ Extrusion mode. | *Getter* | is_path_continuous_u() | +----------+------------------------------+ -If true the u component of our uv will continuously increase in unison with the distance traveled along our path when :ref:`mode` is constant MODE_PATH. +If true the u component of our uv will continuously increase in unison with the distance traveled along our path when :ref:`mode` is :ref:`MODE_PATH`. -.. _class_CSGPolygon_path_interval: +.. _class_CSGPolygon_property_path_interval: - :ref:`float` **path_interval** @@ -136,9 +148,9 @@ If true the u component of our uv will continuously increase in unison with the | *Getter* | get_path_interval() | +----------+--------------------------+ -Interval at which a new extrusion slice is added along the path when :ref:`mode` is constant MODE_PATH. +Interval at which a new extrusion slice is added along the path when :ref:`mode` is :ref:`MODE_PATH`. -.. _class_CSGPolygon_path_joined: +.. _class_CSGPolygon_property_path_joined: - :ref:`bool` **path_joined** @@ -148,9 +160,9 @@ Interval at which a new extrusion slice is added along the path when :ref:`mode< | *Getter* | is_path_joined() | +----------+------------------------+ -If true the start and end of our path are joined together ensuring there is no seam when :ref:`mode` is constant MODE_PATH. +If true the start and end of our path are joined together ensuring there is no seam when :ref:`mode` is :ref:`MODE_PATH`. -.. _class_CSGPolygon_path_local: +.. _class_CSGPolygon_property_path_local: - :ref:`bool` **path_local** @@ -160,9 +172,9 @@ If true the start and end of our path are joined together ensuring there is no s | *Getter* | is_path_local() | +----------+-----------------------+ -If false we extrude centered on our path, if true we extrude in relation to the position of our CSGPolygon when :ref:`mode` is constant MODE_PATH. +If false we extrude centered on our path, if true we extrude in relation to the position of our CSGPolygon when :ref:`mode` is :ref:`MODE_PATH`. -.. _class_CSGPolygon_path_node: +.. _class_CSGPolygon_property_path_node: - :ref:`NodePath` **path_node** @@ -172,9 +184,9 @@ If false we extrude centered on our path, if true we extrude in relation to the | *Getter* | get_path_node() | +----------+----------------------+ -The :ref:`Shape` object containing the path along which we extrude when :ref:`mode` is constant MODE_PATH. +The :ref:`Shape` object containing the path along which we extrude when :ref:`mode` is :ref:`MODE_PATH`. -.. _class_CSGPolygon_path_rotation: +.. _class_CSGPolygon_property_path_rotation: - :ref:`PathRotation` **path_rotation** @@ -184,9 +196,9 @@ The :ref:`Shape` object containing the path along which we extrude | *Getter* | get_path_rotation() | +----------+--------------------------+ -The method by which each slice is rotated along the path when :ref:`mode` is constant MODE_PATH. +The method by which each slice is rotated along the path when :ref:`mode` is :ref:`MODE_PATH`. -.. _class_CSGPolygon_polygon: +.. _class_CSGPolygon_property_polygon: - :ref:`PoolVector2Array` **polygon** @@ -198,7 +210,7 @@ The method by which each slice is rotated along the path when :ref:`mode` **smooth_faces** @@ -210,7 +222,7 @@ Point array that defines the shape that we'll extrude. Generates smooth normals so smooth shading is applied to our mesh. -.. _class_CSGPolygon_spin_degrees: +.. _class_CSGPolygon_property_spin_degrees: - :ref:`float` **spin_degrees** @@ -220,9 +232,9 @@ Generates smooth normals so smooth shading is applied to our mesh. | *Getter* | get_spin_degrees() | +----------+-------------------------+ -Degrees to rotate our extrusion for each slice when :ref:`mode` is constant MODE_SPIN. +Degrees to rotate our extrusion for each slice when :ref:`mode` is :ref:`MODE_SPIN`. -.. _class_CSGPolygon_spin_sides: +.. _class_CSGPolygon_property_spin_sides: - :ref:`int` **spin_sides** @@ -232,5 +244,5 @@ Degrees to rotate our extrusion for each slice when :ref:`mode` is constant MODE_SPIN. +Number of extrusion when :ref:`mode` is :ref:`MODE_SPIN`. diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index b24271d22..ce8daa167 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -21,14 +21,14 @@ Base class for CSG primitives. Properties ---------- -+-------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`invert_faces` | -+-------------------------+------------------------------------------------------+ ++-------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`invert_faces` | ++-------------------------+---------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_CSGPrimitive_invert_faces: +.. _class_CSGPrimitive_property_invert_faces: - :ref:`bool` **invert_faces** diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index 998d42e92..b03b65a74 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -21,40 +21,46 @@ The CSG base class. Properties ---------- -+-------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`calculate_tangents` | -+-------------------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-------------------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-------------------------------------------+--------------------------------------------------------------+ -| :ref:`Operation` | :ref:`operation` | -+-------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`snap` | -+-------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_collision` | -+-------------------------------------------+--------------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`calculate_tangents` | ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`Operation` | :ref:`operation` | ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`snap` | ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_collision` | ++-------------------------------------------+-----------------------------------------------------------------------+ Methods ------- -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`is_root_shape` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`is_root_shape` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_CSGShape_Operation: +.. _class_CSGShape_constant_OPERATION_UNION: + +.. _class_CSGShape_constant_OPERATION_INTERSECTION: + +.. _class_CSGShape_constant_OPERATION_SUBTRACTION: + enum **Operation**: - **OPERATION_UNION** = **0** --- Geometry of both primitives is merged, intersecting geometry is removed. @@ -71,7 +77,7 @@ This is the CSG base class that provides CSG operation support to the various CS Property Descriptions --------------------- -.. _class_CSGShape_calculate_tangents: +.. _class_CSGShape_property_calculate_tangents: - :ref:`bool` **calculate_tangents** @@ -83,7 +89,7 @@ Property Descriptions Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. -.. _class_CSGShape_collision_layer: +.. _class_CSGShape_property_collision_layer: - :ref:`int` **collision_layer** @@ -99,7 +105,7 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. -.. _class_CSGShape_collision_mask: +.. _class_CSGShape_property_collision_mask: - :ref:`int` **collision_mask** @@ -111,7 +117,7 @@ A contact is detected if object A is in any of the layers that object B scans, o The physics layers this CSG shape scans for collisions. -.. _class_CSGShape_operation: +.. _class_CSGShape_property_operation: - :ref:`Operation` **operation** @@ -123,7 +129,7 @@ The physics layers this CSG shape scans for collisions. The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. -.. _class_CSGShape_snap: +.. _class_CSGShape_property_snap: - :ref:`float` **snap** @@ -133,7 +139,7 @@ The operation that is performed on this shape. This is ignored for the first CSG | *Getter* | get_snap() | +----------+-----------------+ -.. _class_CSGShape_use_collision: +.. _class_CSGShape_property_use_collision: - :ref:`bool` **use_collision** @@ -148,31 +154,31 @@ Adds a collision shape to the physics engine for our CSG shape. This will always Method Descriptions ------------------- -.. _class_CSGShape_get_collision_layer_bit: +.. _class_CSGShape_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. -.. _class_CSGShape_get_collision_mask_bit: +.. _class_CSGShape_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. -.. _class_CSGShape_is_root_shape: +.. _class_CSGShape_method_is_root_shape: - :ref:`bool` **is_root_shape** **(** **)** const Returns true if this is a root shape and is thus the object that is rendered. -.. _class_CSGShape_set_collision_layer_bit: +.. _class_CSGShape_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. -.. _class_CSGShape_set_collision_mask_bit: +.. _class_CSGShape_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index 0f0751d13..d3fb1f8ff 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -19,17 +19,17 @@ A CSG Sphere shape. Properties ---------- -+---------------------------------+---------------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+---------------------------------------------------------+ -| :ref:`int` | :ref:`radial_segments` | -+---------------------------------+---------------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------------+---------------------------------------------------------+ -| :ref:`int` | :ref:`rings` | -+---------------------------------+---------------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_faces` | -+---------------------------------+---------------------------------------------------------+ ++---------------------------------+------------------------------------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`radial_segments` | ++---------------------------------+------------------------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`rings` | ++---------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`smooth_faces` | ++---------------------------------+------------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ This node allows you to create a sphere for use with the CSG system. Property Descriptions --------------------- -.. _class_CSGSphere_material: +.. _class_CSGSphere_property_material: - :ref:`Material` **material** @@ -51,7 +51,7 @@ Property Descriptions The material used to render the sphere. -.. _class_CSGSphere_radial_segments: +.. _class_CSGSphere_property_radial_segments: - :ref:`int` **radial_segments** @@ -63,7 +63,7 @@ The material used to render the sphere. Number of vertical slices for the sphere. -.. _class_CSGSphere_radius: +.. _class_CSGSphere_property_radius: - :ref:`float` **radius** @@ -75,7 +75,7 @@ Number of vertical slices for the sphere. Radius of the sphere. -.. _class_CSGSphere_rings: +.. _class_CSGSphere_property_rings: - :ref:`int` **rings** @@ -87,7 +87,7 @@ Radius of the sphere. Number of horizontal slices for the sphere. -.. _class_CSGSphere_smooth_faces: +.. _class_CSGSphere_property_smooth_faces: - :ref:`bool` **smooth_faces** diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index dc9db8f27..4532255be 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -19,19 +19,19 @@ A CSG Torus shape. Properties ---------- -+---------------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`inner_radius` | -+---------------------------------+--------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`outer_radius` | -+---------------------------------+--------------------------------------------------+ -| :ref:`int` | :ref:`ring_sides` | -+---------------------------------+--------------------------------------------------+ -| :ref:`int` | :ref:`sides` | -+---------------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_faces` | -+---------------------------------+--------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`inner_radius` | ++---------------------------------+-----------------------------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`outer_radius` | ++---------------------------------+-----------------------------------------------------------+ +| :ref:`int` | :ref:`ring_sides` | ++---------------------------------+-----------------------------------------------------------+ +| :ref:`int` | :ref:`sides` | ++---------------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`smooth_faces` | ++---------------------------------+-----------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ This node allows you to create a torus for use with the CSG system. Property Descriptions --------------------- -.. _class_CSGTorus_inner_radius: +.. _class_CSGTorus_property_inner_radius: - :ref:`float` **inner_radius** @@ -53,7 +53,7 @@ Property Descriptions The inner radius of the torus. -.. _class_CSGTorus_material: +.. _class_CSGTorus_property_material: - :ref:`Material` **material** @@ -65,7 +65,7 @@ The inner radius of the torus. The material used to render the torus. -.. _class_CSGTorus_outer_radius: +.. _class_CSGTorus_property_outer_radius: - :ref:`float` **outer_radius** @@ -77,7 +77,7 @@ The material used to render the torus. The outer radius of the torus. -.. _class_CSGTorus_ring_sides: +.. _class_CSGTorus_property_ring_sides: - :ref:`int` **ring_sides** @@ -89,7 +89,7 @@ The outer radius of the torus. The number of edges each ring of the torus is constructed of. -.. _class_CSGTorus_sides: +.. _class_CSGTorus_property_sides: - :ref:`int` **sides** @@ -101,7 +101,7 @@ The number of edges each ring of the torus is constructed of. The number of slices the torus is constructed of. -.. _class_CSGTorus_smooth_faces: +.. _class_CSGTorus_property_smooth_faces: - :ref:`bool` **smooth_faces** diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 55411ef94..3605add23 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -19,14 +19,14 @@ Brief Description Methods ------- -+------------------------------+-------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+------------------------------+-------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++-----------------------------+--------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_CSharpScript_new: +.. _class_CSharpScript_method_new: - :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 2742c7978..17e2d8719 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -19,32 +19,38 @@ A CubeMap is a 6 sided 3D texture. Properties ---------- -+--------------------------------------+-------------------------------------------------------------------+ -| :ref:`int` | :ref:`flags` | -+--------------------------------------+-------------------------------------------------------------------+ -| :ref:`float` | :ref:`lossy_storage_quality` | -+--------------------------------------+-------------------------------------------------------------------+ -| :ref:`Storage` | :ref:`storage_mode` | -+--------------------------------------+-------------------------------------------------------------------+ ++--------------------------------------+----------------------------------------------------------------------------+ +| :ref:`int` | :ref:`flags` | ++--------------------------------------+----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lossy_storage_quality` | ++--------------------------------------+----------------------------------------------------------------------------+ +| :ref:`Storage` | :ref:`storage_mode` | ++--------------------------------------+----------------------------------------------------------------------------+ Methods ------- -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_side` **(** :ref:`Side` side **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_side` **(** :ref:`Side` side, :ref:`Image` image **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_side` **(** :ref:`Side` side **)** const | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_side` **(** :ref:`Side` side, :ref:`Image` image **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_CubeMap_Storage: +.. _class_CubeMap_constant_STORAGE_RAW: + +.. _class_CubeMap_constant_STORAGE_COMPRESS_LOSSY: + +.. _class_CubeMap_constant_STORAGE_COMPRESS_LOSSLESS: + enum **Storage**: - **STORAGE_RAW** = **0** --- Store the ``CubeMap`` without any compression. @@ -55,6 +61,18 @@ enum **Storage**: .. _enum_CubeMap_Side: +.. _class_CubeMap_constant_SIDE_LEFT: + +.. _class_CubeMap_constant_SIDE_RIGHT: + +.. _class_CubeMap_constant_SIDE_BOTTOM: + +.. _class_CubeMap_constant_SIDE_TOP: + +.. _class_CubeMap_constant_SIDE_FRONT: + +.. _class_CubeMap_constant_SIDE_BACK: + enum **Side**: - **SIDE_LEFT** = **0** --- Identifier for the left face of the ``CubeMap``. @@ -71,6 +89,14 @@ enum **Side**: .. _enum_CubeMap_Flags: +.. _class_CubeMap_constant_FLAG_MIPMAPS: + +.. _class_CubeMap_constant_FLAG_REPEAT: + +.. _class_CubeMap_constant_FLAG_FILTER: + +.. _class_CubeMap_constant_FLAGS_DEFAULT: + enum **Flags**: - **FLAG_MIPMAPS** = **1** --- Generate mipmaps, to enable smooth zooming out of the texture. @@ -89,7 +115,7 @@ A 6-sided 3D texture typically used for faking reflections. It can be used to ma Property Descriptions --------------------- -.. _class_CubeMap_flags: +.. _class_CubeMap_property_flags: - :ref:`int` **flags** @@ -101,7 +127,7 @@ Property Descriptions The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. -.. _class_CubeMap_lossy_storage_quality: +.. _class_CubeMap_property_lossy_storage_quality: - :ref:`float` **lossy_storage_quality** @@ -113,7 +139,7 @@ The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY. -.. _class_CubeMap_storage_mode: +.. _class_CubeMap_property_storage_mode: - :ref:`Storage` **storage_mode** @@ -128,25 +154,25 @@ The ``CubeMap``'s storage mode. See ``STORAGE_*`` constants. Method Descriptions ------------------- -.. _class_CubeMap_get_height: +.. _class_CubeMap_method_get_height: - :ref:`int` **get_height** **(** **)** const Returns the ``CubeMap``'s height. -.. _class_CubeMap_get_side: +.. _class_CubeMap_method_get_side: - :ref:`Image` **get_side** **(** :ref:`Side` side **)** const Returns an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. -.. _class_CubeMap_get_width: +.. _class_CubeMap_method_get_width: - :ref:`int` **get_width** **(** **)** const Returns the ``CubeMap``'s width. -.. _class_CubeMap_set_side: +.. _class_CubeMap_method_set_side: - void **set_side** **(** :ref:`Side` side, :ref:`Image` image **)** diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index 5665e1eaa..131a4930b 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -19,15 +19,15 @@ Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. Properties ---------- -+-------------------------------+----------------------------------------------------------+ -| :ref:`Vector3` | :ref:`size` | -+-------------------------------+----------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_depth` | -+-------------------------------+----------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_height` | -+-------------------------------+----------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_width` | -+-------------------------------+----------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`size` | ++-------------------------------+-------------------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_depth` | ++-------------------------------+-------------------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_height` | ++-------------------------------+-------------------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_width` | ++-------------------------------+-------------------------------------------------------------------+ Description ----------- @@ -37,7 +37,7 @@ Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. Property Descriptions --------------------- -.. _class_CubeMesh_size: +.. _class_CubeMesh_property_size: - :ref:`Vector3` **size** @@ -49,7 +49,7 @@ Property Descriptions Size of the cuboid mesh. Defaults to (2, 2, 2). -.. _class_CubeMesh_subdivide_depth: +.. _class_CubeMesh_property_subdivide_depth: - :ref:`int` **subdivide_depth** @@ -61,7 +61,7 @@ Size of the cuboid mesh. Defaults to (2, 2, 2). Number of extra edge loops inserted along the z-axis. Defaults to 0. -.. _class_CubeMesh_subdivide_height: +.. _class_CubeMesh_property_subdivide_height: - :ref:`int` **subdivide_height** @@ -73,7 +73,7 @@ Number of extra edge loops inserted along the z-axis. Defaults to 0. Number of extra edge loops inserted along the y-axis. Defaults to 0. -.. _class_CubeMesh_subdivide_width: +.. _class_CubeMesh_property_subdivide_width: - :ref:`int` **subdivide_width** diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 11a6231f3..11fd19a0f 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -19,71 +19,77 @@ A mathematic curve. Properties ---------- -+---------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`bake_resolution` | -+---------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`max_value` | -+---------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`min_value` | -+---------------------------+-----------------------------------------------------+ ++---------------------------+--------------------------------------------------------------+ +| :ref:`int` | :ref:`bake_resolution` | ++---------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`max_value` | ++---------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`min_value` | ++---------------------------+--------------------------------------------------------------+ Methods ------- -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`TangentMode` left_mode=0, :ref:`TangentMode` right_mode=0 **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clean_dupes` **(** **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TangentMode` | :ref:`get_point_left_mode` **(** :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:`TangentMode` | :ref:`get_point_right_mode` **(** :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_baked` **(** :ref:`float` offset **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` index **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`TangentMode` left_mode=0, :ref:`TangentMode` right_mode=0 **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clean_dupes` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TangentMode` | :ref:`get_point_left_mode` **(** :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:`TangentMode` | :ref:`get_point_right_mode` **(** :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_baked` **(** :ref:`float` offset **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` index **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Curve_range_changed: +.. _class_Curve_signal_range_changed: - **range_changed** **(** **)** -Emitted when :ref:`max_value` or :ref:`min_value` is changed. +Emitted when :ref:`max_value` or :ref:`min_value` is changed. Enumerations ------------ .. _enum_Curve_TangentMode: +.. _class_Curve_constant_TANGENT_FREE: + +.. _class_Curve_constant_TANGENT_LINEAR: + +.. _class_Curve_constant_TANGENT_MODE_COUNT: + enum **TangentMode**: - **TANGENT_FREE** = **0** --- The tangent on this side of the point is user-defined. @@ -100,7 +106,7 @@ A curve that can be saved and re-used for other objects. By default it ranges be Property Descriptions --------------------- -.. _class_Curve_bake_resolution: +.. _class_Curve_property_bake_resolution: - :ref:`int` **bake_resolution** @@ -112,7 +118,7 @@ Property Descriptions The number of points to include in the baked (i.e. cached) curve data. -.. _class_Curve_max_value: +.. _class_Curve_property_max_value: - :ref:`float` **max_value** @@ -124,7 +130,7 @@ The number of points to include in the baked (i.e. cached) curve data. The maximum value the curve can reach. Default value: ``1``. -.. _class_Curve_min_value: +.. _class_Curve_property_min_value: - :ref:`float` **min_value** @@ -139,115 +145,115 @@ The minimum value the curve can reach. Default value: ``0``. Method Descriptions ------------------- -.. _class_Curve_add_point: +.. _class_Curve_method_add_point: - :ref:`int` **add_point** **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`TangentMode` left_mode=0, :ref:`TangentMode` right_mode=0 **)** Adds a point to the curve. For each side, if the ``*_mode`` is ``TANGENT_LINEAR``, the ``*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``*_tangent`` angle if ``*_mode`` is set to ``TANGENT_FREE``. -.. _class_Curve_bake: +.. _class_Curve_method_bake: - void **bake** **(** **)** Recomputes the baked cache of points for the curve. -.. _class_Curve_clean_dupes: +.. _class_Curve_method_clean_dupes: - void **clean_dupes** **(** **)** Removes points that are closer than ``CMP_EPSILON`` (0.00001) units to their neighbor on the curve. -.. _class_Curve_clear_points: +.. _class_Curve_method_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. -.. _class_Curve_get_point_count: +.. _class_Curve_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. -.. _class_Curve_get_point_left_mode: +.. _class_Curve_method_get_point_left_mode: - :ref:`TangentMode` **get_point_left_mode** **(** :ref:`int` index **)** const Returns the left ``TangentMode`` for the point at ``index``. -.. _class_Curve_get_point_left_tangent: +.. _class_Curve_method_get_point_left_tangent: - :ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** const Returns the left tangent angle (in degrees) for the point at ``index``. -.. _class_Curve_get_point_position: +.. _class_Curve_method_get_point_position: - :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** const Returns the curve coordinates for the point at ``index``. -.. _class_Curve_get_point_right_mode: +.. _class_Curve_method_get_point_right_mode: - :ref:`TangentMode` **get_point_right_mode** **(** :ref:`int` index **)** const Returns the right ``TangentMode`` for the point at ``index``. -.. _class_Curve_get_point_right_tangent: +.. _class_Curve_method_get_point_right_tangent: - :ref:`float` **get_point_right_tangent** **(** :ref:`int` index **)** const Returns the right tangent angle (in degrees) for the point at ``index``. -.. _class_Curve_interpolate: +.. _class_Curve_method_interpolate: - :ref:`float` **interpolate** **(** :ref:`float` offset **)** const Returns the y value for the point that would exist at x-position ``offset`` along the curve. -.. _class_Curve_interpolate_baked: +.. _class_Curve_method_interpolate_baked: - :ref:`float` **interpolate_baked** **(** :ref:`float` offset **)** Returns the y value for the point that would exist at x-position ``offset`` along the curve using the baked cache. Bakes the curve's points if not already baked. -.. _class_Curve_remove_point: +.. _class_Curve_method_remove_point: - void **remove_point** **(** :ref:`int` index **)** Removes the point at ``index`` from the curve. -.. _class_Curve_set_point_left_mode: +.. _class_Curve_method_set_point_left_mode: - void **set_point_left_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** Sets the left ``TangentMode`` for the point at ``index`` to ``mode``. -.. _class_Curve_set_point_left_tangent: +.. _class_Curve_method_set_point_left_tangent: - void **set_point_left_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** Sets the left tangent angle for the point at ``index`` to ``tangent``. -.. _class_Curve_set_point_offset: +.. _class_Curve_method_set_point_offset: - :ref:`int` **set_point_offset** **(** :ref:`int` index, :ref:`float` offset **)** Sets the offset from ``0.5`` -.. _class_Curve_set_point_right_mode: +.. _class_Curve_method_set_point_right_mode: - void **set_point_right_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** Sets the right ``TangentMode`` for the point at ``index`` to ``mode``. -.. _class_Curve_set_point_right_tangent: +.. _class_Curve_method_set_point_right_tangent: - void **set_point_right_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** Sets the right tangent angle for the point at ``index`` to ``tangent``. -.. _class_Curve_set_point_value: +.. _class_Curve_method_set_point_value: - void **set_point_value** **(** :ref:`int` index, :ref:`float` y **)** diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 0765f10d3..e2075bda6 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -19,50 +19,50 @@ Describes a Bezier curve in 2D space. Properties ---------- -+---------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`bake_interval` | -+---------------------------+---------------------------------------------------+ ++---------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`bake_interval` | ++---------------------------+------------------------------------------------------------+ Methods ------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector2` to_point **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** 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_position` **(** :ref:`int` idx **)** 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:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector2` to_point **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** 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_position` **(** :ref:`int` idx **)** 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:`interpolatef` **(** :ref:`float` fofs **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -74,7 +74,7 @@ It keeps a cache of precalculated points along the curve, to speed further calcu Property Descriptions --------------------- -.. _class_Curve2D_bake_interval: +.. _class_Curve2D_property_bake_interval: - :ref:`float` **bake_interval** @@ -84,12 +84,12 @@ Property Descriptions | *Getter* | get_bake_interval() | +----------+--------------------------+ -The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. +The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. Method Descriptions ------------------- -.. _class_Curve2D_add_point: +.. _class_Curve2D_method_add_point: - void **add_point** **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** @@ -97,33 +97,33 @@ Adds a point to a curve, at ``position``, with control points ``in`` and ``out`` If ``at_position`` is given, the point is inserted before the point number ``at_position``, moving that point (and every point after) after the inserted point. If ``at_position`` is not given, or is an illegal value (``at_position <0`` or ``at_position >= [method get_point_count]``), the point will be appended at the end of the point list. -.. _class_Curve2D_clear_points: +.. _class_Curve2D_method_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. -.. _class_Curve2D_get_baked_length: +.. _class_Curve2D_method_get_baked_length: - :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. +Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. -.. _class_Curve2D_get_baked_points: +.. _class_Curve2D_method_get_baked_points: - :ref:`PoolVector2Array` **get_baked_points** **(** **)** const Returns the cache of points as a :ref:`PoolVector2Array`. -.. _class_Curve2D_get_closest_offset: +.. _class_Curve2D_method_get_closest_offset: - :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`. +Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`interpolate_baked`. ``to_point`` must be in this curve's local space. -.. _class_Curve2D_get_closest_point: +.. _class_Curve2D_method_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** const @@ -131,31 +131,31 @@ Returns the closest point (in curve's local space) to ``to_point``. ``to_point`` must be in this curve's local space. -.. _class_Curve2D_get_point_count: +.. _class_Curve2D_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. -.. _class_Curve2D_get_point_in: +.. _class_Curve2D_method_get_point_in: - :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)``. -.. _class_Curve2D_get_point_out: +.. _class_Curve2D_method_get_point_out: - :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)``. -.. _class_Curve2D_get_point_position: +.. _class_Curve2D_method_get_point_position: - :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)``. -.. _class_Curve2D_interpolate: +.. _class_Curve2D_method_interpolate: - :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const @@ -163,7 +163,7 @@ Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, wher If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t`` is ignored. If the curve has no points, the function sends an error to the console, and returns ``(0, 0)``. -.. _class_Curve2D_interpolate_baked: +.. _class_Curve2D_method_interpolate_baked: - :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const @@ -173,37 +173,37 @@ To do that, it finds the two cached points where the ``offset`` lies between, th Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). -.. _class_Curve2D_interpolatef: +.. _class_Curve2D_method_interpolatef: - :ref:`Vector2` **interpolatef** **(** :ref:`float` fofs **)** const -Returns the position at the vertex ``fofs``. It calls :ref:`interpolate` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. +Returns the position at the vertex ``fofs``. It calls :ref:`interpolate` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. -.. _class_Curve2D_remove_point: +.. _class_Curve2D_method_remove_point: - void **remove_point** **(** :ref:`int` idx **)** Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds. -.. _class_Curve2D_set_point_in: +.. _class_Curve2D_method_set_point_in: - void **set_point_in** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets 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. -.. _class_Curve2D_set_point_out: +.. _class_Curve2D_method_set_point_out: - void **set_point_out** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets 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. -.. _class_Curve2D_set_point_position: +.. _class_Curve2D_method_set_point_position: - void **set_point_position** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. -.. _class_Curve2D_tessellate: +.. _class_Curve2D_method_tessellate: - :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 0cf5614b2..e67339758 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -19,62 +19,62 @@ Describes a Bezier curve in 3D space. Properties ---------- -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`bake_interval` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`up_vector_enabled` | -+---------------------------+-----------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`bake_interval` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`up_vector_enabled` | ++---------------------------+--------------------------------------------------------------------+ Methods ------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_up_vectors` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector3` to_point **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** 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_position` **(** :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_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:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_baked_up_vectors` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector3` to_point **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** 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_position` **(** :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_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:`interpolatef` **(** :ref:`float` fofs **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -86,7 +86,7 @@ It keeps a cache of precalculated points along the curve, to speed further calcu Property Descriptions --------------------- -.. _class_Curve3D_bake_interval: +.. _class_Curve3D_property_bake_interval: - :ref:`float` **bake_interval** @@ -96,9 +96,9 @@ Property Descriptions | *Getter* | get_bake_interval() | +----------+--------------------------+ -The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. +The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. -.. _class_Curve3D_up_vector_enabled: +.. _class_Curve3D_property_up_vector_enabled: - :ref:`bool` **up_vector_enabled** @@ -113,7 +113,7 @@ If ``true``, the curve will bake up vectors used for orientation. See :ref:`Orie Method Descriptions ------------------- -.. _class_Curve3D_add_point: +.. _class_Curve3D_method_add_point: - void **add_point** **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** @@ -121,47 +121,47 @@ Adds a point to a curve, at ``position``, with control points ``in`` and ``out`` If ``at_position`` is given, the point is inserted before the point number ``at_position``, moving that point (and every point after) after the inserted point. If ``at_position`` is not given, or is an illegal value (``at_position <0`` or ``at_position >= [method get_point_count]``), the point will be appended at the end of the point list. -.. _class_Curve3D_clear_points: +.. _class_Curve3D_method_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. -.. _class_Curve3D_get_baked_length: +.. _class_Curve3D_method_get_baked_length: - :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. +Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval`), it should be approximate enough. -.. _class_Curve3D_get_baked_points: +.. _class_Curve3D_method_get_baked_points: - :ref:`PoolVector3Array` **get_baked_points** **(** **)** const Returns the cache of points as a :ref:`PoolVector3Array`. -.. _class_Curve3D_get_baked_tilts: +.. _class_Curve3D_method_get_baked_tilts: - :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const Returns the cache of tilts as a :ref:`PoolRealArray`. -.. _class_Curve3D_get_baked_up_vectors: +.. _class_Curve3D_method_get_baked_up_vectors: - :ref:`PoolVector3Array` **get_baked_up_vectors** **(** **)** const Returns the cache of up vectors as a :ref:`PoolVector3Array`. -If :ref:`up_vector_enabled` is ``false``, the cache will be empty. +If :ref:`up_vector_enabled` is ``false``, the cache will be empty. -.. _class_Curve3D_get_closest_offset: +.. _class_Curve3D_method_get_closest_offset: - :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`. +Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`interpolate_baked` or :ref:`interpolate_baked_up_vector`. ``to_point`` must be in this curve's local space. -.. _class_Curve3D_get_closest_point: +.. _class_Curve3D_method_get_closest_point: - :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** const @@ -169,37 +169,37 @@ Returns the closest point (in curve's local space) to ``to_point``. ``to_point`` must be in this curve's local space. -.. _class_Curve3D_get_point_count: +.. _class_Curve3D_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. -.. _class_Curve3D_get_point_in: +.. _class_Curve3D_method_get_point_in: - :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)``. -.. _class_Curve3D_get_point_out: +.. _class_Curve3D_method_get_point_out: - :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)``. -.. _class_Curve3D_get_point_position: +.. _class_Curve3D_method_get_point_position: - :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)``. -.. _class_Curve3D_get_point_tilt: +.. _class_Curve3D_method_get_point_tilt: - :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``. -.. _class_Curve3D_interpolate: +.. _class_Curve3D_method_interpolate: - :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const @@ -207,7 +207,7 @@ Returns the position between the vertex ``idx`` and the vertex ``idx + 1``, wher If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t`` is ignored. If the curve has no points, the function sends an error to the console, and returns ``(0, 0, 0)``. -.. _class_Curve3D_interpolate_baked: +.. _class_Curve3D_method_interpolate_baked: - :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const @@ -217,7 +217,7 @@ To do that, it finds the two cached points where the ``offset`` lies between, th Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). -.. _class_Curve3D_interpolate_baked_up_vector: +.. _class_Curve3D_method_interpolate_baked_up_vector: - :ref:`Vector3` **interpolate_baked_up_vector** **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const @@ -227,37 +227,37 @@ To do that, it finds the two cached up vectors where the ``offset`` lies between If the curve has no up vectors, the function sends an error to the console, and returns ``(0, 1, 0)``. -.. _class_Curve3D_interpolatef: +.. _class_Curve3D_method_interpolatef: - :ref:`Vector3` **interpolatef** **(** :ref:`float` fofs **)** const -Returns the position at the vertex ``fofs``. It calls :ref:`interpolate` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. +Returns the position at the vertex ``fofs``. It calls :ref:`interpolate` using the integer part of ``fofs`` as ``idx``, and its fractional part as ``t``. -.. _class_Curve3D_remove_point: +.. _class_Curve3D_method_remove_point: - void **remove_point** **(** :ref:`int` idx **)** Deletes the point ``idx`` from the curve. Sends an error to the console if ``idx`` is out of bounds. -.. _class_Curve3D_set_point_in: +.. _class_Curve3D_method_set_point_in: - void **set_point_in** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets 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. -.. _class_Curve3D_set_point_out: +.. _class_Curve3D_method_set_point_out: - void **set_point_out** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets 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. -.. _class_Curve3D_set_point_position: +.. _class_Curve3D_method_set_point_position: - void **set_point_position** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets the position for the vertex ``idx``. If the index is out of bounds, the function sends an error to the console. -.. _class_Curve3D_set_point_tilt: +.. _class_Curve3D_method_set_point_tilt: - void **set_point_tilt** **(** :ref:`int` idx, :ref:`float` tilt **)** @@ -265,7 +265,7 @@ Sets the tilt angle in radians for the point ``idx``. If the index is out of bou The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow` or :ref:`OrientedPathFollow`, this tilt is an offset over the natural tilt the :ref:`PathFollow` or :ref:`OrientedPathFollow` calculates. -.. _class_Curve3D_tessellate: +.. _class_Curve3D_method_tessellate: - :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 7a09e1259..532ae70f7 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -19,11 +19,11 @@ A texture that shows a curve. Properties ---------- -+---------------------------+----------------------------------------+ -| :ref:`Curve` | :ref:`curve` | -+---------------------------+----------------------------------------+ -| :ref:`int` | :ref:`width` | -+---------------------------+----------------------------------------+ ++---------------------------+-------------------------------------------------+ +| :ref:`Curve` | :ref:`curve` | ++---------------------------+-------------------------------------------------+ +| :ref:`int` | :ref:`width` | ++---------------------------+-------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Renders a given :ref:`Curve` provided to it. Simplifies the task of Property Descriptions --------------------- -.. _class_CurveTexture_curve: +.. _class_CurveTexture_property_curve: - :ref:`Curve` **curve** @@ -45,7 +45,7 @@ Property Descriptions The ``curve`` rendered onto the texture. -.. _class_CurveTexture_width: +.. _class_CurveTexture_property_width: - :ref:`int` **width** diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 579f7d300..921ac0d59 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -19,17 +19,17 @@ Class representing a cylindrical :ref:`PrimitiveMesh`. Properties ---------- -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`bottom_radius` | -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`radial_segments` | -+---------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`rings` | -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`top_radius` | -+---------------------------+------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`bottom_radius` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`int` | :ref:`radial_segments` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`int` | :ref:`rings` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`top_radius` | ++---------------------------+---------------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ Class representing a cylindrical :ref:`PrimitiveMesh`. Property Descriptions --------------------- -.. _class_CylinderMesh_bottom_radius: +.. _class_CylinderMesh_property_bottom_radius: - :ref:`float` **bottom_radius** @@ -51,7 +51,7 @@ Property Descriptions Bottom radius of the cylinder. Defaults to 1.0. -.. _class_CylinderMesh_height: +.. _class_CylinderMesh_property_height: - :ref:`float` **height** @@ -63,7 +63,7 @@ Bottom radius of the cylinder. Defaults to 1.0. Full height of the cylinder. Defaults to 2.0. -.. _class_CylinderMesh_radial_segments: +.. _class_CylinderMesh_property_radial_segments: - :ref:`int` **radial_segments** @@ -75,7 +75,7 @@ Full height of the cylinder. Defaults to 2.0. Number of radial segments on the cylinder. Defaults to 64. -.. _class_CylinderMesh_rings: +.. _class_CylinderMesh_property_rings: - :ref:`int` **rings** @@ -87,7 +87,7 @@ Number of radial segments on the cylinder. Defaults to 64. Number of edge rings along the height of the cylinder. Defaults to 4. -.. _class_CylinderMesh_top_radius: +.. _class_CylinderMesh_property_top_radius: - :ref:`float` **top_radius** diff --git a/classes/class_cylindershape.rst b/classes/class_cylindershape.rst index 8c73795a7..695b48a08 100644 --- a/classes/class_cylindershape.rst +++ b/classes/class_cylindershape.rst @@ -19,11 +19,11 @@ Cylinder shape for collisions. Properties ---------- -+---------------------------+-------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+-------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+-------------------------------------------+ ++---------------------------+----------------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------+----------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+----------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Cylinder shape for collisions. Property Descriptions --------------------- -.. _class_CylinderShape_height: +.. _class_CylinderShape_property_height: - :ref:`float` **height** @@ -45,7 +45,7 @@ Property Descriptions The cylinder's height. -.. _class_CylinderShape_radius: +.. _class_CylinderShape_property_radius: - :ref:`float` **radius** diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 8d04032e0..d248c97a5 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -19,15 +19,15 @@ Damped spring constraint for 2D physics. Properties ---------- -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`rest_length` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`stiffness` | -+---------------------------+-----------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`rest_length` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`stiffness` | ++---------------------------+--------------------------------------------------------------------+ Description ----------- @@ -37,7 +37,7 @@ Damped spring constraint for 2D physics. This resembles a spring joint that alwa Property Descriptions --------------------- -.. _class_DampedSpringJoint2D_damping: +.. _class_DampedSpringJoint2D_property_damping: - :ref:`float` **damping** @@ -49,7 +49,7 @@ Property Descriptions The spring joint's damping ratio. A value between ``0`` and ``1``. When the two bodies move into different directions the system tries to align them to the spring axis again. A high ``damping`` value forces the attached bodies to align faster. Default value: ``1`` -.. _class_DampedSpringJoint2D_length: +.. _class_DampedSpringJoint2D_property_length: - :ref:`float` **length** @@ -61,7 +61,7 @@ The spring joint's damping ratio. A value between ``0`` and ``1``. When the two The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: ``50`` -.. _class_DampedSpringJoint2D_rest_length: +.. _class_DampedSpringJoint2D_property_rest_length: - :ref:`float` **rest_length** @@ -73,7 +73,7 @@ The spring joint's maximum length. The two attached bodies cannot stretch it pas When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: ``0`` -.. _class_DampedSpringJoint2D_stiffness: +.. _class_DampedSpringJoint2D_property_stiffness: - :ref:`float` **stiffness** diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index c703bf0f1..f4c59db47 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -17,29 +17,29 @@ Dictionary type. Methods ------- -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`erase` **(** :ref:`Variant` key **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`Variant` key, :ref:`Variant` default=Null **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`Variant` key **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`keys` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`values` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`erase` **(** :ref:`Variant` key **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get` **(** :ref:`Variant` key, :ref:`Variant` default=Null **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`Variant` key **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`keys` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`values` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,67 +49,67 @@ Dictionary type. Associative container which contains values referenced by uniqu Method Descriptions ------------------- -.. _class_Dictionary_clear: +.. _class_Dictionary_method_clear: - void **clear** **(** **)** Clear the dictionary, removing all key/value pairs. -.. _class_Dictionary_duplicate: +.. _class_Dictionary_method_duplicate: - :ref:`Dictionary` **duplicate** **(** :ref:`bool` deep=False **)** Creates a copy of the dictionary, and returns it. -.. _class_Dictionary_empty: +.. _class_Dictionary_method_empty: - :ref:`bool` **empty** **(** **)** Return true if the dictionary is empty. -.. _class_Dictionary_erase: +.. _class_Dictionary_method_erase: - :ref:`bool` **erase** **(** :ref:`Variant` key **)** Erase a dictionary key/value pair by key. -.. _class_Dictionary_get: +.. _class_Dictionary_method_get: - :ref:`Variant` **get** **(** :ref:`Variant` key, :ref:`Variant` default=Null **)** Returns the current value for the specified key in the ``Dictionary``. If the key does not exist, the method returns the value of the optional default argument, or Null if it is omitted. -.. _class_Dictionary_has: +.. _class_Dictionary_method_has: - :ref:`bool` **has** **(** :ref:`Variant` key **)** Return true if the dictionary has a given key. -.. _class_Dictionary_has_all: +.. _class_Dictionary_method_has_all: - :ref:`bool` **has_all** **(** :ref:`Array` keys **)** Return true if the dictionary has all of the keys in the given array. -.. _class_Dictionary_hash: +.. _class_Dictionary_method_hash: - :ref:`int` **hash** **(** **)** Return a hashed integer value representing the dictionary contents. -.. _class_Dictionary_keys: +.. _class_Dictionary_method_keys: - :ref:`Array` **keys** **(** **)** Return the list of keys in the ``Dictionary``. -.. _class_Dictionary_size: +.. _class_Dictionary_method_size: - :ref:`int` **size** **(** **)** Return the size of the dictionary (in pairs). -.. _class_Dictionary_values: +.. _class_Dictionary_method_values: - :ref:`Array` **values** **(** **)** diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 1f6d0d472..e262e8df6 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -19,31 +19,37 @@ Directional light from a distance, as from the Sun. Properties ---------- -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_bias_split_scale` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`directional_shadow_blend_splits` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`ShadowDepthRange` | :ref:`directional_shadow_depth_range` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_max_distance` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`ShadowMode` | :ref:`directional_shadow_mode` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_normal_bias` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_split_1` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_split_2` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`directional_shadow_split_3` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`directional_shadow_bias_split_scale` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`directional_shadow_blend_splits` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`ShadowDepthRange` | :ref:`directional_shadow_depth_range` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`directional_shadow_max_distance` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`ShadowMode` | :ref:`directional_shadow_mode` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`directional_shadow_normal_bias` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`directional_shadow_split_1` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`directional_shadow_split_2` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`directional_shadow_split_3` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_DirectionalLight_ShadowMode: +.. _class_DirectionalLight_constant_SHADOW_ORTHOGONAL: + +.. _class_DirectionalLight_constant_SHADOW_PARALLEL_2_SPLITS: + +.. _class_DirectionalLight_constant_SHADOW_PARALLEL_4_SPLITS: + enum **ShadowMode**: - **SHADOW_ORTHOGONAL** = **0** --- Renders the entire scene's shadow map from an orthogonal point of view. May result in blockier shadows on close objects. @@ -54,6 +60,10 @@ enum **ShadowMode**: .. _enum_DirectionalLight_ShadowDepthRange: +.. _class_DirectionalLight_constant_SHADOW_DEPTH_RANGE_STABLE: + +.. _class_DirectionalLight_constant_SHADOW_DEPTH_RANGE_OPTIMIZED: + enum **ShadowDepthRange**: - **SHADOW_DEPTH_RANGE_STABLE** = **0** --- Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value. @@ -73,7 +83,7 @@ Tutorials Property Descriptions --------------------- -.. _class_DirectionalLight_directional_shadow_bias_split_scale: +.. _class_DirectionalLight_property_directional_shadow_bias_split_scale: - :ref:`float` **directional_shadow_bias_split_scale** @@ -85,7 +95,7 @@ Property Descriptions Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them. -.. _class_DirectionalLight_directional_shadow_blend_splits: +.. _class_DirectionalLight_property_directional_shadow_blend_splits: - :ref:`bool` **directional_shadow_blend_splits** @@ -97,7 +107,7 @@ Amount of extra bias for shadow splits that are far away. If self shadowing occu If ``true``, shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. -.. _class_DirectionalLight_directional_shadow_depth_range: +.. _class_DirectionalLight_property_directional_shadow_depth_range: - :ref:`ShadowDepthRange` **directional_shadow_depth_range** @@ -107,9 +117,9 @@ If ``true``, shadow detail is sacrificed in exchange for smoother transitions be | *Getter* | get_shadow_depth_range() | +----------+-------------------------------+ -Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. +Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. -.. _class_DirectionalLight_directional_shadow_max_distance: +.. _class_DirectionalLight_property_directional_shadow_max_distance: - :ref:`float` **directional_shadow_max_distance** @@ -121,7 +131,7 @@ Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRang The maximum distance for shadow splits. -.. _class_DirectionalLight_directional_shadow_mode: +.. _class_DirectionalLight_property_directional_shadow_mode: - :ref:`ShadowMode` **directional_shadow_mode** @@ -131,9 +141,9 @@ The maximum distance for shadow splits. | *Getter* | get_shadow_mode() | +----------+------------------------+ -The light's shadow rendering algorithm. See :ref:`ShadowMode`. +The light's shadow rendering algorithm. See :ref:`ShadowMode`. -.. _class_DirectionalLight_directional_shadow_normal_bias: +.. _class_DirectionalLight_property_directional_shadow_normal_bias: - :ref:`float` **directional_shadow_normal_bias** @@ -145,7 +155,7 @@ The light's shadow rendering algorithm. See :ref:`ShadowMode` **directional_shadow_split_1** @@ -155,9 +165,9 @@ Can be used to fix special cases of self shadowing when objects are perpendicula | *Getter* | get_param() | +----------+------------------+ -The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL\_\*_SPLITS. +The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used in directional_shadow_mode SHADOW_PARALLEL\_\*_SPLITS. -.. _class_DirectionalLight_directional_shadow_split_2: +.. _class_DirectionalLight_property_directional_shadow_split_2: - :ref:`float` **directional_shadow_split_2** @@ -167,9 +177,9 @@ The distance from camera to shadow split 1. Relative to :ref:`directional_shadow | *Getter* | get_param() | +----------+------------------+ -The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL\_\*_SPLITS. +The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used in directional_shadow_mode SHADOW_PARALLEL\_\*_SPLITS. -.. _class_DirectionalLight_directional_shadow_split_3: +.. _class_DirectionalLight_property_directional_shadow_split_3: - :ref:`float` **directional_shadow_split_3** @@ -179,5 +189,5 @@ The distance from shadow split 1 to split 2. Relative to :ref:`directional_shado | *Getter* | get_param() | +----------+------------------+ -The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL_4_SPLITS. +The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used in directional_shadow_mode SHADOW_PARALLEL_4_SPLITS. diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 807d3022f..c504ebe82 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -19,43 +19,43 @@ Type used to handle the filesystem. Methods ------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`change_dir` **(** :ref:`String` todir **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`current_is_dir` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_drive` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_drive` **(** :ref:`int` idx **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_drive_count` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_next` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_space_left` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`list_dir_begin` **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`list_dir_end` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`make_dir` **(** :ref:`String` path **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open` **(** :ref:`String` path **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`remove` **(** :ref:`String` path **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`change_dir` **(** :ref:`String` todir **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`current_is_dir` **(** **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_dir` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_current_drive` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_drive` **(** :ref:`int` idx **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_drive_count` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_next` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_space_left` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`list_dir_begin` **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`list_dir_end` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`make_dir` **(** :ref:`String` path **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open` **(** :ref:`String` path **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`remove` **(** :ref:`String` path **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -88,7 +88,7 @@ Tutorials Method Descriptions ------------------- -.. _class_Directory_change_dir: +.. _class_Directory_method_change_dir: - :ref:`Error` **change_dir** **(** :ref:`String` todir **)** @@ -96,7 +96,7 @@ Change the currently opened directory to the one passed as an argument. The argu The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). -.. _class_Directory_copy: +.. _class_Directory_method_copy: - :ref:`Error` **copy** **(** :ref:`String` from, :ref:`String` to **)** @@ -104,95 +104,95 @@ Copy the *from* file to the *to* destination. Both arguments should be paths to Returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). -.. _class_Directory_current_is_dir: +.. _class_Directory_method_current_is_dir: - :ref:`bool` **current_is_dir** **(** **)** const -Return whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). +Return whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). -.. _class_Directory_dir_exists: +.. _class_Directory_method_dir_exists: - :ref:`bool` **dir_exists** **(** :ref:`String` path **)** Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. -.. _class_Directory_file_exists: +.. _class_Directory_method_file_exists: - :ref:`bool` **file_exists** **(** :ref:`String` path **)** Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. -.. _class_Directory_get_current_dir: +.. _class_Directory_method_get_current_dir: - :ref:`String` **get_current_dir** **(** **)** Return the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). -.. _class_Directory_get_current_drive: +.. _class_Directory_method_get_current_drive: - :ref:`int` **get_current_drive** **(** **)** -Returns the currently opened directory's drive index. See :ref:`get_drive` to convert returned index to the name of the drive. +Returns the currently opened directory's drive index. See :ref:`get_drive` to convert returned index to the name of the drive. -.. _class_Directory_get_drive: +.. _class_Directory_method_get_drive: - :ref:`String` **get_drive** **(** :ref:`int` idx **)** On Windows, return the name of the drive (partition) passed as an argument (e.g. ``C:``). On other platforms, or if the requested drive does not existed, the method returns an empty String. -.. _class_Directory_get_drive_count: +.. _class_Directory_method_get_drive_count: - :ref:`int` **get_drive_count** **(** **)** On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. -.. _class_Directory_get_next: +.. _class_Directory_method_get_next: - :ref:`String` **get_next** **(** **)** -Return the next element (file or directory) in the current directory (including ``.`` and ``..``, unless ``skip_navigational`` was given to :ref:`list_dir_begin`). +Return the next element (file or directory) in the current directory (including ``.`` and ``..``, unless ``skip_navigational`` was given to :ref:`list_dir_begin`). -The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. :ref:`list_dir_end` would not be mandatory in such a case). +The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. :ref:`list_dir_end` would not be mandatory in such a case). -.. _class_Directory_get_space_left: +.. _class_Directory_method_get_space_left: - :ref:`int` **get_space_left** **(** **)** On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1. -.. _class_Directory_list_dir_begin: +.. _class_Directory_method_list_dir_begin: - :ref:`Error` **list_dir_begin** **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** -Initialise the stream used to list all files and directories using the :ref:`get_next` function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end`. +Initialise the stream used to list all files and directories using the :ref:`get_next` function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end`. If you pass ``skip_navigational``, then ``.`` and ``..`` would be filtered out. If you pass ``skip_hidden``, then hidden files would be filtered out. -.. _class_Directory_list_dir_end: +.. _class_Directory_method_list_dir_end: - void **list_dir_end** **(** **)** -Close the current stream opened with :ref:`list_dir_begin` (whether it has been fully processed with :ref:`get_next` or not does not matter). +Close the current stream opened with :ref:`list_dir_begin` (whether it has been fully processed with :ref:`get_next` or not does not matter). -.. _class_Directory_make_dir: +.. _class_Directory_method_make_dir: - :ref:`Error` **make_dir** **(** :ref:`String` path **)** -Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive`). +Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive`). The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). -.. _class_Directory_make_dir_recursive: +.. _class_Directory_method_make_dir_recursive: - :ref:`Error` **make_dir_recursive** **(** :ref:`String` path **)** -Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir` recursively. The argument can be relative to the current directory, or an absolute path. +Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir` recursively. The argument can be relative to the current directory, or an absolute path. Return one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). -.. _class_Directory_open: +.. _class_Directory_method_open: - :ref:`Error` **open** **(** :ref:`String` path **)** @@ -200,7 +200,7 @@ Open an existing directory of the filesystem. The *path* argument can be within The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). -.. _class_Directory_remove: +.. _class_Directory_method_remove: - :ref:`Error` **remove** **(** :ref:`String` path **)** @@ -208,7 +208,7 @@ Delete the target file or an empty directory. The argument can be relative to th Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). -.. _class_Directory_rename: +.. _class_Directory_method_rename: - :ref:`Error` **rename** **(** :ref:`String` from, :ref:`String` to **)** diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index c7bff976b..a6efa92e1 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -19,48 +19,56 @@ DynamicFont renders vector font files at runtime. Properties ---------- -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`extra_spacing_bottom` | -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`extra_spacing_char` | -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`extra_spacing_space` | -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`extra_spacing_top` | -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`DynamicFontData` | :ref:`font_data` | -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`Color` | :ref:`outline_color` | -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`outline_size` | -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` | -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_filter` | -+-----------------------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_mipmaps` | -+-----------------------------------------------+---------------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`extra_spacing_bottom` | ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`extra_spacing_char` | ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`extra_spacing_space` | ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`extra_spacing_top` | ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`DynamicFontData` | :ref:`font_data` | ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`outline_color` | ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`outline_size` | ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` | ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_filter` | ++-----------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_mipmaps` | ++-----------------------------------------------+------------------------------------------------------------------------------+ Methods ------- -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_fallback` **(** :ref:`DynamicFontData` data **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`DynamicFontData` | :ref:`get_fallback` **(** :ref:`int` idx **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fallback_count` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_fallback` **(** :ref:`int` idx **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback` **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_fallback` **(** :ref:`DynamicFontData` data **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`DynamicFontData` | :ref:`get_fallback` **(** :ref:`int` idx **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fallback_count` **(** **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_fallback` **(** :ref:`int` idx **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fallback` **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_DynamicFont_SpacingType: +.. _class_DynamicFont_constant_SPACING_TOP: + +.. _class_DynamicFont_constant_SPACING_BOTTOM: + +.. _class_DynamicFont_constant_SPACING_CHAR: + +.. _class_DynamicFont_constant_SPACING_SPACE: + enum **SpacingType**: - **SPACING_TOP** = **0** --- Spacing at the top. @@ -79,7 +87,7 @@ DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtim Property Descriptions --------------------- -.. _class_DynamicFont_extra_spacing_bottom: +.. _class_DynamicFont_property_extra_spacing_bottom: - :ref:`int` **extra_spacing_bottom** @@ -91,7 +99,7 @@ Property Descriptions Extra spacing at the bottom in pixels. -.. _class_DynamicFont_extra_spacing_char: +.. _class_DynamicFont_property_extra_spacing_char: - :ref:`int` **extra_spacing_char** @@ -103,7 +111,7 @@ Extra spacing at the bottom in pixels. Extra character spacing in pixels. -.. _class_DynamicFont_extra_spacing_space: +.. _class_DynamicFont_property_extra_spacing_space: - :ref:`int` **extra_spacing_space** @@ -115,7 +123,7 @@ Extra character spacing in pixels. Extra space spacing in pixels. -.. _class_DynamicFont_extra_spacing_top: +.. _class_DynamicFont_property_extra_spacing_top: - :ref:`int` **extra_spacing_top** @@ -127,7 +135,7 @@ Extra space spacing in pixels. Extra spacing at the top in pixels. -.. _class_DynamicFont_font_data: +.. _class_DynamicFont_property_font_data: - :ref:`DynamicFontData` **font_data** @@ -139,7 +147,7 @@ Extra spacing at the top in pixels. The font data. -.. _class_DynamicFont_outline_color: +.. _class_DynamicFont_property_outline_color: - :ref:`Color` **outline_color** @@ -149,7 +157,7 @@ The font data. | *Getter* | get_outline_color() | +----------+--------------------------+ -.. _class_DynamicFont_outline_size: +.. _class_DynamicFont_property_outline_size: - :ref:`int` **outline_size** @@ -159,7 +167,7 @@ The font data. | *Getter* | get_outline_size() | +----------+-------------------------+ -.. _class_DynamicFont_size: +.. _class_DynamicFont_property_size: - :ref:`int` **size** @@ -171,7 +179,7 @@ The font data. The font size. -.. _class_DynamicFont_use_filter: +.. _class_DynamicFont_property_use_filter: - :ref:`bool` **use_filter** @@ -183,7 +191,7 @@ The font size. If ``true``, filtering is used. -.. _class_DynamicFont_use_mipmaps: +.. _class_DynamicFont_property_use_mipmaps: - :ref:`bool` **use_mipmaps** @@ -198,31 +206,31 @@ If ``true``, mipmapping is used. Method Descriptions ------------------- -.. _class_DynamicFont_add_fallback: +.. _class_DynamicFont_method_add_fallback: - void **add_fallback** **(** :ref:`DynamicFontData` data **)** Adds a fallback font. -.. _class_DynamicFont_get_fallback: +.. _class_DynamicFont_method_get_fallback: - :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** const Returns the fallback font at index ``idx``. -.. _class_DynamicFont_get_fallback_count: +.. _class_DynamicFont_method_get_fallback_count: - :ref:`int` **get_fallback_count** **(** **)** const Returns the number of fallback fonts. -.. _class_DynamicFont_remove_fallback: +.. _class_DynamicFont_method_remove_fallback: - void **remove_fallback** **(** :ref:`int` idx **)** Removes the fallback font at index ``idx``. -.. _class_DynamicFont_set_fallback: +.. _class_DynamicFont_method_set_fallback: - void **set_fallback** **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index a2be7c199..ee970e169 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -19,19 +19,25 @@ Used with :ref:`DynamicFont` to describe the location of a fo Properties ---------- -+----------------------------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`antialiased` | -+----------------------------------------------+-------------------------------------------------------+ -| :ref:`String` | :ref:`font_path` | -+----------------------------------------------+-------------------------------------------------------+ -| :ref:`Hinting` | :ref:`hinting` | -+----------------------------------------------+-------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`antialiased` | ++----------------------------------------------+----------------------------------------------------------------+ +| :ref:`String` | :ref:`font_path` | ++----------------------------------------------+----------------------------------------------------------------+ +| :ref:`Hinting` | :ref:`hinting` | ++----------------------------------------------+----------------------------------------------------------------+ Enumerations ------------ .. _enum_DynamicFontData_Hinting: +.. _class_DynamicFontData_constant_HINTING_NONE: + +.. _class_DynamicFontData_constant_HINTING_LIGHT: + +.. _class_DynamicFontData_constant_HINTING_NORMAL: + enum **Hinting**: - **HINTING_NONE** = **0** --- Disable font hinting (smoother but less crisp). @@ -48,7 +54,7 @@ Used with :ref:`DynamicFont` to describe the location of a ve Property Descriptions --------------------- -.. _class_DynamicFontData_antialiased: +.. _class_DynamicFontData_property_antialiased: - :ref:`bool` **antialiased** @@ -60,7 +66,7 @@ Property Descriptions Controls whether the font should be rendered with anti-aliasing. -.. _class_DynamicFontData_font_path: +.. _class_DynamicFontData_property_font_path: - :ref:`String` **font_path** @@ -72,7 +78,7 @@ Controls whether the font should be rendered with anti-aliasing. The path to the vector font file. -.. _class_DynamicFontData_hinting: +.. _class_DynamicFontData_property_hinting: - :ref:`Hinting` **hinting** diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 9c760bbd2..46dad96e6 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -19,68 +19,68 @@ Brief Description Methods ------- -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skip` **(** **)** | -+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skip` **(** **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_EditorExportPlugin__export_begin: +.. _class_EditorExportPlugin_method__export_begin: - void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual -.. _class_EditorExportPlugin__export_file: +.. _class_EditorExportPlugin_method__export_file: - void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual -.. _class_EditorExportPlugin_add_file: +.. _class_EditorExportPlugin_method_add_file: - void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** -.. _class_EditorExportPlugin_add_ios_bundle_file: +.. _class_EditorExportPlugin_method_add_ios_bundle_file: - void **add_ios_bundle_file** **(** :ref:`String` path **)** -.. _class_EditorExportPlugin_add_ios_cpp_code: +.. _class_EditorExportPlugin_method_add_ios_cpp_code: - void **add_ios_cpp_code** **(** :ref:`String` code **)** -.. _class_EditorExportPlugin_add_ios_framework: +.. _class_EditorExportPlugin_method_add_ios_framework: - void **add_ios_framework** **(** :ref:`String` path **)** -.. _class_EditorExportPlugin_add_ios_linker_flags: +.. _class_EditorExportPlugin_method_add_ios_linker_flags: - void **add_ios_linker_flags** **(** :ref:`String` flags **)** -.. _class_EditorExportPlugin_add_ios_plist_content: +.. _class_EditorExportPlugin_method_add_ios_plist_content: - void **add_ios_plist_content** **(** :ref:`String` plist_content **)** -.. _class_EditorExportPlugin_add_shared_object: +.. _class_EditorExportPlugin_method_add_shared_object: - void **add_shared_object** **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** -.. _class_EditorExportPlugin_skip: +.. _class_EditorExportPlugin_method_skip: - void **skip** **(** **)** diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index f3220eed0..2f8604f73 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -19,53 +19,53 @@ Brief Description Properties ---------- -+-------------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Access` | :ref:`access` | -+-------------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_dir` | -+-------------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_file` | -+-------------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_path` | -+-------------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disable_overwrite_warning` | -+-------------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`DisplayMode` | :ref:`display_mode` | -+-------------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+-------------------------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_hidden_files` | -+-------------------------------------------------------+------------------------------------------------------------------------------------+ ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Access` | :ref:`access` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`current_dir` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`current_file` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`current_path` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disable_overwrite_warning` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`DisplayMode` | :ref:`display_mode` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`show_hidden_files` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------+ Methods ------- -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`add_filter` **(** :ref:`String` filter **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_filters` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`invalidate` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+ ++-------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_filter` **(** :ref:`String` filter **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_filters` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invalidate` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_EditorFileDialog_dir_selected: +.. _class_EditorFileDialog_signal_dir_selected: - **dir_selected** **(** :ref:`String` dir **)** Emitted when a directory is selected. -.. _class_EditorFileDialog_file_selected: +.. _class_EditorFileDialog_signal_file_selected: - **file_selected** **(** :ref:`String` path **)** Emitted when a file is selected. -.. _class_EditorFileDialog_files_selected: +.. _class_EditorFileDialog_signal_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** @@ -76,6 +76,16 @@ Enumerations .. _enum_EditorFileDialog_Mode: +.. _class_EditorFileDialog_constant_MODE_OPEN_FILE: + +.. _class_EditorFileDialog_constant_MODE_OPEN_FILES: + +.. _class_EditorFileDialog_constant_MODE_OPEN_DIR: + +.. _class_EditorFileDialog_constant_MODE_OPEN_ANY: + +.. _class_EditorFileDialog_constant_MODE_SAVE_FILE: + enum **Mode**: - **MODE_OPEN_FILE** = **0** --- The ``EditorFileDialog`` can select only one file. Accepting the window will open the file. @@ -90,6 +100,12 @@ enum **Mode**: .. _enum_EditorFileDialog_Access: +.. _class_EditorFileDialog_constant_ACCESS_RESOURCES: + +.. _class_EditorFileDialog_constant_ACCESS_USERDATA: + +.. _class_EditorFileDialog_constant_ACCESS_FILESYSTEM: + enum **Access**: - **ACCESS_RESOURCES** = **0** --- The ``EditorFileDialog`` can only view ``res://`` directory contents. @@ -100,6 +116,10 @@ enum **Access**: .. _enum_EditorFileDialog_DisplayMode: +.. _class_EditorFileDialog_constant_DISPLAY_THUMBNAILS: + +.. _class_EditorFileDialog_constant_DISPLAY_LIST: + enum **DisplayMode**: - **DISPLAY_THUMBNAILS** = **0** --- The ``EditorFileDialog`` displays resources as thumbnails. @@ -109,7 +129,7 @@ enum **DisplayMode**: Property Descriptions --------------------- -.. _class_EditorFileDialog_access: +.. _class_EditorFileDialog_property_access: - :ref:`Access` **access** @@ -121,7 +141,7 @@ Property Descriptions The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. -.. _class_EditorFileDialog_current_dir: +.. _class_EditorFileDialog_property_current_dir: - :ref:`String` **current_dir** @@ -133,7 +153,7 @@ The location from which the user may select a file, including ``res://``, ``user The currently occupied directory. -.. _class_EditorFileDialog_current_file: +.. _class_EditorFileDialog_property_current_file: - :ref:`String` **current_file** @@ -145,7 +165,7 @@ The currently occupied directory. The currently selected file. -.. _class_EditorFileDialog_current_path: +.. _class_EditorFileDialog_property_current_path: - :ref:`String` **current_path** @@ -157,7 +177,7 @@ The currently selected file. The file system path in the address bar. -.. _class_EditorFileDialog_disable_overwrite_warning: +.. _class_EditorFileDialog_property_disable_overwrite_warning: - :ref:`bool` **disable_overwrite_warning** @@ -169,7 +189,7 @@ The file system path in the address bar. If ``true``, the ``EditorFileDialog`` will not warn the user before overwriting files. -.. _class_EditorFileDialog_display_mode: +.. _class_EditorFileDialog_property_display_mode: - :ref:`DisplayMode` **display_mode** @@ -181,7 +201,7 @@ If ``true``, the ``EditorFileDialog`` will not warn the user before overwriting The view format in which the ``EditorFileDialog`` displays resources to the user. -.. _class_EditorFileDialog_mode: +.. _class_EditorFileDialog_property_mode: - :ref:`Mode` **mode** @@ -193,7 +213,7 @@ The view format in which the ``EditorFileDialog`` displays resources to the user The purpose of the ``EditorFileDialog``. Changes allowed behaviors. -.. _class_EditorFileDialog_show_hidden_files: +.. _class_EditorFileDialog_property_show_hidden_files: - :ref:`bool` **show_hidden_files** @@ -208,7 +228,7 @@ If ``true``, hidden files and directories will be visible in the ``EditorFileDia Method Descriptions ------------------- -.. _class_EditorFileDialog_add_filter: +.. _class_EditorFileDialog_method_add_filter: - void **add_filter** **(** :ref:`String` filter **)** @@ -216,19 +236,19 @@ Adds a comma-delimited file extension filter option to the ``EditorFileDialog`` Example: "\*.tscn, \*.scn; Scenes", results in filter text "Scenes (\*.tscn, \*.scn)". -.. _class_EditorFileDialog_clear_filters: +.. _class_EditorFileDialog_method_clear_filters: - void **clear_filters** **(** **)** Removes all filters except for "All Files (\*)". -.. _class_EditorFileDialog_get_vbox: +.. _class_EditorFileDialog_method_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** Returns the ``VBoxContainer`` used to display the file system. -.. _class_EditorFileDialog_invalidate: +.. _class_EditorFileDialog_method_invalidate: - void **invalidate** **(** **)** diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index a2cdc62b9..92f912a00 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -19,46 +19,46 @@ Resource filesystem, as the editor sees it. Methods ------- -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :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:`bool` | :ref:`is_scanning` **(** **)** const | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scan` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scan_sources` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_file` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_script_classes` **(** **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`is_scanning` **(** **)** const | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scan` **(** **)** | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scan_sources` **(** **)** | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_file` **(** :ref:`String` path **)** | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_script_classes` **(** **)** | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_EditorFileSystem_filesystem_changed: +.. _class_EditorFileSystem_signal_filesystem_changed: - **filesystem_changed** **(** **)** Emitted if the filesystem changed. -.. _class_EditorFileSystem_resources_reimported: +.. _class_EditorFileSystem_signal_resources_reimported: - **resources_reimported** **(** :ref:`PoolStringArray` resources **)** Remitted if a resource is reimported. -.. _class_EditorFileSystem_resources_reload: +.. _class_EditorFileSystem_signal_resources_reload: - **resources_reload** **(** :ref:`PoolStringArray` resources **)** -.. _class_EditorFileSystem_sources_changed: +.. _class_EditorFileSystem_signal_sources_changed: - **sources_changed** **(** :ref:`bool` exist **)** @@ -72,55 +72,55 @@ This object holds information of all resources in the filesystem, their types, e Method Descriptions ------------------- -.. _class_EditorFileSystem_get_file_type: +.. _class_EditorFileSystem_method_get_file_type: - :ref:`String` **get_file_type** **(** :ref:`String` path **)** const Get the type of the file, given the full path. -.. _class_EditorFileSystem_get_filesystem: +.. _class_EditorFileSystem_method_get_filesystem: - :ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** Get the root directory object. -.. _class_EditorFileSystem_get_filesystem_path: +.. _class_EditorFileSystem_method_get_filesystem_path: - :ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** Returns a view into the filesystem at ``path``. -.. _class_EditorFileSystem_get_scanning_progress: +.. _class_EditorFileSystem_method_get_scanning_progress: - :ref:`float` **get_scanning_progress** **(** **)** const Return the scan progress for 0 to 1 if the FS is being scanned. -.. _class_EditorFileSystem_is_scanning: +.. _class_EditorFileSystem_method_is_scanning: - :ref:`bool` **is_scanning** **(** **)** const Return true of the filesystem is being scanned. -.. _class_EditorFileSystem_scan: +.. _class_EditorFileSystem_method_scan: - void **scan** **(** **)** Scan the filesystem for changes. -.. _class_EditorFileSystem_scan_sources: +.. _class_EditorFileSystem_method_scan_sources: - void **scan_sources** **(** **)** Check if the source of any imported resource changed. -.. _class_EditorFileSystem_update_file: +.. _class_EditorFileSystem_method_update_file: - void **update_file** **(** :ref:`String` path **)** Update a file information. Call this if an external program (not Godot) modified the file. -.. _class_EditorFileSystem_update_script_classes: +.. _class_EditorFileSystem_method_update_script_classes: - void **update_script_classes** **(** **)** diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index b67e591a6..442ed5942 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -19,35 +19,35 @@ A directory for the resource filesystem. 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 | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -57,81 +57,81 @@ A more generalized, low-level variation of the directory concept. Method Descriptions ------------------- -.. _class_EditorFileSystemDirectory_find_dir_index: +.. _class_EditorFileSystemDirectory_method_find_dir_index: - :ref:`int` **find_dir_index** **(** :ref:`String` name **)** const Returns the index of the directory with name ``name`` or ``-1`` if not found. -.. _class_EditorFileSystemDirectory_find_file_index: +.. _class_EditorFileSystemDirectory_method_find_file_index: - :ref:`int` **find_file_index** **(** :ref:`String` name **)** const Returns the index of the file with name ``name`` or ``-1`` if not found. -.. _class_EditorFileSystemDirectory_get_file: +.. _class_EditorFileSystemDirectory_method_get_file: - :ref:`String` **get_file** **(** :ref:`int` idx **)** const Returns the name of the file at index ``idx``. -.. _class_EditorFileSystemDirectory_get_file_count: +.. _class_EditorFileSystemDirectory_method_get_file_count: - :ref:`int` **get_file_count** **(** **)** const Returns the number of files in this directory. -.. _class_EditorFileSystemDirectory_get_file_import_is_valid: +.. _class_EditorFileSystemDirectory_method_get_file_import_is_valid: - :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** const Returns ``true`` if the file at index ``idx`` imported properly. -.. _class_EditorFileSystemDirectory_get_file_path: +.. _class_EditorFileSystemDirectory_method_get_file_path: - :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const Returns the path to the file at index ``idx``. -.. _class_EditorFileSystemDirectory_get_file_script_class_extends: +.. _class_EditorFileSystemDirectory_method_get_file_script_class_extends: - :ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** const -.. _class_EditorFileSystemDirectory_get_file_script_class_name: +.. _class_EditorFileSystemDirectory_method_get_file_script_class_name: - :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** const -.. _class_EditorFileSystemDirectory_get_file_type: +.. _class_EditorFileSystemDirectory_method_get_file_type: - :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const Returns the file extension of the file at index ``idx``. -.. _class_EditorFileSystemDirectory_get_name: +.. _class_EditorFileSystemDirectory_method_get_name: - :ref:`String` **get_name** **(** **)** Returns the name of this directory. -.. _class_EditorFileSystemDirectory_get_parent: +.. _class_EditorFileSystemDirectory_method_get_parent: - :ref:`EditorFileSystemDirectory` **get_parent** **(** **)** Returns the parent directory for this directory or null if called on a directory at ``res://`` or ``user://``. -.. _class_EditorFileSystemDirectory_get_path: +.. _class_EditorFileSystemDirectory_method_get_path: - :ref:`String` **get_path** **(** **)** const Returns the path to this directory. -.. _class_EditorFileSystemDirectory_get_subdir: +.. _class_EditorFileSystemDirectory_method_get_subdir: - :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** Returns the subdirectory at index ``idx``. -.. _class_EditorFileSystemDirectory_get_subdir_count: +.. _class_EditorFileSystemDirectory_method_get_subdir_count: - :ref:`int` **get_subdir_count** **(** **)** const diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 4669603b5..892381b9f 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -19,38 +19,38 @@ Registers a custom resource importer in the editor. Use the class to parse any f 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 | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your :ref:`EditorPlugin` with :ref:`EditorPlugin.add_import_plugin`. +EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your :ref:`EditorPlugin` with :ref:`EditorPlugin.add_import_plugin`. -EditorImportPlugins work by associating with specific file extensions and a resource type. See :ref:`get_recognized_extensions` and :ref:`get_resource_type`). They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the ``.import`` directory. +EditorImportPlugins work by associating with specific file extensions and a resource type. See :ref:`get_recognized_extensions` and :ref:`get_resource_type`). They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the ``.import`` directory. Below is an example EditorImportPlugin that imports a :ref:`Mesh` from a file with the extension ".special" or ".spec": @@ -103,71 +103,71 @@ Tutorials Method Descriptions ------------------- -.. _class_EditorImportPlugin_get_import_options: +.. _class_EditorImportPlugin_method_get_import_options: - :ref:`Array` **get_import_options** **(** :ref:`int` preset **)** virtual Get 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). -.. _class_EditorImportPlugin_get_import_order: +.. _class_EditorImportPlugin_method_get_import_order: - :ref:`int` **get_import_order** **(** **)** virtual Get 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. -.. _class_EditorImportPlugin_get_importer_name: +.. _class_EditorImportPlugin_method_get_importer_name: - :ref:`String` **get_importer_name** **(** **)** virtual Get the unique name of the importer. -.. _class_EditorImportPlugin_get_option_visibility: +.. _class_EditorImportPlugin_method_get_option_visibility: - :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual -.. _class_EditorImportPlugin_get_preset_count: +.. _class_EditorImportPlugin_method_get_preset_count: - :ref:`int` **get_preset_count** **(** **)** virtual -Get 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. +Get 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. -.. _class_EditorImportPlugin_get_preset_name: +.. _class_EditorImportPlugin_method_get_preset_name: - :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual Get the name of the options preset at this index. -.. _class_EditorImportPlugin_get_priority: +.. _class_EditorImportPlugin_method_get_priority: - :ref:`float` **get_priority** **(** **)** virtual Get the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. -.. _class_EditorImportPlugin_get_recognized_extensions: +.. _class_EditorImportPlugin_method_get_recognized_extensions: - :ref:`Array` **get_recognized_extensions** **(** **)** virtual Get the list of file extensions to associate with this loader (case insensitive). e.g. ``["obj"]``. -.. _class_EditorImportPlugin_get_resource_type: +.. _class_EditorImportPlugin_method_get_resource_type: - :ref:`String` **get_resource_type** **(** **)** virtual Get the Godot resource type associated with this loader. e.g. ``"Mesh"`` or ``"Animation"``. -.. _class_EditorImportPlugin_get_save_extension: +.. _class_EditorImportPlugin_method_get_save_extension: - :ref:`String` **get_save_extension** **(** **)** virtual Get the extension used to save this resource in the ``.import`` directory. -.. _class_EditorImportPlugin_get_visible_name: +.. _class_EditorImportPlugin_method_get_visible_name: - :ref:`String` **get_visible_name** **(** **)** virtual Get the name to display in the import window. -.. _class_EditorImportPlugin_import: +.. _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 diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 8e834435a..ffeda626c 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -19,45 +19,45 @@ Brief Description Methods ------- -+-------+-----------------------------------------------------------+ -| void | :ref:`refresh` **(** **)** | -+-------+-----------------------------------------------------------+ ++------+------------------------------------------------------------------+ +| void | :ref:`refresh` **(** **)** | ++------+------------------------------------------------------------------+ Signals ------- -.. _class_EditorInspector_object_id_selected: +.. _class_EditorInspector_signal_object_id_selected: - **object_id_selected** **(** :ref:`int` id **)** -.. _class_EditorInspector_property_edited: +.. _class_EditorInspector_signal_property_edited: - **property_edited** **(** :ref:`String` property **)** -.. _class_EditorInspector_property_keyed: +.. _class_EditorInspector_signal_property_keyed: - **property_keyed** **(** :ref:`String` property **)** -.. _class_EditorInspector_property_selected: +.. _class_EditorInspector_signal_property_selected: - **property_selected** **(** :ref:`String` property **)** -.. _class_EditorInspector_property_toggled: +.. _class_EditorInspector_signal_property_toggled: - **property_toggled** **(** :ref:`String` property, :ref:`bool` checked **)** -.. _class_EditorInspector_resource_selected: +.. _class_EditorInspector_signal_resource_selected: - **resource_selected** **(** :ref:`Object` res, :ref:`String` prop **)** -.. _class_EditorInspector_restart_requested: +.. _class_EditorInspector_signal_restart_requested: - **restart_requested** **(** **)** Method Descriptions ------------------- -.. _class_EditorInspector_refresh: +.. _class_EditorInspector_method_refresh: - void **refresh** **(** **)** diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index 82d5daad8..c7c967603 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -19,56 +19,56 @@ Brief Description 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 ------------------- -.. _class_EditorInspectorPlugin_add_custom_control: +.. _class_EditorInspectorPlugin_method_add_custom_control: - void **add_custom_control** **(** :ref:`Control` control **)** -.. _class_EditorInspectorPlugin_add_property_editor: +.. _class_EditorInspectorPlugin_method_add_property_editor: - void **add_property_editor** **(** :ref:`String` property, :ref:`Control` editor **)** -.. _class_EditorInspectorPlugin_add_property_editor_for_multiple_properties: +.. _class_EditorInspectorPlugin_method_add_property_editor_for_multiple_properties: - void **add_property_editor_for_multiple_properties** **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** -.. _class_EditorInspectorPlugin_can_handle: +.. _class_EditorInspectorPlugin_method_can_handle: - :ref:`bool` **can_handle** **(** :ref:`Object` object **)** virtual -.. _class_EditorInspectorPlugin_parse_begin: +.. _class_EditorInspectorPlugin_method_parse_begin: - void **parse_begin** **(** :ref:`Object` object **)** virtual -.. _class_EditorInspectorPlugin_parse_category: +.. _class_EditorInspectorPlugin_method_parse_category: - void **parse_category** **(** :ref:`Object` object, :ref:`String` category **)** virtual -.. _class_EditorInspectorPlugin_parse_end: +.. _class_EditorInspectorPlugin_method_parse_end: - void **parse_end** **(** **)** virtual -.. _class_EditorInspectorPlugin_parse_property: +.. _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 diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index aaf712332..e235c9f06 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -19,47 +19,47 @@ Godot editor's interface. Methods ------- -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_base_control` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_plugin_enabled` **(** :ref:`String` plugin **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` meshes, :ref:`int` preview_size **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_scene` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=true **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_file` **(** :ref:`String` file **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_plugin_enabled` **(** :ref:`String` plugin, :ref:`bool` enabled **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_base_control` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_plugin_enabled` **(** :ref:`String` plugin **)** const | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` meshes, :ref:`int` preview_size **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_scene` **(** **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=true **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_file` **(** :ref:`String` file **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_plugin_enabled` **(** :ref:`String` plugin, :ref:`bool` enabled **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -69,117 +69,117 @@ EditorInterface gives you control over Godot editor's window. It allows customiz Method Descriptions ------------------- -.. _class_EditorInterface_edit_resource: +.. _class_EditorInterface_method_edit_resource: - void **edit_resource** **(** :ref:`Resource` resource **)** Edits the given :ref:`Resource`. -.. _class_EditorInterface_get_base_control: +.. _class_EditorInterface_method_get_base_control: - :ref:`Control` **get_base_control** **(** **)** Returns the main container of Godot editor's window. You can use it, for example, to retrieve the size of the container and place your controls accordingly. -.. _class_EditorInterface_get_edited_scene_root: +.. _class_EditorInterface_method_get_edited_scene_root: - :ref:`Node` **get_edited_scene_root** **(** **)** Returns the edited (current) scene's root :ref:`Node`. -.. _class_EditorInterface_get_editor_settings: +.. _class_EditorInterface_method_get_editor_settings: - :ref:`EditorSettings` **get_editor_settings** **(** **)** Returns the :ref:`EditorSettings`. -.. _class_EditorInterface_get_editor_viewport: +.. _class_EditorInterface_method_get_editor_viewport: - :ref:`Control` **get_editor_viewport** **(** **)** Returns the editor :ref:`Viewport`. -.. _class_EditorInterface_get_open_scenes: +.. _class_EditorInterface_method_get_open_scenes: - :ref:`Array` **get_open_scenes** **(** **)** const Returns an :ref:`Array` with the file paths of the currently opened scenes. -.. _class_EditorInterface_get_resource_filesystem: +.. _class_EditorInterface_method_get_resource_filesystem: - :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** Returns the :ref:`EditorFileSystem`. -.. _class_EditorInterface_get_resource_previewer: +.. _class_EditorInterface_method_get_resource_previewer: - :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** Returns the :ref:`EditorResourcePreview`. -.. _class_EditorInterface_get_script_editor: +.. _class_EditorInterface_method_get_script_editor: - :ref:`ScriptEditor` **get_script_editor** **(** **)** Returns the :ref:`ScriptEditor`. -.. _class_EditorInterface_get_selected_path: +.. _class_EditorInterface_method_get_selected_path: - :ref:`String` **get_selected_path** **(** **)** const -.. _class_EditorInterface_get_selection: +.. _class_EditorInterface_method_get_selection: - :ref:`EditorSelection` **get_selection** **(** **)** Returns the :ref:`EditorSelection`. -.. _class_EditorInterface_inspect_object: +.. _class_EditorInterface_method_inspect_object: - void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property="" **)** Shows the given property on the given ``object`` in the Editor's Inspector dock. -.. _class_EditorInterface_is_plugin_enabled: +.. _class_EditorInterface_method_is_plugin_enabled: - :ref:`bool` **is_plugin_enabled** **(** :ref:`String` plugin **)** const Returns the enabled status of a plugin. The plugin name is the same as its directory name. -.. _class_EditorInterface_make_mesh_previews: +.. _class_EditorInterface_method_make_mesh_previews: - :ref:`Array` **make_mesh_previews** **(** :ref:`Array` meshes, :ref:`int` preview_size **)** Returns mesh previews rendered at the given size as an :ref:`Array` of :ref:`Texture`\ s. -.. _class_EditorInterface_open_scene_from_path: +.. _class_EditorInterface_method_open_scene_from_path: - void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** Opens the scene at the given path. -.. _class_EditorInterface_reload_scene_from_path: +.. _class_EditorInterface_method_reload_scene_from_path: - void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** Reloads the scene at the given path. -.. _class_EditorInterface_save_scene: +.. _class_EditorInterface_method_save_scene: - :ref:`Error` **save_scene** **(** **)** Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@GlobalScope` constants. -.. _class_EditorInterface_save_scene_as: +.. _class_EditorInterface_method_save_scene_as: - void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=true **)** Saves the scene as a file at ``path``. -.. _class_EditorInterface_select_file: +.. _class_EditorInterface_method_select_file: - void **select_file** **(** :ref:`String` file **)** -.. _class_EditorInterface_set_plugin_enabled: +.. _class_EditorInterface_method_set_plugin_enabled: - void **set_plugin_enabled** **(** :ref:`String` plugin, :ref:`bool` enabled **)** diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index b0634b6a9..a6b30837e 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -19,134 +19,134 @@ Used by the editor to extend its functionality. Methods ------- -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_autoload_singleton` **(** :ref:`String` name, :ref:`String` path **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_dock` **(** :ref:`DockSlot` slot, :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_spatial_gizmo_plugin` **(** :ref:`EditorSpatialGizmoPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tool_menu_item` **(** :ref:`String` name, :ref:`Object` handler, :ref:`String` callback, :ref:`Variant` ud=null **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_changes` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`build` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disable_plugin` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`enable_plugin` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`forward_canvas_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_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_plugin_icon` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ScriptCreateDialog` | :ref:`get_script_create_dialog` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** 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:`queue_save_layout` **(** **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_autoload_singleton` **(** :ref:`String` name **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_spatial_gizmo_plugin` **(** :ref:`EditorSpatialGizmoPlugin` plugin **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tool_menu_item` **(** :ref:`String` name **)** | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`update_overlays` **(** **)** const | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_autoload_singleton` **(** :ref:`String` name, :ref:`String` path **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_control_to_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_control_to_dock` **(** :ref:`DockSlot` slot, :ref:`Control` control **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_spatial_gizmo_plugin` **(** :ref:`EditorSpatialGizmoPlugin` plugin **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tool_menu_item` **(** :ref:`String` name, :ref:`Object` handler, :ref:`String` callback, :ref:`Variant` ud=null **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_changes` **(** **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`build` **(** **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disable_plugin` **(** **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`enable_plugin` **(** **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`forward_canvas_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_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_plugin_icon` **(** **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ScriptCreateDialog` | :ref:`get_script_create_dialog` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** 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:`queue_save_layout` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_autoload_singleton` **(** :ref:`String` name **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_spatial_gizmo_plugin` **(** :ref:`EditorSpatialGizmoPlugin` plugin **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tool_menu_item` **(** :ref:`String` name **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`update_overlays` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_EditorPlugin_main_screen_changed: +.. _class_EditorPlugin_signal_main_screen_changed: - **main_screen_changed** **(** :ref:`String` screen_name **)** Emitted when user changes the workspace (2D, 3D, Script, AssetLib). Also works with custom screens defined by plugins. -.. _class_EditorPlugin_resource_saved: +.. _class_EditorPlugin_signal_resource_saved: - **resource_saved** **(** :ref:`Resource` resource **)** -.. _class_EditorPlugin_scene_changed: +.. _class_EditorPlugin_signal_scene_changed: - **scene_changed** **(** :ref:`Node` scene_root **)** Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be null. -.. _class_EditorPlugin_scene_closed: +.. _class_EditorPlugin_signal_scene_closed: - **scene_closed** **(** :ref:`String` filepath **)** @@ -157,6 +157,26 @@ Enumerations .. _enum_EditorPlugin_CustomControlContainer: +.. _class_EditorPlugin_constant_CONTAINER_TOOLBAR: + +.. _class_EditorPlugin_constant_CONTAINER_SPATIAL_EDITOR_MENU: + +.. _class_EditorPlugin_constant_CONTAINER_SPATIAL_EDITOR_SIDE_LEFT: + +.. _class_EditorPlugin_constant_CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT: + +.. _class_EditorPlugin_constant_CONTAINER_SPATIAL_EDITOR_BOTTOM: + +.. _class_EditorPlugin_constant_CONTAINER_CANVAS_EDITOR_MENU: + +.. _class_EditorPlugin_constant_CONTAINER_CANVAS_EDITOR_SIDE_LEFT: + +.. _class_EditorPlugin_constant_CONTAINER_CANVAS_EDITOR_SIDE_RIGHT: + +.. _class_EditorPlugin_constant_CONTAINER_CANVAS_EDITOR_BOTTOM: + +.. _class_EditorPlugin_constant_CONTAINER_PROPERTY_EDITOR_BOTTOM: + enum **CustomControlContainer**: - **CONTAINER_TOOLBAR** = **0** @@ -181,6 +201,24 @@ enum **CustomControlContainer**: .. _enum_EditorPlugin_DockSlot: +.. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_UL: + +.. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_BL: + +.. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_UR: + +.. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_BR: + +.. _class_EditorPlugin_constant_DOCK_SLOT_RIGHT_UL: + +.. _class_EditorPlugin_constant_DOCK_SLOT_RIGHT_BL: + +.. _class_EditorPlugin_constant_DOCK_SLOT_RIGHT_UR: + +.. _class_EditorPlugin_constant_DOCK_SLOT_RIGHT_BR: + +.. _class_EditorPlugin_constant_DOCK_SLOT_MAX: + enum **DockSlot**: - **DOCK_SLOT_LEFT_UL** = **0** @@ -214,19 +252,19 @@ Tutorials Method Descriptions ------------------- -.. _class_EditorPlugin_add_autoload_singleton: +.. _class_EditorPlugin_method_add_autoload_singleton: - void **add_autoload_singleton** **(** :ref:`String` name, :ref:`String` path **)** Add a script at ``path`` to the Autoload list as ``name``. -.. _class_EditorPlugin_add_control_to_bottom_panel: +.. _class_EditorPlugin_method_add_control_to_bottom_panel: - :ref:`ToolButton` **add_control_to_bottom_panel** **(** :ref:`Control` control, :ref:`String` title **)** -Add a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_bottom_panel` and free it with ``queue_free()``. +Add a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_bottom_panel` and free it with ``queue_free()``. -.. _class_EditorPlugin_add_control_to_container: +.. _class_EditorPlugin_method_add_control_to_container: - void **add_control_to_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** @@ -234,9 +272,9 @@ Add a custom control to a container (see CONTAINER\_\* enum). There are many loc Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). -When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_container` and free it with ``queue_free()``. +When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_container` and free it with ``queue_free()``. -.. _class_EditorPlugin_add_control_to_dock: +.. _class_EditorPlugin_method_add_control_to_dock: - void **add_control_to_dock** **(** :ref:`DockSlot` slot, :ref:`Control` control **)** @@ -244,9 +282,9 @@ Add the control to a specific dock slot (see DOCK\_\* enum for options). If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. -When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_docks` and free it with ``queue_free()``. +When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_docks` and free it with ``queue_free()``. -.. _class_EditorPlugin_add_custom_type: +.. _class_EditorPlugin_method_add_custom_type: - void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** @@ -254,43 +292,43 @@ Add a custom type, which will appear in the list of nodes or resources. An icon When given node or resource is selected, the base type will be instanced (ie, "Spatial", "Control", "Resource"), then the script will be loaded and set to this object. -You can use the virtual method :ref:`handles` to check if your custom object is being edited by checking the script or using 'is' keyword. +You can use the virtual method :ref:`handles` to check if your custom object is being edited by checking the script or using 'is' keyword. During run-time, this will be a simple object with a script so this function does not need to be called then. -.. _class_EditorPlugin_add_export_plugin: +.. _class_EditorPlugin_method_add_export_plugin: - void **add_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** -.. _class_EditorPlugin_add_import_plugin: +.. _class_EditorPlugin_method_add_import_plugin: - void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** -.. _class_EditorPlugin_add_inspector_plugin: +.. _class_EditorPlugin_method_add_inspector_plugin: - void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** -.. _class_EditorPlugin_add_scene_import_plugin: +.. _class_EditorPlugin_method_add_scene_import_plugin: - void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** -.. _class_EditorPlugin_add_spatial_gizmo_plugin: +.. _class_EditorPlugin_method_add_spatial_gizmo_plugin: - void **add_spatial_gizmo_plugin** **(** :ref:`EditorSpatialGizmoPlugin` plugin **)** -.. _class_EditorPlugin_add_tool_menu_item: +.. _class_EditorPlugin_method_add_tool_menu_item: - void **add_tool_menu_item** **(** :ref:`String` name, :ref:`Object` handler, :ref:`String` callback, :ref:`Variant` ud=null **)** Add a custom menu to 'Project > Tools' as ``name`` that calls ``callback`` on an instance of ``handler`` with a parameter ``ud`` when user activates it. -.. _class_EditorPlugin_add_tool_submenu_item: +.. _class_EditorPlugin_method_add_tool_submenu_item: - void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** -Like :ref:`add_tool_menu_item` but adds the ``submenu`` item inside the ``name`` menu. +Like :ref:`add_tool_menu_item` but adds the ``submenu`` item inside the ``name`` menu. -.. _class_EditorPlugin_apply_changes: +.. _class_EditorPlugin_method_apply_changes: - void **apply_changes** **(** **)** virtual @@ -298,35 +336,35 @@ This method is called when the editor is about to save the project, switch to an This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. -.. _class_EditorPlugin_build: +.. _class_EditorPlugin_method_build: - :ref:`bool` **build** **(** **)** virtual -.. _class_EditorPlugin_clear: +.. _class_EditorPlugin_method_clear: - 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. -.. _class_EditorPlugin_disable_plugin: +.. _class_EditorPlugin_method_disable_plugin: - void **disable_plugin** **(** **)** virtual -.. _class_EditorPlugin_edit: +.. _class_EditorPlugin_method_edit: - 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. -.. _class_EditorPlugin_enable_plugin: +.. _class_EditorPlugin_method_enable_plugin: - void **enable_plugin** **(** **)** virtual -.. _class_EditorPlugin_forward_canvas_draw_over_viewport: +.. _class_EditorPlugin_method_forward_canvas_draw_over_viewport: - void **forward_canvas_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual -This method is called when there is an input event in the 2D viewport, e.g. the user clicks with the mouse in the 2D space (canvas GUI). Keep in mind that for this method to be called you have to first declare the virtual method :ref:`handles` so the editor knows that you want to work with the workspace: +This method is called when there is an input event in the 2D viewport, e.g. the user clicks with the mouse in the 2D space (canvas GUI). Keep in mind that for this method to be called you have to first declare the virtual method :ref:`handles` so the editor knows that you want to work with the workspace: :: @@ -335,19 +373,19 @@ This method is called when there is an input event in the 2D viewport, e.g. the Also note that the edited scene must have a root node. -.. _class_EditorPlugin_forward_canvas_force_draw_over_viewport: +.. _class_EditorPlugin_method_forward_canvas_force_draw_over_viewport: - void **forward_canvas_force_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual -.. _class_EditorPlugin_forward_canvas_gui_input: +.. _class_EditorPlugin_method_forward_canvas_gui_input: - :ref:`bool` **forward_canvas_gui_input** **(** :ref:`InputEvent` event **)** virtual -.. _class_EditorPlugin_forward_spatial_gui_input: +.. _class_EditorPlugin_method_forward_spatial_gui_input: - :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual -This method is called when there is an input event in the 3D viewport, e.g. the user clicks with the mouse in the 3D space (spatial GUI). Keep in mind that for this method to be called you have to first declare the virtual method :ref:`handles` so the editor knows that you want to work with the workspace: +This method is called when there is an input event in the 3D viewport, e.g. the user clicks with the mouse in the 3D space (spatial GUI). Keep in mind that for this method to be called you have to first declare the virtual method :ref:`handles` so the editor knows that you want to work with the workspace: :: @@ -356,71 +394,71 @@ This method is called when there is an input event in the 3D viewport, e.g. the Also note that the edited scene must have a root node. -.. _class_EditorPlugin_get_breakpoints: +.. _class_EditorPlugin_method_get_breakpoints: - :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 -.. _class_EditorPlugin_get_editor_interface: +.. _class_EditorPlugin_method_get_editor_interface: - :ref:`EditorInterface` **get_editor_interface** **(** **)** Return the :ref:`EditorInterface` object that gives you control over Godot editor's window and its functionalities. -.. _class_EditorPlugin_get_plugin_icon: +.. _class_EditorPlugin_method_get_plugin_icon: - :ref:`Object` **get_plugin_icon** **(** **)** virtual -.. _class_EditorPlugin_get_plugin_name: +.. _class_EditorPlugin_method_get_plugin_name: - :ref:`String` **get_plugin_name** **(** **)** virtual -.. _class_EditorPlugin_get_script_create_dialog: +.. _class_EditorPlugin_method_get_script_create_dialog: - :ref:`ScriptCreateDialog` **get_script_create_dialog** **(** **)** Gets the Editor's dialogue used for making scripts. Note that users can configure it before use. -.. _class_EditorPlugin_get_state: +.. _class_EditorPlugin_method_get_state: - :ref:`Dictionary` **get_state** **(** **)** virtual Get 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). -.. _class_EditorPlugin_get_undo_redo: +.. _class_EditorPlugin_method_get_undo_redo: - :ref:`UndoRedo` **get_undo_redo** **(** **)** Get the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. -.. _class_EditorPlugin_get_window_layout: +.. _class_EditorPlugin_method_get_window_layout: - void **get_window_layout** **(** :ref:`ConfigFile` layout **)** virtual -Get 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). +Get 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). -.. _class_EditorPlugin_handles: +.. _class_EditorPlugin_method_handles: - :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:`EditorPlugin.edit` and :ref:`EditorPlugin.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. +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. -.. _class_EditorPlugin_has_main_screen: +.. _class_EditorPlugin_method_has_main_screen: - :ref:`bool` **has_main_screen** **(** **)** virtual Return true if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). -.. _class_EditorPlugin_hide_bottom_panel: +.. _class_EditorPlugin_method_hide_bottom_panel: - void **hide_bottom_panel** **(** **)** -.. _class_EditorPlugin_make_bottom_panel_item_visible: +.. _class_EditorPlugin_method_make_bottom_panel_item_visible: - void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** -.. _class_EditorPlugin_make_visible: +.. _class_EditorPlugin_method_make_visible: - void **make_visible** **(** :ref:`bool` visible **)** virtual @@ -428,97 +466,97 @@ This function will be called when the editor is requested to become visible. It Remember that you have to manage the visibility of all your editor controls manually. -.. _class_EditorPlugin_queue_save_layout: +.. _class_EditorPlugin_method_queue_save_layout: - void **queue_save_layout** **(** **)** const Queue save the project's editor layout. -.. _class_EditorPlugin_remove_autoload_singleton: +.. _class_EditorPlugin_method_remove_autoload_singleton: - void **remove_autoload_singleton** **(** :ref:`String` name **)** Remove an Autoload ``name`` from the list. -.. _class_EditorPlugin_remove_control_from_bottom_panel: +.. _class_EditorPlugin_method_remove_control_from_bottom_panel: - void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** Remove the control from the bottom panel. You have to manually ``queue_free()`` the control. -.. _class_EditorPlugin_remove_control_from_container: +.. _class_EditorPlugin_method_remove_control_from_container: - void **remove_control_from_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** Remove the control from the specified container. You have to manually ``queue_free()`` the control. -.. _class_EditorPlugin_remove_control_from_docks: +.. _class_EditorPlugin_method_remove_control_from_docks: - void **remove_control_from_docks** **(** :ref:`Control` control **)** Remove the control from the dock. You have to manually ``queue_free()`` the control. -.. _class_EditorPlugin_remove_custom_type: +.. _class_EditorPlugin_method_remove_custom_type: - void **remove_custom_type** **(** :ref:`String` type **)** -Remove a custom type added by :ref:`add_custom_type` +Remove a custom type added by :ref:`add_custom_type` -.. _class_EditorPlugin_remove_export_plugin: +.. _class_EditorPlugin_method_remove_export_plugin: - void **remove_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** -.. _class_EditorPlugin_remove_import_plugin: +.. _class_EditorPlugin_method_remove_import_plugin: - void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** -.. _class_EditorPlugin_remove_inspector_plugin: +.. _class_EditorPlugin_method_remove_inspector_plugin: - void **remove_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** -.. _class_EditorPlugin_remove_scene_import_plugin: +.. _class_EditorPlugin_method_remove_scene_import_plugin: - void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** -.. _class_EditorPlugin_remove_spatial_gizmo_plugin: +.. _class_EditorPlugin_method_remove_spatial_gizmo_plugin: - void **remove_spatial_gizmo_plugin** **(** :ref:`EditorSpatialGizmoPlugin` plugin **)** -.. _class_EditorPlugin_remove_tool_menu_item: +.. _class_EditorPlugin_method_remove_tool_menu_item: - void **remove_tool_menu_item** **(** :ref:`String` name **)** Removes a menu ``name`` from 'Project > Tools'. -.. _class_EditorPlugin_save_external_data: +.. _class_EditorPlugin_method_save_external_data: - 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. -.. _class_EditorPlugin_set_force_draw_over_forwarding_enabled: +.. _class_EditorPlugin_method_set_force_draw_over_forwarding_enabled: - void **set_force_draw_over_forwarding_enabled** **(** **)** -.. _class_EditorPlugin_set_input_event_forwarding_always_enabled: +.. _class_EditorPlugin_method_set_input_event_forwarding_always_enabled: - void **set_input_event_forwarding_always_enabled** **(** **)** -Use this method if you always want to receive inputs from 3D view screen inside :ref:`forward_spatial_gui_input`. It might be especially usable if your plugin will want to use raycast in the scene. +Use this method if you always want to receive inputs from 3D view screen inside :ref:`forward_spatial_gui_input`. It might be especially usable if your plugin will want to use raycast in the scene. -.. _class_EditorPlugin_set_state: +.. _class_EditorPlugin_method_set_state: - void **set_state** **(** :ref:`Dictionary` state **)** virtual -Restore the state saved by :ref:`EditorPlugin.get_state`. +Restore the state saved by :ref:`get_state`. -.. _class_EditorPlugin_set_window_layout: +.. _class_EditorPlugin_method_set_window_layout: - void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual -Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout`. +Restore the plugin GUI layout saved by :ref:`get_window_layout`. -.. _class_EditorPlugin_update_overlays: +.. _class_EditorPlugin_method_update_overlays: - :ref:`int` **update_overlays** **(** **)** const diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index 88d022fa3..655e99946 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -19,72 +19,72 @@ Brief Description Properties ---------- -+-----------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`checkable` | -+-----------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`checked` | -+-----------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`draw_red` | -+-----------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`keying` | -+-----------------------------+--------------------------------------------------+ -| :ref:`String` | :ref:`label` | -+-----------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`read_only` | -+-----------------------------+--------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`checkable` | ++-----------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`checked` | ++-----------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`draw_red` | ++-----------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`keying` | ++-----------------------------+-----------------------------------------------------------+ +| :ref:`String` | :ref:`label` | ++-----------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`read_only` | ++-----------------------------+-----------------------------------------------------------+ Methods ------- -+------------------------------+----------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_edited_object` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_edited_property` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip_text` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------+ -| void | :ref:`update_property` **(** **)** virtual | -+------------------------------+----------------------------------------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_edited_object` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_edited_property` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip_text` **(** **)** const | ++-----------------------------+-----------------------------------------------------------------------------------------+ +| void | :ref:`update_property` **(** **)** virtual | ++-----------------------------+-----------------------------------------------------------------------------------------+ Signals ------- -.. _class_EditorProperty_multiple_properties_changed: +.. _class_EditorProperty_signal_multiple_properties_changed: - **multiple_properties_changed** **(** :ref:`PoolStringArray` properties, :ref:`Array` value **)** -.. _class_EditorProperty_object_id_selected: +.. _class_EditorProperty_signal_object_id_selected: - **object_id_selected** **(** :ref:`String` property, :ref:`int` id **)** -.. _class_EditorProperty_property_changed: +.. _class_EditorProperty_signal_property_changed: - **property_changed** **(** :ref:`String` property, :ref:`Nil` value **)** -.. _class_EditorProperty_property_checked: +.. _class_EditorProperty_signal_property_checked: - **property_checked** **(** :ref:`String` property, :ref:`String` bool **)** -.. _class_EditorProperty_property_keyed: +.. _class_EditorProperty_signal_property_keyed: - **property_keyed** **(** :ref:`String` property **)** -.. _class_EditorProperty_property_keyed_with_value: +.. _class_EditorProperty_signal_property_keyed_with_value: - **property_keyed_with_value** **(** :ref:`String` property, :ref:`Nil` value **)** -.. _class_EditorProperty_resource_selected: +.. _class_EditorProperty_signal_resource_selected: - **resource_selected** **(** :ref:`String` path, :ref:`Resource` resource **)** -.. _class_EditorProperty_selected: +.. _class_EditorProperty_signal_selected: - **selected** **(** :ref:`String` path, :ref:`int` focusable_idx **)** Property Descriptions --------------------- -.. _class_EditorProperty_checkable: +.. _class_EditorProperty_property_checkable: - :ref:`bool` **checkable** @@ -94,7 +94,7 @@ Property Descriptions | *Getter* | is_checkable() | +----------+----------------------+ -.. _class_EditorProperty_checked: +.. _class_EditorProperty_property_checked: - :ref:`bool` **checked** @@ -104,7 +104,7 @@ Property Descriptions | *Getter* | is_checked() | +----------+--------------------+ -.. _class_EditorProperty_draw_red: +.. _class_EditorProperty_property_draw_red: - :ref:`bool` **draw_red** @@ -114,7 +114,7 @@ Property Descriptions | *Getter* | is_draw_red() | +----------+---------------------+ -.. _class_EditorProperty_keying: +.. _class_EditorProperty_property_keying: - :ref:`bool` **keying** @@ -124,7 +124,7 @@ Property Descriptions | *Getter* | is_keying() | +----------+-------------------+ -.. _class_EditorProperty_label: +.. _class_EditorProperty_property_label: - :ref:`String` **label** @@ -134,7 +134,7 @@ Property Descriptions | *Getter* | get_label() | +----------+------------------+ -.. _class_EditorProperty_read_only: +.. _class_EditorProperty_property_read_only: - :ref:`bool` **read_only** @@ -147,19 +147,19 @@ Property Descriptions Method Descriptions ------------------- -.. _class_EditorProperty_get_edited_object: +.. _class_EditorProperty_method_get_edited_object: - :ref:`Object` **get_edited_object** **(** **)** -.. _class_EditorProperty_get_edited_property: +.. _class_EditorProperty_method_get_edited_property: - :ref:`String` **get_edited_property** **(** **)** -.. _class_EditorProperty_get_tooltip_text: +.. _class_EditorProperty_method_get_tooltip_text: - :ref:`String` **get_tooltip_text** **(** **)** const -.. _class_EditorProperty_update_property: +.. _class_EditorProperty_method_update_property: - void **update_property** **(** **)** virtual diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index 1b84f8fcb..0bd10e763 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -19,20 +19,20 @@ Brief Description 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__convert: +.. _class_EditorResourceConversionPlugin_method__convert: - :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual -.. _class_EditorResourceConversionPlugin__converts_to: +.. _class_EditorResourceConversionPlugin_method__converts_to: - :ref:`String` **_converts_to** **(** **)** virtual diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 6743a652e..cbc4ff417 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -19,22 +19,22 @@ Helper to generate previews of resources or files. Methods ------- -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_EditorResourcePreview_preview_invalidated: +.. _class_EditorResourcePreview_signal_preview_invalidated: - **preview_invalidated** **(** :ref:`String` path **)** @@ -48,31 +48,31 @@ This object is used to generate previews for resources of files. Method Descriptions ------------------- -.. _class_EditorResourcePreview_add_preview_generator: +.. _class_EditorResourcePreview_method_add_preview_generator: - void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Create an own, custom preview generator. -.. _class_EditorResourcePreview_check_for_invalidation: +.. _class_EditorResourcePreview_method_check_for_invalidation: - void **check_for_invalidation** **(** :ref:`String` path **)** Check if the resource changed, if so it will be invalidated and the corresponding signal emitted. -.. _class_EditorResourcePreview_queue_edited_resource_preview: +.. _class_EditorResourcePreview_method_queue_edited_resource_preview: - void **queue_edited_resource_preview** **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. -.. _class_EditorResourcePreview_queue_resource_preview: +.. _class_EditorResourcePreview_method_queue_resource_preview: - void **queue_resource_preview** **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. -.. _class_EditorResourcePreview_remove_preview_generator: +.. _class_EditorResourcePreview_method_remove_preview_generator: - void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index efdfebc31..776b9e57e 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -19,13 +19,13 @@ Custom generator of previews. Methods ------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`handles` **(** :ref:`String` type **)** 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:`handles` **(** :ref:`String` type **)** virtual | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -35,7 +35,7 @@ Custom code to generate previews. Please check "file_dialog/thumbnail_size" in E Method Descriptions ------------------- -.. _class_EditorResourcePreviewGenerator_generate: +.. _class_EditorResourcePreviewGenerator_method_generate: - :ref:`Texture` **generate** **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual @@ -45,17 +45,17 @@ Returning an empty texture is an OK way to fail and let another generator take c Care must be taken because this function is always called from a thread (not the main thread). -.. _class_EditorResourcePreviewGenerator_generate_from_path: +.. _class_EditorResourcePreviewGenerator_method_generate_from_path: - :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`. +Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call :ref:`generate`. Returning an empty texture is an OK way to fail and let another generator take care. Care must be taken because this function is always called from a thread (not the main thread). -.. _class_EditorResourcePreviewGenerator_handles: +.. _class_EditorResourcePreviewGenerator_method_handles: - :ref:`bool` **handles** **(** :ref:`String` type **)** virtual diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneimporter.rst index fa6530ad1..89badfd26 100644 --- a/classes/class_editorsceneimporter.rst +++ b/classes/class_editorsceneimporter.rst @@ -19,23 +19,43 @@ Brief Description Methods ------- -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_extensions` **(** **)** 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:`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 **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`import_scene_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_extensions` **(** **)** 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:`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 **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`import_scene_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_EditorSceneImporter_constant_IMPORT_SCENE: + +.. _class_EditorSceneImporter_constant_IMPORT_ANIMATION: + +.. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_DETECT_LOOP: + +.. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_OPTIMIZE: + +.. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS: + +.. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_KEEP_VALUE_TRACKS: + +.. _class_EditorSceneImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS: + +.. _class_EditorSceneImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES: + +.. _class_EditorSceneImporter_constant_IMPORT_MATERIALS_IN_INSTANCES: + +.. _class_EditorSceneImporter_constant_IMPORT_USE_COMPRESSION: + - **IMPORT_SCENE** = **1** - **IMPORT_ANIMATION** = **2** @@ -59,27 +79,27 @@ Constants Method Descriptions ------------------- -.. _class_EditorSceneImporter__get_extensions: +.. _class_EditorSceneImporter_method__get_extensions: - :ref:`Array` **_get_extensions** **(** **)** virtual -.. _class_EditorSceneImporter__get_import_flags: +.. _class_EditorSceneImporter_method__get_import_flags: - :ref:`int` **_get_import_flags** **(** **)** virtual -.. _class_EditorSceneImporter__import_animation: +.. _class_EditorSceneImporter_method__import_animation: - :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual -.. _class_EditorSceneImporter__import_scene: +.. _class_EditorSceneImporter_method__import_scene: - :ref:`Node` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual -.. _class_EditorSceneImporter_import_animation_from_other_importer: +.. _class_EditorSceneImporter_method_import_animation_from_other_importer: - :ref:`Animation` **import_animation_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** -.. _class_EditorSceneImporter_import_scene_from_other_importer: +.. _class_EditorSceneImporter_method_import_scene_from_other_importer: - :ref:`Node` **import_scene_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index 70d033381..e4e6d7190 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -19,20 +19,20 @@ Post process scenes after import 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 | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------+ Description ----------- Imported scenes can be automatically modified right after import by setting their *Custom Script* Import property to a ``tool`` script that inherits from this class. -The :ref:`post_import` callback receives the imported scene's root node and returns the modified version of the scene. Usage example: +The :ref:`post_import` callback receives the imported scene's root node and returns the modified version of the scene. Usage example: :: @@ -61,19 +61,19 @@ Tutorials Method Descriptions ------------------- -.. _class_EditorScenePostImport_get_source_file: +.. _class_EditorScenePostImport_method_get_source_file: - :ref:`String` **get_source_file** **(** **)** const Returns the source file path which got imported (e.g. ``res://scene.dae``). -.. _class_EditorScenePostImport_get_source_folder: +.. _class_EditorScenePostImport_method_get_source_folder: - :ref:`String` **get_source_folder** **(** **)** const Returns the resource folder the imported scene file is located in. -.. _class_EditorScenePostImport_post_import: +.. _class_EditorScenePostImport_method_post_import: - :ref:`Object` **post_import** **(** :ref:`Object` scene **)** virtual diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index b193ee25c..06ae4d5ff 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -19,15 +19,15 @@ Base script that can be used to add extension functions to the editor. Methods ------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`_run` **(** **)** virtual | -+------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`add_root_node` **(** :ref:`Node` node **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_scene` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`_run` **(** **)** virtual | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_root_node` **(** :ref:`Node` node **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_scene` **(** **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,13 +49,13 @@ Note that the script is run in the Editor context, which means the output is vis Method Descriptions ------------------- -.. _class_EditorScript__run: +.. _class_EditorScript_method__run: - void **_run** **(** **)** virtual This method is executed by the Editor when ``File -> Run`` is used. -.. _class_EditorScript_add_root_node: +.. _class_EditorScript_method_add_root_node: - void **add_root_node** **(** :ref:`Node` node **)** @@ -63,13 +63,13 @@ Adds ``node`` as a child of the root node in the editor context. WARNING: The implementation of this method is currently disabled. -.. _class_EditorScript_get_editor_interface: +.. _class_EditorScript_method_get_editor_interface: - :ref:`EditorInterface` **get_editor_interface** **(** **)** Returns the :ref:`EditorInterface` singleton instance. -.. _class_EditorScript_get_scene: +.. _class_EditorScript_method_get_scene: - :ref:`Node` **get_scene** **(** **)** diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 614da794c..211d27b7f 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -19,22 +19,22 @@ Manages the SceneTree selection in the editor. Methods ------- -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`Node` node **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_selected_nodes` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_transformable_selected_nodes` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`Node` node **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`Node` node **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_selected_nodes` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_transformable_selected_nodes` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`Node` node **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_EditorSelection_selection_changed: +.. _class_EditorSelection_signal_selection_changed: - **selection_changed** **(** **)** @@ -48,31 +48,31 @@ This object manages the SceneTree selection in the editor. Method Descriptions ------------------- -.. _class_EditorSelection_add_node: +.. _class_EditorSelection_method_add_node: - void **add_node** **(** :ref:`Node` node **)** Add a node to the selection. -.. _class_EditorSelection_clear: +.. _class_EditorSelection_method_clear: - void **clear** **(** **)** Clear the selection. -.. _class_EditorSelection_get_selected_nodes: +.. _class_EditorSelection_method_get_selected_nodes: - :ref:`Array` **get_selected_nodes** **(** **)** Get the list of selected nodes. -.. _class_EditorSelection_get_transformable_selected_nodes: +.. _class_EditorSelection_method_get_transformable_selected_nodes: - :ref:`Array` **get_transformable_selected_nodes** **(** **)** Get the list of selected nodes, optimized for transform operations (ie, moving them, rotating, etc). This list avoids situations where a node is selected and also chid/grandchild. -.. _class_EditorSelection_remove_node: +.. _class_EditorSelection_method_remove_node: - void **remove_node** **(** :ref:`Node` node **)** diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index e65edc75b..1233209e2 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -19,44 +19,44 @@ Object that holds the project-independent editor settings. 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 ------- -.. _class_EditorSettings_settings_changed: +.. _class_EditorSettings_signal_settings_changed: - **settings_changed** **(** **)** @@ -76,7 +76,7 @@ Accessing the settings is done by using the regular :ref:`Object` Method Descriptions ------------------- -.. _class_EditorSettings_add_property_info: +.. _class_EditorSettings_method_add_property_info: - void **add_property_info** **(** :ref:`Dictionary` info **)** @@ -97,39 +97,39 @@ Example: editor_settings.add_property_info(property_info) -.. _class_EditorSettings_erase: +.. _class_EditorSettings_method_erase: - void **erase** **(** :ref:`String` property **)** Erase a given setting (pass full property path). -.. _class_EditorSettings_get_favorites: +.. _class_EditorSettings_method_get_favorites: - :ref:`PoolStringArray` **get_favorites** **(** **)** const Get the list of favorite files and directories for this project. -.. _class_EditorSettings_get_project_metadata: +.. _class_EditorSettings_method_get_project_metadata: - :ref:`Variant` **get_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const -.. _class_EditorSettings_get_project_settings_dir: +.. _class_EditorSettings_method_get_project_settings_dir: - :ref:`String` **get_project_settings_dir** **(** **)** const Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved. -.. _class_EditorSettings_get_recent_dirs: +.. _class_EditorSettings_method_get_recent_dirs: - :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const Get the list of recently visited folders in the file dialog for this project. -.. _class_EditorSettings_get_setting: +.. _class_EditorSettings_method_get_setting: - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const -.. _class_EditorSettings_get_settings_dir: +.. _class_EditorSettings_method_get_settings_dir: - :ref:`String` **get_settings_dir** **(** **)** const @@ -139,39 +139,39 @@ settings/tmp - used for temporary storage of files settings/templates - where export templates are located -.. _class_EditorSettings_has_setting: +.. _class_EditorSettings_method_has_setting: - :ref:`bool` **has_setting** **(** :ref:`String` name **)** const -.. _class_EditorSettings_property_can_revert: +.. _class_EditorSettings_method_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** -.. _class_EditorSettings_property_get_revert: +.. _class_EditorSettings_method_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** -.. _class_EditorSettings_set_favorites: +.. _class_EditorSettings_method_set_favorites: - void **set_favorites** **(** :ref:`PoolStringArray` dirs **)** Set the list of favorite files and directories for this project. -.. _class_EditorSettings_set_initial_value: +.. _class_EditorSettings_method_set_initial_value: - void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** -.. _class_EditorSettings_set_project_metadata: +.. _class_EditorSettings_method_set_project_metadata: - void **set_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** -.. _class_EditorSettings_set_recent_dirs: +.. _class_EditorSettings_method_set_recent_dirs: - void **set_recent_dirs** **(** :ref:`PoolStringArray` dirs **)** Set the list of recently visited folders in the file dialog for this project. -.. _class_EditorSettings_set_setting: +.. _class_EditorSettings_method_set_setting: - void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index 40fd4ece2..a247e349b 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -19,123 +19,123 @@ Custom gizmo for editing Spatial objects. Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redraw` **(** **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redraw` **(** **)** virtual | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by :ref:`EditorPlugin.create_spatial_gizmo`. +Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by :ref:`EditorPlugin.create_spatial_gizmo`. Method Descriptions ------------------- -.. _class_EditorSpatialGizmo_add_collision_segments: +.. _class_EditorSpatialGizmo_method_add_collision_segments: - void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** -.. _class_EditorSpatialGizmo_add_collision_triangles: +.. _class_EditorSpatialGizmo_method_add_collision_triangles: - void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles **)** -Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this function during :ref:`redraw`. +Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this function during :ref:`redraw`. -.. _class_EditorSpatialGizmo_add_handles: +.. _class_EditorSpatialGizmo_method_add_handles: - void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** Add a list of handles (points) which can be used to deform the object being edited. -There are virtual functions which will be called upon editing of these handles. Call this function during :ref:`redraw`. +There are virtual functions which will be called upon editing of these handles. Call this function during :ref:`redraw`. -.. _class_EditorSpatialGizmo_add_lines: +.. _class_EditorSpatialGizmo_method_add_lines: - void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** -Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during :ref:`redraw`. +Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during :ref:`redraw`. -.. _class_EditorSpatialGizmo_add_mesh: +.. _class_EditorSpatialGizmo_method_add_mesh: - void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** -.. _class_EditorSpatialGizmo_add_unscaled_billboard: +.. _class_EditorSpatialGizmo_method_add_unscaled_billboard: - void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** -Add an unscaled billboard for visualization. Call this function during :ref:`redraw`. +Add an unscaled billboard for visualization. Call this function during :ref:`redraw`. -.. _class_EditorSpatialGizmo_clear: +.. _class_EditorSpatialGizmo_method_clear: - void **clear** **(** **)** -.. _class_EditorSpatialGizmo_commit_handle: +.. _class_EditorSpatialGizmo_method_commit_handle: - 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`). +Commit a handle being edited (handles must have been previously added by :ref:`add_handles`). If the cancel parameter is true, an option to restore the edited value to the original is provided. -.. _class_EditorSpatialGizmo_get_handle_name: +.. _class_EditorSpatialGizmo_method_get_handle_name: - :ref:`String` **get_handle_name** **(** :ref:`int` index **)** virtual -Get the name of an edited handle (handles must have been previously added by :ref:`add_handles`). +Get the name of an edited handle (handles must have been previously added by :ref:`add_handles`). Handles can be named for reference to the user when editing. -.. _class_EditorSpatialGizmo_get_handle_value: +.. _class_EditorSpatialGizmo_method_get_handle_value: - :ref:`Variant` **get_handle_value** **(** :ref:`int` index **)** virtual -Get actual value of a handle. This value can be anything and used for eventually undoing the motion when calling :ref:`commit_handle` +Get actual value of a handle. This value can be anything and used for eventually undoing the motion when calling :ref:`commit_handle` -.. _class_EditorSpatialGizmo_redraw: +.. _class_EditorSpatialGizmo_method_redraw: - void **redraw** **(** **)** virtual -This function is called when the Spatial this gizmo refers to changes (the :ref:`Spatial.update_gizmo` is called). +This function is called when the Spatial this gizmo refers to changes (the :ref:`Spatial.update_gizmo` is called). -.. _class_EditorSpatialGizmo_set_handle: +.. _class_EditorSpatialGizmo_method_set_handle: - 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. +This function is used when the user drags a gizmo handle (previously added with :ref:`add_handles`) in screen coordinates. The :ref:`Camera` is also provided so screen coordinates can be converted to raycasts. -.. _class_EditorSpatialGizmo_set_hidden: +.. _class_EditorSpatialGizmo_method_set_hidden: - void **set_hidden** **(** :ref:`bool` hidden **)** -.. _class_EditorSpatialGizmo_set_spatial_node: +.. _class_EditorSpatialGizmo_method_set_spatial_node: - void **set_spatial_node** **(** :ref:`Node` node **)** diff --git a/classes/class_editorspatialgizmoplugin.rst b/classes/class_editorspatialgizmoplugin.rst index 55e90fd15..7fde85315 100644 --- a/classes/class_editorspatialgizmoplugin.rst +++ b/classes/class_editorspatialgizmoplugin.rst @@ -19,104 +19,104 @@ Brief Description Methods ------- -+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_material` **(** :ref:`String` name, :ref:`SpatialMaterial` material **)** | -+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 | -+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSpatialGizmo` | :ref:`create_gizmo` **(** :ref:`Spatial` spatial **)** virtual | -+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_handle_material` **(** :ref:`String` name, :ref:`bool` billboard=false **)** | -+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_icon_material` **(** :ref:`String` name, :ref:`Texture` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color( 1, 1, 1, 1 ) **)** | -+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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:`bool` | :ref:`has_gizmo` **(** :ref:`Spatial` spatial **)** virtual | -+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_gizmo_handle_highlighted` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual | -+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selectable_when_hidden` **(** **)** 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:`add_material` **(** :ref:`String` name, :ref:`SpatialMaterial` material **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSpatialGizmo` | :ref:`create_gizmo` **(** :ref:`Spatial` spatial **)** virtual | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_handle_material` **(** :ref:`String` name, :ref:`bool` billboard=false **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_icon_material` **(** :ref:`String` name, :ref:`Texture` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color( 1, 1, 1, 1 ) **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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:`bool` | :ref:`has_gizmo` **(** :ref:`Spatial` spatial **)** virtual | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_gizmo_handle_highlighted` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selectable_when_hidden` **(** **)** 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 | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_EditorSpatialGizmoPlugin_add_material: +.. _class_EditorSpatialGizmoPlugin_method_add_material: - void **add_material** **(** :ref:`String` name, :ref:`SpatialMaterial` material **)** -.. _class_EditorSpatialGizmoPlugin_can_be_hidden: +.. _class_EditorSpatialGizmoPlugin_method_can_be_hidden: - :ref:`bool` **can_be_hidden** **(** **)** virtual -.. _class_EditorSpatialGizmoPlugin_commit_handle: +.. _class_EditorSpatialGizmoPlugin_method_commit_handle: - void **commit_handle** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual -.. _class_EditorSpatialGizmoPlugin_create_gizmo: +.. _class_EditorSpatialGizmoPlugin_method_create_gizmo: - :ref:`EditorSpatialGizmo` **create_gizmo** **(** :ref:`Spatial` spatial **)** virtual -.. _class_EditorSpatialGizmoPlugin_create_handle_material: +.. _class_EditorSpatialGizmoPlugin_method_create_handle_material: - void **create_handle_material** **(** :ref:`String` name, :ref:`bool` billboard=false **)** -.. _class_EditorSpatialGizmoPlugin_create_icon_material: +.. _class_EditorSpatialGizmoPlugin_method_create_icon_material: - void **create_icon_material** **(** :ref:`String` name, :ref:`Texture` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color( 1, 1, 1, 1 ) **)** -.. _class_EditorSpatialGizmoPlugin_create_material: +.. _class_EditorSpatialGizmoPlugin_method_create_material: - void **create_material** **(** :ref:`String` name, :ref:`Color` color, :ref:`bool` billboard=false, :ref:`bool` on_top=false, :ref:`bool` use_vertex_color=false **)** -.. _class_EditorSpatialGizmoPlugin_get_handle_name: +.. _class_EditorSpatialGizmoPlugin_method_get_handle_name: - :ref:`String` **get_handle_name** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual -.. _class_EditorSpatialGizmoPlugin_get_handle_value: +.. _class_EditorSpatialGizmoPlugin_method_get_handle_value: - :ref:`Variant` **get_handle_value** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual -.. _class_EditorSpatialGizmoPlugin_get_material: +.. _class_EditorSpatialGizmoPlugin_method_get_material: - :ref:`SpatialMaterial` **get_material** **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo **)** -.. _class_EditorSpatialGizmoPlugin_get_name: +.. _class_EditorSpatialGizmoPlugin_method_get_name: - :ref:`String` **get_name** **(** **)** virtual -.. _class_EditorSpatialGizmoPlugin_has_gizmo: +.. _class_EditorSpatialGizmoPlugin_method_has_gizmo: - :ref:`bool` **has_gizmo** **(** :ref:`Spatial` spatial **)** virtual -.. _class_EditorSpatialGizmoPlugin_is_gizmo_handle_highlighted: +.. _class_EditorSpatialGizmoPlugin_method_is_gizmo_handle_highlighted: - :ref:`bool` **is_gizmo_handle_highlighted** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** virtual -.. _class_EditorSpatialGizmoPlugin_is_selectable_when_hidden: +.. _class_EditorSpatialGizmoPlugin_method_is_selectable_when_hidden: - :ref:`bool` **is_selectable_when_hidden** **(** **)** virtual -.. _class_EditorSpatialGizmoPlugin_redraw: +.. _class_EditorSpatialGizmoPlugin_method_redraw: - void **redraw** **(** :ref:`EditorSpatialGizmo` gizmo **)** virtual -.. _class_EditorSpatialGizmoPlugin_set_handle: +.. _class_EditorSpatialGizmoPlugin_method_set_handle: - void **set_handle** **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index 8e56b9535..aa0c4cc59 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -19,20 +19,20 @@ Brief Description Methods ------- -+------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_object_id` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_object_id` **(** :ref:`int` id **)** | -+------------------------+--------------------------------------------------------------------------------------------------+ ++-----------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_object_id` **(** **)** const | ++-----------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_object_id` **(** :ref:`int` id **)** | ++-----------------------+---------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_EncodedObjectAsID_get_object_id: +.. _class_EncodedObjectAsID_method_get_object_id: - :ref:`int` **get_object_id** **(** **)** const -.. _class_EncodedObjectAsID_set_object_id: +.. _class_EncodedObjectAsID_method_set_object_id: - void **set_object_id** **(** :ref:`int` id **)** diff --git a/classes/class_engine.rst b/classes/class_engine.rst index ba31746ea..3a117350e 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -19,46 +19,46 @@ Access to basic engine properties. Properties ---------- -+---------------------------+------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_hint` | -+---------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`iterations_per_second` | -+---------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics_jitter_fix` | -+---------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`target_fps` | -+---------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`time_scale` | -+---------------------------+------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor_hint` | ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`int` | :ref:`iterations_per_second` | ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics_jitter_fix` | ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`int` | :ref:`target_fps` | ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`time_scale` | ++---------------------------+---------------------------------------------------------------------------+ 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:`Dictionary` | :ref:`get_license_info` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_license_text` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** 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:`Dictionary` | :ref:`get_license_info` **(** **)** const | ++-------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_license_text` **(** **)** const | ++-------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** 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 | ++-------------------------------------+------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -68,7 +68,7 @@ The ``Engine`` class allows you to query and modify the game's run-time paramete Property Descriptions --------------------- -.. _class_Engine_editor_hint: +.. _class_Engine_property_editor_hint: - :ref:`bool` **editor_hint** @@ -80,7 +80,7 @@ Property Descriptions If ``true``, it is running inside the editor. Useful for tool scripts. -.. _class_Engine_iterations_per_second: +.. _class_Engine_property_iterations_per_second: - :ref:`int` **iterations_per_second** @@ -92,7 +92,7 @@ If ``true``, it is running inside the editor. Useful for tool scripts. The number of fixed iterations per second (for fixed process and physics). -.. _class_Engine_physics_jitter_fix: +.. _class_Engine_property_physics_jitter_fix: - :ref:`float` **physics_jitter_fix** @@ -102,7 +102,7 @@ The number of fixed iterations per second (for fixed process and physics). | *Getter* | get_physics_jitter_fix() | +----------+-------------------------------+ -.. _class_Engine_target_fps: +.. _class_Engine_property_target_fps: - :ref:`int` **target_fps** @@ -114,7 +114,7 @@ The number of fixed iterations per second (for fixed process and physics). The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit. -.. _class_Engine_time_scale: +.. _class_Engine_property_time_scale: - :ref:`float` **time_scale** @@ -129,7 +129,7 @@ Controls how fast or slow the in-game clock ticks versus the real life one. It d Method Descriptions ------------------- -.. _class_Engine_get_author_info: +.. _class_Engine_method_get_author_info: - :ref:`Dictionary` **get_author_info** **(** **)** const @@ -143,7 +143,7 @@ Returns engine author information in a Dictionary. "developers" - Array of Strings, developer names -.. _class_Engine_get_copyright_info: +.. _class_Engine_method_get_copyright_info: - :ref:`Array` **get_copyright_info** **(** **)** const @@ -153,7 +153,7 @@ Returns an Array of copyright information Dictionaries. "parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component -.. _class_Engine_get_donor_info: +.. _class_Engine_method_get_donor_info: - :ref:`Dictionary` **get_donor_info** **(** **)** const @@ -161,41 +161,41 @@ Returns a Dictionary of Arrays of donor names. {"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"} -.. _class_Engine_get_frames_drawn: +.. _class_Engine_method_get_frames_drawn: - :ref:`int` **get_frames_drawn** **(** **)** Returns the total number of frames drawn. -.. _class_Engine_get_frames_per_second: +.. _class_Engine_method_get_frames_per_second: - :ref:`float` **get_frames_per_second** **(** **)** const Returns the frames per second of the running game. -.. _class_Engine_get_license_info: +.. _class_Engine_method_get_license_info: - :ref:`Dictionary` **get_license_info** **(** **)** const Returns Dictionary of licenses used by Godot and included third party components. -.. _class_Engine_get_license_text: +.. _class_Engine_method_get_license_text: - :ref:`String` **get_license_text** **(** **)** const Returns Godot license text. -.. _class_Engine_get_main_loop: +.. _class_Engine_method_get_main_loop: - :ref:`MainLoop` **get_main_loop** **(** **)** const Returns the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). -.. _class_Engine_get_singleton: +.. _class_Engine_method_get_singleton: - :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const -.. _class_Engine_get_version_info: +.. _class_Engine_method_get_version_info: - :ref:`Dictionary` **get_version_info** **(** **)** const @@ -213,11 +213,11 @@ Returns the current engine version information in a Dictionary. "string" - major + minor + patch + status + build in a single String -.. _class_Engine_has_singleton: +.. _class_Engine_method_has_singleton: - :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const -.. _class_Engine_is_in_physics_frame: +.. _class_Engine_method_is_in_physics_frame: - :ref:`bool` **is_in_physics_frame** **(** **)** const diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 069713b95..79d42481b 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -19,179 +19,193 @@ Resource for environment nodes (like :ref:`WorldEnvironment` | :ref:`adjustment_brightness` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`adjustment_color_correction` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`adjustment_contrast` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`adjustment_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`adjustment_saturation` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ambient_light_color` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ambient_light_energy` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ambient_light_sky_contribution` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_exposure_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_max_luma` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_min_luma` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_scale` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_speed` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`background_canvas_max_layer` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`background_color` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`background_energy` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`BGMode` | :ref:`background_mode` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Sky` | :ref:`background_sky` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`background_sky_custom_fov` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`background_sky_orientation` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`background_sky_rotation` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`background_sky_rotation_degrees` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_amount` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_distance` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dof_blur_far_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`DOFBlurQuality` | :ref:`dof_blur_far_quality` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_transition` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_amount` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_distance` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dof_blur_near_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`DOFBlurQuality` | :ref:`dof_blur_near_quality` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_transition` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`fog_color` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_depth_begin` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_depth_curve` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_depth_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_depth_end` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_height_curve` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_height_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_height_max` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_height_min` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_sun_amount` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`fog_sun_color` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_transmit_curve` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_transmit_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_bicubic_upscale` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`GlowBlendMode` | :ref:`glow_blend_mode` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_bloom` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_luminance_cap` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_scale` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_threshold` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_intensity` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/1` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/2` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/3` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/4` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/5` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/6` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/7` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_strength` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_depth_tolerance` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ss_reflections_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_fade_in` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_fade_out` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`ss_reflections_max_steps` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ss_reflections_roughness` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_ao_channel_affect` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_bias` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`SSAOBlur` | :ref:`ssao_blur` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ssao_color` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_edge_sharpness` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ssao_enabled` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_intensity` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_intensity2` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_light_affect` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`SSAOQuality` | :ref:`ssao_quality` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_radius` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_radius2` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tonemap_exposure` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`ToneMapper` | :ref:`tonemap_mode` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tonemap_white` | -+--------------------------------------------------------+-------------------------------------------------------------------------------------------+ ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`adjustment_brightness` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`adjustment_color_correction` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`adjustment_contrast` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`adjustment_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`adjustment_saturation` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ambient_light_color` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ambient_light_energy` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ambient_light_sky_contribution` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`auto_exposure_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_max_luma` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_min_luma` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_scale` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_speed` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`background_canvas_max_layer` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`background_color` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`background_energy` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`BGMode` | :ref:`background_mode` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Sky` | :ref:`background_sky` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`background_sky_custom_fov` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`background_sky_orientation` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`background_sky_rotation` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`background_sky_rotation_degrees` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_far_amount` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_far_distance` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`dof_blur_far_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`DOFBlurQuality` | :ref:`dof_blur_far_quality` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_far_transition` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_near_amount` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_near_distance` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`dof_blur_near_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`DOFBlurQuality` | :ref:`dof_blur_near_quality` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_near_transition` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`fog_color` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_depth_begin` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_depth_curve` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fog_depth_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_depth_end` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fog_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_height_curve` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fog_height_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_height_max` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_height_min` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_sun_amount` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`fog_sun_color` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_transmit_curve` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fog_transmit_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_bicubic_upscale` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`GlowBlendMode` | :ref:`glow_blend_mode` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_bloom` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_luminance_cap` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_scale` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_threshold` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_intensity` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/1` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/2` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/3` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/4` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/5` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/6` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/7` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_strength` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ss_reflections_depth_tolerance` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ss_reflections_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ss_reflections_fade_in` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ss_reflections_fade_out` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`ss_reflections_max_steps` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ss_reflections_roughness` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_ao_channel_affect` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_bias` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`SSAOBlur` | :ref:`ssao_blur` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ssao_color` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_edge_sharpness` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ssao_enabled` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_intensity` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_intensity2` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_light_affect` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`SSAOQuality` | :ref:`ssao_quality` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_radius` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_radius2` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tonemap_exposure` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`ToneMapper` | :ref:`tonemap_mode` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tonemap_white` | ++--------------------------------------------------------+----------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Environment_BGMode: +.. _class_Environment_constant_BG_KEEP: + +.. _class_Environment_constant_BG_CLEAR_COLOR: + +.. _class_Environment_constant_BG_COLOR: + +.. _class_Environment_constant_BG_SKY: + +.. _class_Environment_constant_BG_COLOR_SKY: + +.. _class_Environment_constant_BG_CANVAS: + +.. _class_Environment_constant_BG_MAX: + enum **BGMode**: - **BG_KEEP** = **5** --- Keep on screen every pixel drawn in the background. @@ -210,6 +224,14 @@ enum **BGMode**: .. _enum_Environment_GlowBlendMode: +.. _class_Environment_constant_GLOW_BLEND_MODE_ADDITIVE: + +.. _class_Environment_constant_GLOW_BLEND_MODE_SCREEN: + +.. _class_Environment_constant_GLOW_BLEND_MODE_SOFTLIGHT: + +.. _class_Environment_constant_GLOW_BLEND_MODE_REPLACE: + enum **GlowBlendMode**: - **GLOW_BLEND_MODE_ADDITIVE** = **0** --- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. @@ -222,6 +244,14 @@ enum **GlowBlendMode**: .. _enum_Environment_ToneMapper: +.. _class_Environment_constant_TONE_MAPPER_LINEAR: + +.. _class_Environment_constant_TONE_MAPPER_REINHARDT: + +.. _class_Environment_constant_TONE_MAPPER_FILMIC: + +.. _class_Environment_constant_TONE_MAPPER_ACES: + enum **ToneMapper**: - **TONE_MAPPER_LINEAR** = **0** --- Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. @@ -234,6 +264,12 @@ enum **ToneMapper**: .. _enum_Environment_DOFBlurQuality: +.. _class_Environment_constant_DOF_BLUR_QUALITY_LOW: + +.. _class_Environment_constant_DOF_BLUR_QUALITY_MEDIUM: + +.. _class_Environment_constant_DOF_BLUR_QUALITY_HIGH: + enum **DOFBlurQuality**: - **DOF_BLUR_QUALITY_LOW** = **0** --- Low depth-of-field blur quality. @@ -244,6 +280,14 @@ enum **DOFBlurQuality**: .. _enum_Environment_SSAOBlur: +.. _class_Environment_constant_SSAO_BLUR_DISABLED: + +.. _class_Environment_constant_SSAO_BLUR_1x1: + +.. _class_Environment_constant_SSAO_BLUR_2x2: + +.. _class_Environment_constant_SSAO_BLUR_3x3: + enum **SSAOBlur**: - **SSAO_BLUR_DISABLED** = **0** @@ -256,6 +300,12 @@ enum **SSAOBlur**: .. _enum_Environment_SSAOQuality: +.. _class_Environment_constant_SSAO_QUALITY_LOW: + +.. _class_Environment_constant_SSAO_QUALITY_MEDIUM: + +.. _class_Environment_constant_SSAO_QUALITY_HIGH: + enum **SSAOQuality**: - **SSAO_QUALITY_LOW** = **0** @@ -289,7 +339,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Environment_adjustment_brightness: +.. _class_Environment_property_adjustment_brightness: - :ref:`float` **adjustment_brightness** @@ -301,7 +351,7 @@ Property Descriptions Global brightness value of the rendered scene (default value is 1). -.. _class_Environment_adjustment_color_correction: +.. _class_Environment_property_adjustment_color_correction: - :ref:`Texture` **adjustment_color_correction** @@ -313,7 +363,7 @@ Global brightness value of the rendered scene (default value is 1). Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. -.. _class_Environment_adjustment_contrast: +.. _class_Environment_property_adjustment_contrast: - :ref:`float` **adjustment_contrast** @@ -325,7 +375,7 @@ Applies the provided :ref:`Texture` resource to affect the global Global contrast value of the rendered scene (default value is 1). -.. _class_Environment_adjustment_enabled: +.. _class_Environment_property_adjustment_enabled: - :ref:`bool` **adjustment_enabled** @@ -337,7 +387,7 @@ Global contrast value of the rendered scene (default value is 1). Enables the adjustment\_\* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene. -.. _class_Environment_adjustment_saturation: +.. _class_Environment_property_adjustment_saturation: - :ref:`float` **adjustment_saturation** @@ -349,7 +399,7 @@ Enables the adjustment\_\* options provided by this resource. If false, adjustme Global color saturation value of the rendered scene (default value is 1). -.. _class_Environment_ambient_light_color: +.. _class_Environment_property_ambient_light_color: - :ref:`Color` **ambient_light_color** @@ -361,7 +411,7 @@ Global color saturation value of the rendered scene (default value is 1). :ref:`Color` of the ambient light. -.. _class_Environment_ambient_light_energy: +.. _class_Environment_property_ambient_light_energy: - :ref:`float` **ambient_light_energy** @@ -373,7 +423,7 @@ Global color saturation value of the rendered scene (default value is 1). Energy of the ambient light. The higher the value, the stronger the light. -.. _class_Environment_ambient_light_sky_contribution: +.. _class_Environment_property_ambient_light_sky_contribution: - :ref:`float` **ambient_light_sky_contribution** @@ -385,7 +435,7 @@ Energy of the ambient light. The higher the value, the stronger the light. Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. -.. _class_Environment_auto_exposure_enabled: +.. _class_Environment_property_auto_exposure_enabled: - :ref:`bool` **auto_exposure_enabled** @@ -397,7 +447,7 @@ Defines the amount of light that the sky brings on the scene. A value of 0 means Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light. -.. _class_Environment_auto_exposure_max_luma: +.. _class_Environment_property_auto_exposure_max_luma: - :ref:`float` **auto_exposure_max_luma** @@ -409,7 +459,7 @@ Enables the tonemapping auto exposure mode of the scene renderer. If activated, Maximum luminance value for the auto exposure. -.. _class_Environment_auto_exposure_min_luma: +.. _class_Environment_property_auto_exposure_min_luma: - :ref:`float` **auto_exposure_min_luma** @@ -421,7 +471,7 @@ Maximum luminance value for the auto exposure. Minimum luminance value for the auto exposure. -.. _class_Environment_auto_exposure_scale: +.. _class_Environment_property_auto_exposure_scale: - :ref:`float` **auto_exposure_scale** @@ -433,7 +483,7 @@ Minimum luminance value for the auto exposure. Scale of the auto exposure effect. Affects the intensity of auto exposure. -.. _class_Environment_auto_exposure_speed: +.. _class_Environment_property_auto_exposure_speed: - :ref:`float` **auto_exposure_speed** @@ -445,7 +495,7 @@ Scale of the auto exposure effect. Affects the intensity of auto exposure. Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. -.. _class_Environment_background_canvas_max_layer: +.. _class_Environment_property_background_canvas_max_layer: - :ref:`int` **background_canvas_max_layer** @@ -457,7 +507,7 @@ Speed of the auto exposure effect. Affects the time needed for the camera to per Maximum layer id (if using Layer background mode). -.. _class_Environment_background_color: +.. _class_Environment_property_background_color: - :ref:`Color` **background_color** @@ -469,7 +519,7 @@ Maximum layer id (if using Layer background mode). Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). -.. _class_Environment_background_energy: +.. _class_Environment_property_background_energy: - :ref:`float` **background_energy** @@ -481,7 +531,7 @@ Color displayed for clear areas of the scene (if using Custom color or Color+Sky Power of light emitted by the background. -.. _class_Environment_background_mode: +.. _class_Environment_property_background_mode: - :ref:`BGMode` **background_mode** @@ -493,7 +543,7 @@ Power of light emitted by the background. Defines the mode of background. -.. _class_Environment_background_sky: +.. _class_Environment_property_background_sky: - :ref:`Sky` **background_sky** @@ -505,7 +555,7 @@ Defines the mode of background. :ref:`Sky` resource defined as background. -.. _class_Environment_background_sky_custom_fov: +.. _class_Environment_property_background_sky_custom_fov: - :ref:`float` **background_sky_custom_fov** @@ -517,7 +567,7 @@ Defines the mode of background. :ref:`Sky` resource's custom field of view. -.. _class_Environment_background_sky_orientation: +.. _class_Environment_property_background_sky_orientation: - :ref:`Basis` **background_sky_orientation** @@ -529,7 +579,7 @@ Defines the mode of background. :ref:`Sky` resource's rotation expressed as a :ref:`Basis` -.. _class_Environment_background_sky_rotation: +.. _class_Environment_property_background_sky_rotation: - :ref:`Vector3` **background_sky_rotation** @@ -541,7 +591,7 @@ Defines the mode of background. :ref:`Sky` resource's rotation expressed as euler angles in radians -.. _class_Environment_background_sky_rotation_degrees: +.. _class_Environment_property_background_sky_rotation_degrees: - :ref:`Vector3` **background_sky_rotation_degrees** @@ -553,7 +603,7 @@ Defines the mode of background. :ref:`Sky` resource's rotation expressed as euler angles in degrees -.. _class_Environment_dof_blur_far_amount: +.. _class_Environment_property_dof_blur_far_amount: - :ref:`float` **dof_blur_far_amount** @@ -565,7 +615,7 @@ Defines the mode of background. Amount of far blur. -.. _class_Environment_dof_blur_far_distance: +.. _class_Environment_property_dof_blur_far_distance: - :ref:`float` **dof_blur_far_distance** @@ -577,7 +627,7 @@ Amount of far blur. Distance from the camera where the far blur effect affects the rendering. -.. _class_Environment_dof_blur_far_enabled: +.. _class_Environment_property_dof_blur_far_enabled: - :ref:`bool` **dof_blur_far_enabled** @@ -589,7 +639,7 @@ Distance from the camera where the far blur effect affects the rendering. Enables the far blur effect. -.. _class_Environment_dof_blur_far_quality: +.. _class_Environment_property_dof_blur_far_quality: - :ref:`DOFBlurQuality` **dof_blur_far_quality** @@ -601,7 +651,7 @@ Enables the far blur effect. Quality of the far blur quality. -.. _class_Environment_dof_blur_far_transition: +.. _class_Environment_property_dof_blur_far_transition: - :ref:`float` **dof_blur_far_transition** @@ -613,7 +663,7 @@ Quality of the far blur quality. Transition between no-blur area and far blur. -.. _class_Environment_dof_blur_near_amount: +.. _class_Environment_property_dof_blur_near_amount: - :ref:`float` **dof_blur_near_amount** @@ -625,7 +675,7 @@ Transition between no-blur area and far blur. Amount of near blur. -.. _class_Environment_dof_blur_near_distance: +.. _class_Environment_property_dof_blur_near_distance: - :ref:`float` **dof_blur_near_distance** @@ -637,7 +687,7 @@ Amount of near blur. Distance from the camera where the near blur effect affects the rendering. -.. _class_Environment_dof_blur_near_enabled: +.. _class_Environment_property_dof_blur_near_enabled: - :ref:`bool` **dof_blur_near_enabled** @@ -649,7 +699,7 @@ Distance from the camera where the near blur effect affects the rendering. Enables the near blur effect. -.. _class_Environment_dof_blur_near_quality: +.. _class_Environment_property_dof_blur_near_quality: - :ref:`DOFBlurQuality` **dof_blur_near_quality** @@ -661,7 +711,7 @@ Enables the near blur effect. Quality of the near blur quality. -.. _class_Environment_dof_blur_near_transition: +.. _class_Environment_property_dof_blur_near_transition: - :ref:`float` **dof_blur_near_transition** @@ -673,7 +723,7 @@ Quality of the near blur quality. Transition between near blur and no-blur area. -.. _class_Environment_fog_color: +.. _class_Environment_property_fog_color: - :ref:`Color` **fog_color** @@ -685,7 +735,7 @@ Transition between near blur and no-blur area. Fog's :ref:`Color`. -.. _class_Environment_fog_depth_begin: +.. _class_Environment_property_fog_depth_begin: - :ref:`float` **fog_depth_begin** @@ -697,7 +747,7 @@ Fog's :ref:`Color`. Fog's depth starting distance from the camera. -.. _class_Environment_fog_depth_curve: +.. _class_Environment_property_fog_depth_curve: - :ref:`float` **fog_depth_curve** @@ -709,7 +759,7 @@ Fog's depth starting distance from the camera. Value defining the fog depth intensity. -.. _class_Environment_fog_depth_enabled: +.. _class_Environment_property_fog_depth_enabled: - :ref:`bool` **fog_depth_enabled** @@ -721,7 +771,7 @@ Value defining the fog depth intensity. Enables the fog depth. -.. _class_Environment_fog_depth_end: +.. _class_Environment_property_fog_depth_end: - :ref:`float` **fog_depth_end** @@ -731,7 +781,7 @@ Enables the fog depth. | *Getter* | get_fog_depth_end() | +----------+--------------------------+ -.. _class_Environment_fog_enabled: +.. _class_Environment_property_fog_enabled: - :ref:`bool` **fog_enabled** @@ -743,7 +793,7 @@ Enables the fog depth. Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. -.. _class_Environment_fog_height_curve: +.. _class_Environment_property_fog_height_curve: - :ref:`float` **fog_height_curve** @@ -755,7 +805,7 @@ Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually d Value defining the fog height intensity. -.. _class_Environment_fog_height_enabled: +.. _class_Environment_property_fog_height_enabled: - :ref:`bool` **fog_height_enabled** @@ -767,7 +817,7 @@ Value defining the fog height intensity. Enables the fog height. -.. _class_Environment_fog_height_max: +.. _class_Environment_property_fog_height_max: - :ref:`float` **fog_height_max** @@ -779,7 +829,7 @@ Enables the fog height. Maximum height of fog. -.. _class_Environment_fog_height_min: +.. _class_Environment_property_fog_height_min: - :ref:`float` **fog_height_min** @@ -791,7 +841,7 @@ Maximum height of fog. Minimum height of fog. -.. _class_Environment_fog_sun_amount: +.. _class_Environment_property_fog_sun_amount: - :ref:`float` **fog_sun_amount** @@ -803,7 +853,7 @@ Minimum height of fog. Amount of sun that affects the fog rendering. -.. _class_Environment_fog_sun_color: +.. _class_Environment_property_fog_sun_color: - :ref:`Color` **fog_sun_color** @@ -815,7 +865,7 @@ Amount of sun that affects the fog rendering. Sun :ref:`Color`. -.. _class_Environment_fog_transmit_curve: +.. _class_Environment_property_fog_transmit_curve: - :ref:`float` **fog_transmit_curve** @@ -827,7 +877,7 @@ Sun :ref:`Color`. Amount of light that the fog transmits. -.. _class_Environment_fog_transmit_enabled: +.. _class_Environment_property_fog_transmit_enabled: - :ref:`bool` **fog_transmit_enabled** @@ -839,7 +889,7 @@ Amount of light that the fog transmits. Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog. -.. _class_Environment_glow_bicubic_upscale: +.. _class_Environment_property_glow_bicubic_upscale: - :ref:`bool` **glow_bicubic_upscale** @@ -849,7 +899,7 @@ Enables fog's light transmission. If enabled, lets reflections light to be trans | *Getter* | is_glow_bicubic_upscale_enabled() | +----------+-----------------------------------+ -.. _class_Environment_glow_blend_mode: +.. _class_Environment_property_glow_blend_mode: - :ref:`GlowBlendMode` **glow_blend_mode** @@ -861,7 +911,7 @@ Enables fog's light transmission. If enabled, lets reflections light to be trans Glow blending mode. -.. _class_Environment_glow_bloom: +.. _class_Environment_property_glow_bloom: - :ref:`float` **glow_bloom** @@ -873,7 +923,7 @@ Glow blending mode. Bloom value (global glow). -.. _class_Environment_glow_enabled: +.. _class_Environment_property_glow_enabled: - :ref:`bool` **glow_enabled** @@ -885,7 +935,7 @@ Bloom value (global glow). Enables glow rendering. -.. _class_Environment_glow_hdr_luminance_cap: +.. _class_Environment_property_glow_hdr_luminance_cap: - :ref:`float` **glow_hdr_luminance_cap** @@ -895,7 +945,7 @@ Enables glow rendering. | *Getter* | get_glow_hdr_luminance_cap() | +----------+-----------------------------------+ -.. _class_Environment_glow_hdr_scale: +.. _class_Environment_property_glow_hdr_scale: - :ref:`float` **glow_hdr_scale** @@ -907,7 +957,7 @@ Enables glow rendering. Bleed scale of the HDR glow. -.. _class_Environment_glow_hdr_threshold: +.. _class_Environment_property_glow_hdr_threshold: - :ref:`float` **glow_hdr_threshold** @@ -919,7 +969,7 @@ Bleed scale of the HDR glow. Bleed threshold of the HDR glow. -.. _class_Environment_glow_intensity: +.. _class_Environment_property_glow_intensity: - :ref:`float` **glow_intensity** @@ -931,7 +981,7 @@ Bleed threshold of the HDR glow. Glow intensity. -.. _class_Environment_glow_levels/1: +.. _class_Environment_property_glow_levels/1: - :ref:`bool` **glow_levels/1** @@ -943,7 +993,7 @@ Glow intensity. First level of glow (most local). -.. _class_Environment_glow_levels/2: +.. _class_Environment_property_glow_levels/2: - :ref:`bool` **glow_levels/2** @@ -955,7 +1005,7 @@ First level of glow (most local). Second level of glow. -.. _class_Environment_glow_levels/3: +.. _class_Environment_property_glow_levels/3: - :ref:`bool` **glow_levels/3** @@ -967,7 +1017,7 @@ Second level of glow. Third level of glow. -.. _class_Environment_glow_levels/4: +.. _class_Environment_property_glow_levels/4: - :ref:`bool` **glow_levels/4** @@ -979,7 +1029,7 @@ Third level of glow. Fourth level of glow. -.. _class_Environment_glow_levels/5: +.. _class_Environment_property_glow_levels/5: - :ref:`bool` **glow_levels/5** @@ -991,7 +1041,7 @@ Fourth level of glow. Fifth level of glow. -.. _class_Environment_glow_levels/6: +.. _class_Environment_property_glow_levels/6: - :ref:`bool` **glow_levels/6** @@ -1003,7 +1053,7 @@ Fifth level of glow. Sixth level of glow. -.. _class_Environment_glow_levels/7: +.. _class_Environment_property_glow_levels/7: - :ref:`bool` **glow_levels/7** @@ -1015,7 +1065,7 @@ Sixth level of glow. Seventh level of glow (most global). -.. _class_Environment_glow_strength: +.. _class_Environment_property_glow_strength: - :ref:`float` **glow_strength** @@ -1027,7 +1077,7 @@ Seventh level of glow (most global). Glow strength. -.. _class_Environment_ss_reflections_depth_tolerance: +.. _class_Environment_property_ss_reflections_depth_tolerance: - :ref:`float` **ss_reflections_depth_tolerance** @@ -1037,7 +1087,7 @@ Glow strength. | *Getter* | get_ssr_depth_tolerance() | +----------+--------------------------------+ -.. _class_Environment_ss_reflections_enabled: +.. _class_Environment_property_ss_reflections_enabled: - :ref:`bool` **ss_reflections_enabled** @@ -1047,7 +1097,7 @@ Glow strength. | *Getter* | is_ssr_enabled() | +----------+------------------------+ -.. _class_Environment_ss_reflections_fade_in: +.. _class_Environment_property_ss_reflections_fade_in: - :ref:`float` **ss_reflections_fade_in** @@ -1057,7 +1107,7 @@ Glow strength. | *Getter* | get_ssr_fade_in() | +----------+------------------------+ -.. _class_Environment_ss_reflections_fade_out: +.. _class_Environment_property_ss_reflections_fade_out: - :ref:`float` **ss_reflections_fade_out** @@ -1067,7 +1117,7 @@ Glow strength. | *Getter* | get_ssr_fade_out() | +----------+-------------------------+ -.. _class_Environment_ss_reflections_max_steps: +.. _class_Environment_property_ss_reflections_max_steps: - :ref:`int` **ss_reflections_max_steps** @@ -1077,7 +1127,7 @@ Glow strength. | *Getter* | get_ssr_max_steps() | +----------+--------------------------+ -.. _class_Environment_ss_reflections_roughness: +.. _class_Environment_property_ss_reflections_roughness: - :ref:`bool` **ss_reflections_roughness** @@ -1087,7 +1137,7 @@ Glow strength. | *Getter* | is_ssr_rough() | +----------+----------------------+ -.. _class_Environment_ssao_ao_channel_affect: +.. _class_Environment_property_ssao_ao_channel_affect: - :ref:`float` **ssao_ao_channel_affect** @@ -1097,7 +1147,7 @@ Glow strength. | *Getter* | get_ssao_ao_channel_affect() | +----------+-----------------------------------+ -.. _class_Environment_ssao_bias: +.. _class_Environment_property_ssao_bias: - :ref:`float` **ssao_bias** @@ -1107,7 +1157,7 @@ Glow strength. | *Getter* | get_ssao_bias() | +----------+----------------------+ -.. _class_Environment_ssao_blur: +.. _class_Environment_property_ssao_blur: - :ref:`SSAOBlur` **ssao_blur** @@ -1117,7 +1167,7 @@ Glow strength. | *Getter* | is_ssao_blur_enabled() | +----------+------------------------+ -.. _class_Environment_ssao_color: +.. _class_Environment_property_ssao_color: - :ref:`Color` **ssao_color** @@ -1127,7 +1177,7 @@ Glow strength. | *Getter* | get_ssao_color() | +----------+-----------------------+ -.. _class_Environment_ssao_edge_sharpness: +.. _class_Environment_property_ssao_edge_sharpness: - :ref:`float` **ssao_edge_sharpness** @@ -1137,7 +1187,7 @@ Glow strength. | *Getter* | get_ssao_edge_sharpness() | +----------+--------------------------------+ -.. _class_Environment_ssao_enabled: +.. _class_Environment_property_ssao_enabled: - :ref:`bool` **ssao_enabled** @@ -1147,7 +1197,7 @@ Glow strength. | *Getter* | is_ssao_enabled() | +----------+-------------------------+ -.. _class_Environment_ssao_intensity: +.. _class_Environment_property_ssao_intensity: - :ref:`float` **ssao_intensity** @@ -1157,7 +1207,7 @@ Glow strength. | *Getter* | get_ssao_intensity() | +----------+---------------------------+ -.. _class_Environment_ssao_intensity2: +.. _class_Environment_property_ssao_intensity2: - :ref:`float` **ssao_intensity2** @@ -1167,7 +1217,7 @@ Glow strength. | *Getter* | get_ssao_intensity2() | +----------+----------------------------+ -.. _class_Environment_ssao_light_affect: +.. _class_Environment_property_ssao_light_affect: - :ref:`float` **ssao_light_affect** @@ -1177,7 +1227,7 @@ Glow strength. | *Getter* | get_ssao_direct_light_affect() | +----------+-------------------------------------+ -.. _class_Environment_ssao_quality: +.. _class_Environment_property_ssao_quality: - :ref:`SSAOQuality` **ssao_quality** @@ -1187,7 +1237,7 @@ Glow strength. | *Getter* | get_ssao_quality() | +----------+-------------------------+ -.. _class_Environment_ssao_radius: +.. _class_Environment_property_ssao_radius: - :ref:`float` **ssao_radius** @@ -1197,7 +1247,7 @@ Glow strength. | *Getter* | get_ssao_radius() | +----------+------------------------+ -.. _class_Environment_ssao_radius2: +.. _class_Environment_property_ssao_radius2: - :ref:`float` **ssao_radius2** @@ -1207,7 +1257,7 @@ Glow strength. | *Getter* | get_ssao_radius2() | +----------+-------------------------+ -.. _class_Environment_tonemap_exposure: +.. _class_Environment_property_tonemap_exposure: - :ref:`float` **tonemap_exposure** @@ -1219,7 +1269,7 @@ Glow strength. Default exposure for tonemap. -.. _class_Environment_tonemap_mode: +.. _class_Environment_property_tonemap_mode: - :ref:`ToneMapper` **tonemap_mode** @@ -1231,7 +1281,7 @@ Default exposure for tonemap. Tonemapping mode. -.. _class_Environment_tonemap_white: +.. _class_Environment_property_tonemap_white: - :ref:`float` **tonemap_white** diff --git a/classes/class_expression.rst b/classes/class_expression.rst index dc7227271..19cc9d3c4 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -19,15 +19,15 @@ A class that stores an expression you can execute. 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:`bool` | :ref:`has_execute_failed` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`parse` **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`has_execute_failed` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`parse` **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -57,25 +57,25 @@ In the following example we use a :ref:`LineEdit` node to write Method Descriptions ------------------- -.. _class_Expression_execute: +.. _class_Expression_method_execute: - :ref:`Variant` **execute** **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** -Executes the expression that was previously parsed by :ref:`parse` and returns the result. Before you use the returned object, you should check if the method failed by calling :ref:`has_execute_failed`. +Executes the expression that was previously parsed by :ref:`parse` and returns the result. Before you use the returned object, you should check if the method failed by calling :ref:`has_execute_failed`. -.. _class_Expression_get_error_text: +.. _class_Expression_method_get_error_text: - :ref:`String` **get_error_text** **(** **)** const -Returns the error text if :ref:`parse` has failed. +Returns the error text if :ref:`parse` has failed. -.. _class_Expression_has_execute_failed: +.. _class_Expression_method_has_execute_failed: - :ref:`bool` **has_execute_failed** **(** **)** const -Returns ``true`` if :ref:`execute` has failed. +Returns ``true`` if :ref:`execute` has failed. -.. _class_Expression_parse: +.. _class_Expression_method_parse: - :ref:`Error` **parse** **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** diff --git a/classes/class_file.rst b/classes/class_file.rst index dbbf8e945..e15ff5b3b 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -19,108 +19,116 @@ Type to handle file reading and writing operations. Properties ---------- -+-------------------------+--------------------------------------------+ -| :ref:`bool` | :ref:`endian_swap` | -+-------------------------+--------------------------------------------+ ++-------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`endian_swap` | ++-------------------------+-----------------------------------------------------+ Methods ------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`eof_reached` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_error` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_len` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** 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_absolute` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_real` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_open` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` position **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_16` **(** :ref:`int` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_32` **(** :ref:`int` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_64` **(** :ref:`int` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_8` **(** :ref:`int` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_csv_line` **(** :ref:`PoolStringArray` values, :ref:`String` delim="," **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_double` **(** :ref:`float` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_float` **(** :ref:`float` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_line` **(** :ref:`String` line **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_real` **(** :ref:`float` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_string` **(** :ref:`String` string **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_var` **(** :ref:`Variant` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`eof_reached` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_16` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_32` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_64` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_8` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_as_text` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_double` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`get_error` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_float` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_len` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** 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_absolute` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_real` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_open` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`int` position **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_16` **(** :ref:`int` value **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_32` **(** :ref:`int` value **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_64` **(** :ref:`int` value **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_8` **(** :ref:`int` value **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_csv_line` **(** :ref:`PoolStringArray` values, :ref:`String` delim="," **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_double` **(** :ref:`float` value **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_float` **(** :ref:`float` value **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_line` **(** :ref:`String` line **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_real` **(** :ref:`float` value **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_string` **(** :ref:`String` string **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_var` **(** :ref:`Variant` value **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_File_ModeFlags: +.. _class_File_constant_READ: + +.. _class_File_constant_WRITE: + +.. _class_File_constant_READ_WRITE: + +.. _class_File_constant_WRITE_READ: + enum **ModeFlags**: - **READ** = **1** --- Opens the file for read operations. @@ -133,6 +141,14 @@ enum **ModeFlags**: .. _enum_File_CompressionMode: +.. _class_File_constant_COMPRESSION_FASTLZ: + +.. _class_File_constant_COMPRESSION_DEFLATE: + +.. _class_File_constant_COMPRESSION_ZSTD: + +.. _class_File_constant_COMPRESSION_GZIP: + enum **CompressionMode**: - **COMPRESSION_FASTLZ** = **0** --- Uses the FastLZ compression method. @@ -173,7 +189,7 @@ Tutorials Property Descriptions --------------------- -.. _class_File_endian_swap: +.. _class_File_property_endian_swap: - :ref:`bool` **endian_swap** @@ -190,265 +206,265 @@ Note that this is about the file format, not CPU type. This is always reset to ` Method Descriptions ------------------- -.. _class_File_close: +.. _class_File_method_close: - void **close** **(** **)** Closes the currently opened file. -.. _class_File_eof_reached: +.. _class_File_method_eof_reached: - :ref:`bool` **eof_reached** **(** **)** const Returns ``true`` if the file cursor has reached the end of the file. -.. _class_File_file_exists: +.. _class_File_method_file_exists: - :ref:`bool` **file_exists** **(** :ref:`String` path **)** const Returns ``true`` if the file exists in the given path. -.. _class_File_get_16: +.. _class_File_method_get_16: - :ref:`int` **get_16** **(** **)** const Returns the next 16 bits from the file as an integer. -.. _class_File_get_32: +.. _class_File_method_get_32: - :ref:`int` **get_32** **(** **)** const Returns the next 32 bits from the file as an integer. -.. _class_File_get_64: +.. _class_File_method_get_64: - :ref:`int` **get_64** **(** **)** const Returns the next 64 bits from the file as an integer. -.. _class_File_get_8: +.. _class_File_method_get_8: - :ref:`int` **get_8** **(** **)** const Returns the next 8 bits from the file as an integer. -.. _class_File_get_as_text: +.. _class_File_method_get_as_text: - :ref:`String` **get_as_text** **(** **)** const Returns the whole file as a :ref:`String`. -.. _class_File_get_buffer: +.. _class_File_method_get_buffer: - :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const Returns next ``len`` bytes of the file as a :ref:`PoolByteArray`. -.. _class_File_get_csv_line: +.. _class_File_method_get_csv_line: - :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 to use other than the default "," (comma), it should be one character long. -.. _class_File_get_double: +.. _class_File_method_get_double: - :ref:`float` **get_double** **(** **)** const Returns the next 64 bits from the file as a floating point number. -.. _class_File_get_error: +.. _class_File_method_get_error: - :ref:`Error` **get_error** **(** **)** const Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`@GlobalScope`. -.. _class_File_get_float: +.. _class_File_method_get_float: - :ref:`float` **get_float** **(** **)** const Returns the next 32 bits from the file as a floating point number. -.. _class_File_get_len: +.. _class_File_method_get_len: - :ref:`int` **get_len** **(** **)** const Returns the size of the file in bytes. -.. _class_File_get_line: +.. _class_File_method_get_line: - :ref:`String` **get_line** **(** **)** const Returns the next line of the file as a :ref:`String`. -.. _class_File_get_md5: +.. _class_File_method_get_md5: - :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. -.. _class_File_get_modified_time: +.. _class_File_method_get_modified_time: - :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`. +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`. -.. _class_File_get_pascal_string: +.. _class_File_method_get_pascal_string: - :ref:`String` **get_pascal_string** **(** **)** Returns a :ref:`String` saved in Pascal format from the file. -.. _class_File_get_path: +.. _class_File_method_get_path: - :ref:`String` **get_path** **(** **)** const Returns the path as a :ref:`String` for the current open file. -.. _class_File_get_path_absolute: +.. _class_File_method_get_path_absolute: - :ref:`String` **get_path_absolute** **(** **)** const Returns the absolute path as a :ref:`String` for the current open file. -.. _class_File_get_position: +.. _class_File_method_get_position: - :ref:`int` **get_position** **(** **)** const Returns the file cursor's position. -.. _class_File_get_real: +.. _class_File_method_get_real: - :ref:`float` **get_real** **(** **)** const Returns the next bits from the file as a floating point number. -.. _class_File_get_sha256: +.. _class_File_method_get_sha256: - :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. -.. _class_File_get_var: +.. _class_File_method_get_var: - :ref:`Variant` **get_var** **(** **)** const Returns the next :ref:`Variant` value from the file. -.. _class_File_is_open: +.. _class_File_method_is_open: - :ref:`bool` **is_open** **(** **)** const Returns ``true`` if the file is currently opened. -.. _class_File_open: +.. _class_File_method_open: - :ref:`Error` **open** **(** :ref:`String` path, :ref:`int` flags **)** Opens the file for writing or reading, depending on the flags. -.. _class_File_open_compressed: +.. _class_File_method_open_compressed: - :ref:`Error` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** Opens a compressed file for reading or writing. Use COMPRESSION\_\* constants to set ``compression_mode``. -.. _class_File_open_encrypted: +.. _class_File_method_open_encrypted: - :ref:`Error` **open_encrypted** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. -.. _class_File_open_encrypted_with_pass: +.. _class_File_method_open_encrypted_with_pass: - :ref:`Error` **open_encrypted_with_pass** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. -.. _class_File_seek: +.. _class_File_method_seek: - void **seek** **(** :ref:`int` position **)** Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). -.. _class_File_seek_end: +.. _class_File_method_seek_end: - void **seek_end** **(** :ref:`int` position=0 **)** Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. -.. _class_File_store_16: +.. _class_File_method_store_16: - void **store_16** **(** :ref:`int` value **)** Stores an integer as 16 bits in the file. -.. _class_File_store_32: +.. _class_File_method_store_32: - void **store_32** **(** :ref:`int` value **)** Stores an integer as 32 bits in the file. -.. _class_File_store_64: +.. _class_File_method_store_64: - void **store_64** **(** :ref:`int` value **)** Stores an integer as 64 bits in the file. -.. _class_File_store_8: +.. _class_File_method_store_8: - void **store_8** **(** :ref:`int` value **)** Stores an integer as 8 bits in the file. -.. _class_File_store_buffer: +.. _class_File_method_store_buffer: - void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** Stores the given array of bytes in the file. -.. _class_File_store_csv_line: +.. _class_File_method_store_csv_line: - void **store_csv_line** **(** :ref:`PoolStringArray` values, :ref:`String` delim="," **)** Store the given :ref:`PoolStringArray` in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long. -.. _class_File_store_double: +.. _class_File_method_store_double: - void **store_double** **(** :ref:`float` value **)** Stores a floating point number as 64 bits in the file. -.. _class_File_store_float: +.. _class_File_method_store_float: - void **store_float** **(** :ref:`float` value **)** Stores a floating point number as 32 bits in the file. -.. _class_File_store_line: +.. _class_File_method_store_line: - void **store_line** **(** :ref:`String` line **)** Stores the given :ref:`String` as a line in the file. -.. _class_File_store_pascal_string: +.. _class_File_method_store_pascal_string: - void **store_pascal_string** **(** :ref:`String` string **)** Stores the given :ref:`String` as a line in the file in Pascal format (i.e. also store the length of the string). -.. _class_File_store_real: +.. _class_File_method_store_real: - void **store_real** **(** :ref:`float` value **)** Stores a floating point number in the file. -.. _class_File_store_string: +.. _class_File_method_store_string: - void **store_string** **(** :ref:`String` string **)** Stores the given :ref:`String` in the file. -.. _class_File_store_var: +.. _class_File_method_store_var: - void **store_var** **(** :ref:`Variant` value **)** diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index c8566a44e..51fe25f1d 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -19,70 +19,70 @@ Dialog for selecting files or directories in the filesystem. Properties ---------- -+-----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Access` | :ref:`access` | -+-----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_dir` | -+-----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_file` | -+-----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`current_path` | -+-----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`filters` | -+-----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+-----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`mode_overrides_title` | -+-----------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_hidden_files` | -+-----------------------------------------------+--------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`Access` | :ref:`access` | ++-----------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`String` | :ref:`current_dir` | ++-----------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`String` | :ref:`current_file` | ++-----------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`String` | :ref:`current_path` | ++-----------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`filters` | ++-----------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++-----------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`mode_overrides_title` | ++-----------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`show_hidden_files` | ++-----------------------------------------------+-----------------------------------------------------------------------------+ Methods ------- -+--------------------------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`add_filter` **(** :ref:`String` filter **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`clear_filters` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`deselect_items` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`invalidate` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------+ ++-------------------------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_filter` **(** :ref:`String` filter **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_filters` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect_items` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`invalidate` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+-------------------------------+--------------------------------------------------------+ -| :ref:`Color` | :ref:`files_disabled` | -+-------------------------------+--------------------------------------------------------+ -| :ref:`Texture` | :ref:`folder` | -+-------------------------------+--------------------------------------------------------+ -| :ref:`Texture` | :ref:`parent_folder` | -+-------------------------------+--------------------------------------------------------+ -| :ref:`Texture` | :ref:`reload` | -+-------------------------------+--------------------------------------------------------+ ++-------------------------------+----------------+ +| :ref:`Color` | files_disabled | ++-------------------------------+----------------+ +| :ref:`Texture` | folder | ++-------------------------------+----------------+ +| :ref:`Texture` | parent_folder | ++-------------------------------+----------------+ +| :ref:`Texture` | reload | ++-------------------------------+----------------+ Signals ------- -.. _class_FileDialog_dir_selected: +.. _class_FileDialog_signal_dir_selected: - **dir_selected** **(** :ref:`String` dir **)** Event emitted when the user selects a directory. -.. _class_FileDialog_file_selected: +.. _class_FileDialog_signal_file_selected: - **file_selected** **(** :ref:`String` path **)** Event emitted when the user selects a file (double clicks it or presses the OK button). -.. _class_FileDialog_files_selected: +.. _class_FileDialog_signal_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** @@ -93,6 +93,16 @@ Enumerations .. _enum_FileDialog_Mode: +.. _class_FileDialog_constant_MODE_OPEN_FILE: + +.. _class_FileDialog_constant_MODE_OPEN_FILES: + +.. _class_FileDialog_constant_MODE_OPEN_DIR: + +.. _class_FileDialog_constant_MODE_OPEN_ANY: + +.. _class_FileDialog_constant_MODE_SAVE_FILE: + enum **Mode**: - **MODE_OPEN_FILE** = **0** --- The dialog allows the selection of one, and only one file. @@ -107,6 +117,12 @@ enum **Mode**: .. _enum_FileDialog_Access: +.. _class_FileDialog_constant_ACCESS_RESOURCES: + +.. _class_FileDialog_constant_ACCESS_USERDATA: + +.. _class_FileDialog_constant_ACCESS_FILESYSTEM: + enum **Access**: - **ACCESS_RESOURCES** = **0** --- The dialog allows the selection of file and directory. @@ -123,7 +139,7 @@ FileDialog is a preset dialog used to choose files and directories in the filesy Property Descriptions --------------------- -.. _class_FileDialog_access: +.. _class_FileDialog_property_access: - :ref:`Access` **access** @@ -135,7 +151,7 @@ Property Descriptions The file system access scope. See enum ``Access`` constants. -.. _class_FileDialog_current_dir: +.. _class_FileDialog_property_current_dir: - :ref:`String` **current_dir** @@ -147,7 +163,7 @@ The file system access scope. See enum ``Access`` constants. The current working directory of the file dialog. -.. _class_FileDialog_current_file: +.. _class_FileDialog_property_current_file: - :ref:`String` **current_file** @@ -159,7 +175,7 @@ The current working directory of the file dialog. The currently selected file of the file dialog. -.. _class_FileDialog_current_path: +.. _class_FileDialog_property_current_path: - :ref:`String` **current_path** @@ -171,7 +187,7 @@ The currently selected file of the file dialog. The currently selected file path of the file dialog. -.. _class_FileDialog_filters: +.. _class_FileDialog_property_filters: - :ref:`PoolStringArray` **filters** @@ -183,7 +199,7 @@ The currently selected file path of the file dialog. Set file type filters. This example shows only .png and .gd files ``set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GD Script"]))``. -.. _class_FileDialog_mode: +.. _class_FileDialog_property_mode: - :ref:`Mode` **mode** @@ -195,7 +211,7 @@ Set file type filters. This example shows only .png and .gd files ``set_filters( Set dialog to open or save mode, changes selection behavior. See enum ``Mode`` constants. -.. _class_FileDialog_mode_overrides_title: +.. _class_FileDialog_property_mode_overrides_title: - :ref:`bool` **mode_overrides_title** @@ -207,7 +223,7 @@ Set dialog to open or save mode, changes selection behavior. See enum ``Mode`` c If ``true``, changing the ``Mode`` property will set the window title accordingly (e.g. setting mode to ``MODE_OPEN_FILE`` will change the window title to "Open a File"). -.. _class_FileDialog_show_hidden_files: +.. _class_FileDialog_property_show_hidden_files: - :ref:`bool` **show_hidden_files** @@ -222,37 +238,37 @@ If ``true``, the dialog will show hidden files. Method Descriptions ------------------- -.. _class_FileDialog_add_filter: +.. _class_FileDialog_method_add_filter: - void **add_filter** **(** :ref:`String` filter **)** Add a custom filter. Example: ``add_filter("*.png ; PNG Images")`` -.. _class_FileDialog_clear_filters: +.. _class_FileDialog_method_clear_filters: - void **clear_filters** **(** **)** Clear all the added filters in the dialog. -.. _class_FileDialog_deselect_items: +.. _class_FileDialog_method_deselect_items: - void **deselect_items** **(** **)** Clear currently selected items in the dialog. -.. _class_FileDialog_get_line_edit: +.. _class_FileDialog_method_get_line_edit: - :ref:`LineEdit` **get_line_edit** **(** **)** Returns the LineEdit for the selected file. -.. _class_FileDialog_get_vbox: +.. _class_FileDialog_method_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** Return the vertical box container of the dialog, custom controls can be added to it. -.. _class_FileDialog_invalidate: +.. _class_FileDialog_method_invalidate: - void **invalidate** **(** **)** diff --git a/classes/class_float.rst b/classes/class_float.rst index 0c9083c16..6f1f43508 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -17,13 +17,13 @@ Float built-in type Methods ------- -+----------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** | -+----------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`int` from **)** | -+----------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`String` from **)** | -+----------------------------+------------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`int` from **)** | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`String` from **)** | ++---------------------------+-------------------------------------------------------------------------------------+ Description ----------- @@ -33,20 +33,16 @@ Float built-in type. Method Descriptions ------------------- -.. _class_float_float: +.. _class_float_method_float: - :ref:`float` **float** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to a floating point value, ``float(true)`` will be equal to 1.0 and ``float(false)`` will be equal to 0.0. -.. _class_float_float: - - :ref:`float` **float** **(** :ref:`int` from **)** Cast an :ref:`int` value to a floating point value, ``float(1)`` will be equal to 1.0. -.. _class_float_float: - - :ref:`float` **float** **(** :ref:`String` from **)** 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. diff --git a/classes/class_font.rst b/classes/class_font.rst index 20c861477..2c4fa3d6c 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -21,25 +21,25 @@ Internationalized font and text drawing support. 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:`float` | :ref:`get_descent` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** 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:`float` | :ref:`get_descent` **(** **)** const | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_outline` **(** **)** const | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_changes` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,51 +49,51 @@ Font contains a unicode compatible character set, as well as the ability to draw Method Descriptions ------------------- -.. _class_Font_draw: +.. _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 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. -.. _class_Font_draw_char: +.. _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 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. -.. _class_Font_get_ascent: +.. _class_Font_method_get_ascent: - :ref:`float` **get_ascent** **(** **)** const Return the font ascent (number of pixels above the baseline). -.. _class_Font_get_descent: +.. _class_Font_method_get_descent: - :ref:`float` **get_descent** **(** **)** const Return the font descent (number of pixels below the baseline). -.. _class_Font_get_height: +.. _class_Font_method_get_height: - :ref:`float` **get_height** **(** **)** const Return the total font height (ascent plus descent) in pixels. -.. _class_Font_get_string_size: +.. _class_Font_method_get_string_size: - :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** const Return the size of a string, taking kerning and advance into account. -.. _class_Font_has_outline: +.. _class_Font_method_has_outline: - :ref:`bool` **has_outline** **(** **)** const -.. _class_Font_is_distance_field_hint: +.. _class_Font_method_is_distance_field_hint: - :ref:`bool` **is_distance_field_hint** **(** **)** const -.. _class_Font_update_changes: +.. _class_Font_method_update_changes: - void **update_changes** **(** **)** diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index 94b0f7e29..4d476ccfc 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -19,37 +19,37 @@ Reference to a function in an object. Methods ------- -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_func` **(** **)** vararg | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function` **(** :ref:`String` name **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_func` **(** **)** vararg | ++-------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function` **(** :ref:`String` name **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------+ Description ----------- In GDScript, functions are not *first-class objects*. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments. -However, by creating a ``FuncRef`` using the :ref:`@GDScript.funcref` function, a reference to a function in a given object can be created, passed around and called. +However, by creating a ``FuncRef`` using the :ref:`@GDScript.funcref` function, a reference to a function in a given object can be created, passed around and called. Method Descriptions ------------------- -.. _class_FuncRef_call_func: +.. _class_FuncRef_method_call_func: - :ref:`Variant` **call_func** **(** **)** vararg -Calls the referenced function previously set by :ref:`set_function` or :ref:`@GDScript.funcref`. +Calls the referenced function previously set by :ref:`set_function` or :ref:`@GDScript.funcref`. -.. _class_FuncRef_set_function: +.. _class_FuncRef_method_set_function: - void **set_function** **(** :ref:`String` name **)** The name of the referenced function to call on the object, without parentheses or any parameters. -.. _class_FuncRef_set_instance: +.. _class_FuncRef_method_set_instance: - void **set_instance** **(** :ref:`Object` instance **)** diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index c33f098e3..02d7cc59a 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -19,25 +19,25 @@ Brief Description Properties ---------- -+-----------------------------------------------+----------------------------------------+ -| :ref:`GDNativeLibrary` | :ref:`library` | -+-----------------------------------------------+----------------------------------------+ ++-----------------------------------------------+-------------------------------------------------+ +| :ref:`GDNativeLibrary` | :ref:`library` | ++-----------------------------------------------+-------------------------------------------------+ Methods ------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`initialize` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`terminate` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`terminate` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_GDNative_library: +.. _class_GDNative_property_library: - :ref:`GDNativeLibrary` **library** @@ -50,15 +50,15 @@ Property Descriptions Method Descriptions ------------------- -.. _class_GDNative_call_native: +.. _class_GDNative_method_call_native: - :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** -.. _class_GDNative_initialize: +.. _class_GDNative_method_initialize: - :ref:`bool` **initialize** **(** **)** -.. _class_GDNative_terminate: +.. _class_GDNative_method_terminate: - :ref:`bool` **terminate** **(** **)** diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index 436f68b38..273c84b30 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -19,31 +19,31 @@ Brief Description Properties ---------- -+-------------------------------------+-----------------------------------------------------------+ -| :ref:`ConfigFile` | :ref:`config_file` | -+-------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`load_once` | -+-------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`reloadable` | -+-------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`singleton` | -+-------------------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`symbol_prefix` | -+-------------------------------------+-----------------------------------------------------------+ ++-------------------------------------+--------------------------------------------------------------------+ +| :ref:`ConfigFile` | :ref:`config_file` | ++-------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`load_once` | ++-------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reloadable` | ++-------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`singleton` | ++-------------------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`symbol_prefix` | ++-------------------------------------+--------------------------------------------------------------------+ 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 --------------------- -.. _class_GDNativeLibrary_config_file: +.. _class_GDNativeLibrary_property_config_file: - :ref:`ConfigFile` **config_file** @@ -53,7 +53,7 @@ Property Descriptions | *Getter* | get_config_file() | +----------+------------------------+ -.. _class_GDNativeLibrary_load_once: +.. _class_GDNativeLibrary_property_load_once: - :ref:`bool` **load_once** @@ -63,7 +63,7 @@ Property Descriptions | *Getter* | should_load_once() | +----------+----------------------+ -.. _class_GDNativeLibrary_reloadable: +.. _class_GDNativeLibrary_property_reloadable: - :ref:`bool` **reloadable** @@ -73,7 +73,7 @@ Property Descriptions | *Getter* | is_reloadable() | +----------+-----------------------+ -.. _class_GDNativeLibrary_singleton: +.. _class_GDNativeLibrary_property_singleton: - :ref:`bool` **singleton** @@ -83,7 +83,7 @@ Property Descriptions | *Getter* | is_singleton() | +----------+----------------------+ -.. _class_GDNativeLibrary_symbol_prefix: +.. _class_GDNativeLibrary_property_symbol_prefix: - :ref:`String` **symbol_prefix** @@ -96,11 +96,11 @@ Property Descriptions Method Descriptions ------------------- -.. _class_GDNativeLibrary_get_current_dependencies: +.. _class_GDNativeLibrary_method_get_current_dependencies: - :ref:`PoolStringArray` **get_current_dependencies** **(** **)** const -.. _class_GDNativeLibrary_get_current_library_path: +.. _class_GDNativeLibrary_method_get_current_library_path: - :ref:`String` **get_current_library_path** **(** **)** const diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index aebcbc2fa..1d231f6a1 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -19,18 +19,18 @@ A script implemented in the GDScript programming language. Methods ------- -+--------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** const | -+--------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+--------------------------------------------+----------------------------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** const | ++-------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++-------------------------------------------+-----------------------------------------------------------------------------------+ Description ----------- A script implemented in the GDScript programming language. The script exends the functionality of all objects that instance it. -:ref:`new` creates a new instance of the script. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. +:ref:`new` creates a new instance of the script. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. Tutorials --------- @@ -40,13 +40,13 @@ Tutorials Method Descriptions ------------------- -.. _class_GDScript_get_as_byte_code: +.. _class_GDScript_method_get_as_byte_code: - :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const Returns byte code for the script source code. -.. _class_GDScript_new: +.. _class_GDScript_method_new: - :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_gdscriptfunctionstate.rst b/classes/class_gdscriptfunctionstate.rst index 7a5471b0d..4003ba8ea 100644 --- a/classes/class_gdscriptfunctionstate.rst +++ b/classes/class_gdscriptfunctionstate.rst @@ -19,42 +19,42 @@ State of a function call after yielding. 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 ------- -.. _class_GDScriptFunctionState_completed: +.. _class_GDScriptFunctionState_signal_completed: - **completed** **(** :ref:`Nil` result **)** Description ----------- -Calling :ref:`@GDScript.yield` within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling :ref:`resume` on this state object. +Calling :ref:`@GDScript.yield` within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling :ref:`resume` on this state object. Method Descriptions ------------------- -.. _class_GDScriptFunctionState_is_valid: +.. _class_GDScriptFunctionState_method_is_valid: - :ref:`bool` **is_valid** **(** :ref:`bool` extended_check=false **)** const Check whether the function call may be resumed. This is not the case if the function state was already resumed. -If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`GDScriptFunctionState.resume`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. +If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`resume`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. -.. _class_GDScriptFunctionState_resume: +.. _class_GDScriptFunctionState_method_resume: - :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** Resume execution of the yielded function call. -If handed an argument, return the argument from the :ref:`@GDScript.yield` call in the yielded function call. You can pass e.g. an :ref:`Array` to hand multiple arguments. +If handed an argument, return the argument from the :ref:`@GDScript.yield` call in the yielded function call. You can pass e.g. an :ref:`Array` to hand multiple arguments. This function returns what the resumed function call returns, possibly another function state if yielded again. diff --git a/classes/class_gdscriptnativeclass.rst b/classes/class_gdscriptnativeclass.rst index f83baaa38..f1ab1bb9a 100644 --- a/classes/class_gdscriptnativeclass.rst +++ b/classes/class_gdscriptnativeclass.rst @@ -19,14 +19,14 @@ Brief Description Methods ------- -+--------------------------------+-------------------------------------------------------+ -| :ref:`Variant` | :ref:`new` **(** **)** | -+--------------------------------+-------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** **)** | ++-------------------------------+--------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_GDScriptNativeClass_new: +.. _class_GDScriptNativeClass_method_new: - :ref:`Variant` **new** **(** **)** diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index d9fb8d04c..434b3cd7d 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -19,183 +19,217 @@ The generic 6 degrees of freedom joint can implement a variety of joint-types by Properties ---------- -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_limit_x/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/erp` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/force_limit` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/lower_angle` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/restitution` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/softness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_x/upper_angle` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_limit_y/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/erp` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/force_limit` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/lower_angle` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/restitution` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/softness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_y/upper_angle` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_limit_z/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/erp` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/force_limit` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/lower_angle` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/restitution` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/softness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit_z/upper_angle` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_motor_x/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_x/force_limit` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_x/target_velocity` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_motor_y/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_y/force_limit` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_y/target_velocity` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_motor_z/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_z/force_limit` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motor_z/target_velocity` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_x/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_spring_x/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_x/equilibrium_point` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_x/stiffness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_y/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_spring_y/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_y/equilibrium_point` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_y/stiffness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_z/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_spring_z/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_z/equilibrium_point` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_spring_z/stiffness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_limit_x/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/lower_distance` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/restitution` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/softness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_x/upper_distance` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_limit_y/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/lower_distance` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/restitution` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/softness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_y/upper_distance` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_limit_z/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/lower_distance` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/restitution` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/softness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit_z/upper_distance` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_motor_x/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_x/force_limit` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_x/target_velocity` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_motor_y/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_y/force_limit` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_y/target_velocity` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_motor_z/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_z/force_limit` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motor_z/target_velocity` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_x/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_spring_x/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_x/equilibrium_point` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_x/stiffness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_y/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_spring_y/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_y/equilibrium_point` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_y/stiffness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_z/damping` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`linear_spring_z/enabled` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_z/equilibrium_point` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_spring_z/stiffness` | -+---------------------------+------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`precision` | -+---------------------------+------------------------------------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_x/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_limit_x/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_x/erp` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_x/force_limit` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_x/lower_angle` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_x/restitution` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_x/softness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_x/upper_angle` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_y/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_limit_y/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_y/erp` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_y/force_limit` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_y/lower_angle` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_y/restitution` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_y/softness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_y/upper_angle` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_z/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_limit_z/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_z/erp` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_z/force_limit` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_z/lower_angle` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_z/restitution` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_z/softness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit_z/upper_angle` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_motor_x/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_motor_x/force_limit` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_motor_x/target_velocity` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_motor_y/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_motor_y/force_limit` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_motor_y/target_velocity` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_motor_z/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_motor_z/force_limit` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_motor_z/target_velocity` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_spring_x/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_spring_x/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_spring_x/equilibrium_point` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_spring_x/stiffness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_spring_y/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_spring_y/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_spring_y/equilibrium_point` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_spring_y/stiffness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_spring_z/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_spring_z/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_spring_z/equilibrium_point` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_spring_z/stiffness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_x/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`linear_limit_x/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_x/lower_distance` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_x/restitution` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_x/softness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_x/upper_distance` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_y/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`linear_limit_y/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_y/lower_distance` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_y/restitution` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_y/softness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_y/upper_distance` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_z/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`linear_limit_z/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_z/lower_distance` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_z/restitution` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_z/softness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit_z/upper_distance` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`linear_motor_x/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_motor_x/force_limit` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_motor_x/target_velocity` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`linear_motor_y/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_motor_y/force_limit` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_motor_y/target_velocity` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`linear_motor_z/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_motor_z/force_limit` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_motor_z/target_velocity` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_spring_x/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`linear_spring_x/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_spring_x/equilibrium_point` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_spring_x/stiffness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_spring_y/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`linear_spring_y/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_spring_y/equilibrium_point` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_spring_y/stiffness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_spring_z/damping` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`linear_spring_z/enabled` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_spring_z/equilibrium_point` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_spring_z/stiffness` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`precision` | ++---------------------------+---------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Generic6DOFJoint_Param: +.. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LOWER_LIMIT: + +.. _class_Generic6DOFJoint_constant_PARAM_LINEAR_UPPER_LIMIT: + +.. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LIMIT_SOFTNESS: + +.. _class_Generic6DOFJoint_constant_PARAM_LINEAR_RESTITUTION: + +.. _class_Generic6DOFJoint_constant_PARAM_LINEAR_DAMPING: + +.. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_TARGET_VELOCITY: + +.. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_FORCE_LIMIT: + +.. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LOWER_LIMIT: + +.. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_UPPER_LIMIT: + +.. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LIMIT_SOFTNESS: + +.. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_DAMPING: + +.. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_RESTITUTION: + +.. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_FORCE_LIMIT: + +.. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_ERP: + +.. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_TARGET_VELOCITY: + +.. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_FORCE_LIMIT: + +.. _class_Generic6DOFJoint_constant_PARAM_MAX: + enum **Param**: - **PARAM_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes. @@ -234,6 +268,20 @@ enum **Param**: .. _enum_Generic6DOFJoint_Flag: +.. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_LIMIT: + +.. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_LIMIT: + +.. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_SPRING: + +.. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_SPRING: + +.. _class_Generic6DOFJoint_constant_FLAG_ENABLE_MOTOR: + +.. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_MOTOR: + +.. _class_Generic6DOFJoint_constant_FLAG_MAX: + enum **Flag**: - **FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. @@ -258,7 +306,7 @@ The first 3 DOF axes are linear axes, which represent translation of Bodies, and Property Descriptions --------------------- -.. _class_Generic6DOFJoint_angular_limit_x/damping: +.. _class_Generic6DOFJoint_property_angular_limit_x/damping: - :ref:`float` **angular_limit_x/damping** @@ -272,7 +320,7 @@ The amount of rotational damping across the x-axis. The lower, the longer an impulse from one side takes to travel to the other side. -.. _class_Generic6DOFJoint_angular_limit_x/enabled: +.. _class_Generic6DOFJoint_property_angular_limit_x/enabled: - :ref:`bool` **angular_limit_x/enabled** @@ -284,7 +332,7 @@ The lower, the longer an impulse from one side takes to travel to the other side If ``true``, rotation across the x-axis is limited. -.. _class_Generic6DOFJoint_angular_limit_x/erp: +.. _class_Generic6DOFJoint_property_angular_limit_x/erp: - :ref:`float` **angular_limit_x/erp** @@ -296,7 +344,7 @@ If ``true``, rotation across the x-axis is limited. When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. -.. _class_Generic6DOFJoint_angular_limit_x/force_limit: +.. _class_Generic6DOFJoint_property_angular_limit_x/force_limit: - :ref:`float` **angular_limit_x/force_limit** @@ -308,13 +356,13 @@ When rotating across x-axis, this error tolerance factor defines how much the co The maximum amount of force that can occur, when rotating around x-axis. -.. _class_Generic6DOFJoint_angular_limit_x/lower_angle: +.. _class_Generic6DOFJoint_property_angular_limit_x/lower_angle: - :ref:`float` **angular_limit_x/lower_angle** The minimum rotation in negative direction to break loose and rotate around the x-axis. -.. _class_Generic6DOFJoint_angular_limit_x/restitution: +.. _class_Generic6DOFJoint_property_angular_limit_x/restitution: - :ref:`float` **angular_limit_x/restitution** @@ -326,7 +374,7 @@ The minimum rotation in negative direction to break loose and rotate around the The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. -.. _class_Generic6DOFJoint_angular_limit_x/softness: +.. _class_Generic6DOFJoint_property_angular_limit_x/softness: - :ref:`float` **angular_limit_x/softness** @@ -338,13 +386,13 @@ The amount of rotational restitution across the x-axis. The lower, the more rest The speed of all rotations across the x-axis. -.. _class_Generic6DOFJoint_angular_limit_x/upper_angle: +.. _class_Generic6DOFJoint_property_angular_limit_x/upper_angle: - :ref:`float` **angular_limit_x/upper_angle** The minimum rotation in positive direction to break loose and rotate around the x-axis. -.. _class_Generic6DOFJoint_angular_limit_y/damping: +.. _class_Generic6DOFJoint_property_angular_limit_y/damping: - :ref:`float` **angular_limit_y/damping** @@ -356,7 +404,7 @@ The minimum rotation in positive direction to break loose and rotate around the The amount of rotational damping across the y-axis. The lower, the more dampening occurs. -.. _class_Generic6DOFJoint_angular_limit_y/enabled: +.. _class_Generic6DOFJoint_property_angular_limit_y/enabled: - :ref:`bool` **angular_limit_y/enabled** @@ -368,7 +416,7 @@ The amount of rotational damping across the y-axis. The lower, the more dampenin If ``true``, rotation across the y-axis is limited. -.. _class_Generic6DOFJoint_angular_limit_y/erp: +.. _class_Generic6DOFJoint_property_angular_limit_y/erp: - :ref:`float` **angular_limit_y/erp** @@ -380,7 +428,7 @@ If ``true``, rotation across the y-axis is limited. When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. -.. _class_Generic6DOFJoint_angular_limit_y/force_limit: +.. _class_Generic6DOFJoint_property_angular_limit_y/force_limit: - :ref:`float` **angular_limit_y/force_limit** @@ -392,13 +440,13 @@ When rotating across y-axis, this error tolerance factor defines how much the co The maximum amount of force that can occur, when rotating around y-axis. -.. _class_Generic6DOFJoint_angular_limit_y/lower_angle: +.. _class_Generic6DOFJoint_property_angular_limit_y/lower_angle: - :ref:`float` **angular_limit_y/lower_angle** The minimum rotation in negative direction to break loose and rotate around the y-axis. -.. _class_Generic6DOFJoint_angular_limit_y/restitution: +.. _class_Generic6DOFJoint_property_angular_limit_y/restitution: - :ref:`float` **angular_limit_y/restitution** @@ -410,7 +458,7 @@ The minimum rotation in negative direction to break loose and rotate around the The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. -.. _class_Generic6DOFJoint_angular_limit_y/softness: +.. _class_Generic6DOFJoint_property_angular_limit_y/softness: - :ref:`float` **angular_limit_y/softness** @@ -422,13 +470,13 @@ The amount of rotational restitution across the y-axis. The lower, the more rest The speed of all rotations across the y-axis. -.. _class_Generic6DOFJoint_angular_limit_y/upper_angle: +.. _class_Generic6DOFJoint_property_angular_limit_y/upper_angle: - :ref:`float` **angular_limit_y/upper_angle** The minimum rotation in positive direction to break loose and rotate around the y-axis. -.. _class_Generic6DOFJoint_angular_limit_z/damping: +.. _class_Generic6DOFJoint_property_angular_limit_z/damping: - :ref:`float` **angular_limit_z/damping** @@ -440,7 +488,7 @@ The minimum rotation in positive direction to break loose and rotate around the The amount of rotational damping across the z-axis. The lower, the more dampening occurs. -.. _class_Generic6DOFJoint_angular_limit_z/enabled: +.. _class_Generic6DOFJoint_property_angular_limit_z/enabled: - :ref:`bool` **angular_limit_z/enabled** @@ -452,7 +500,7 @@ The amount of rotational damping across the z-axis. The lower, the more dampenin If ``true``, rotation across the z-axis is limited. -.. _class_Generic6DOFJoint_angular_limit_z/erp: +.. _class_Generic6DOFJoint_property_angular_limit_z/erp: - :ref:`float` **angular_limit_z/erp** @@ -464,7 +512,7 @@ If ``true``, rotation across the z-axis is limited. When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. -.. _class_Generic6DOFJoint_angular_limit_z/force_limit: +.. _class_Generic6DOFJoint_property_angular_limit_z/force_limit: - :ref:`float` **angular_limit_z/force_limit** @@ -476,13 +524,13 @@ When rotating across z-axis, this error tolerance factor defines how much the co The maximum amount of force that can occur, when rotating around z-axis. -.. _class_Generic6DOFJoint_angular_limit_z/lower_angle: +.. _class_Generic6DOFJoint_property_angular_limit_z/lower_angle: - :ref:`float` **angular_limit_z/lower_angle** The minimum rotation in negative direction to break loose and rotate around the z-axis. -.. _class_Generic6DOFJoint_angular_limit_z/restitution: +.. _class_Generic6DOFJoint_property_angular_limit_z/restitution: - :ref:`float` **angular_limit_z/restitution** @@ -494,7 +542,7 @@ The minimum rotation in negative direction to break loose and rotate around the The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. -.. _class_Generic6DOFJoint_angular_limit_z/softness: +.. _class_Generic6DOFJoint_property_angular_limit_z/softness: - :ref:`float` **angular_limit_z/softness** @@ -506,13 +554,13 @@ The amount of rotational restitution across the z-axis. The lower, the more rest The speed of all rotations across the z-axis. -.. _class_Generic6DOFJoint_angular_limit_z/upper_angle: +.. _class_Generic6DOFJoint_property_angular_limit_z/upper_angle: - :ref:`float` **angular_limit_z/upper_angle** The minimum rotation in positive direction to break loose and rotate around the z-axis. -.. _class_Generic6DOFJoint_angular_motor_x/enabled: +.. _class_Generic6DOFJoint_property_angular_motor_x/enabled: - :ref:`bool` **angular_motor_x/enabled** @@ -524,7 +572,7 @@ The minimum rotation in positive direction to break loose and rotate around the If ``true``, a rotating motor at the x-axis is enabled. -.. _class_Generic6DOFJoint_angular_motor_x/force_limit: +.. _class_Generic6DOFJoint_property_angular_motor_x/force_limit: - :ref:`float` **angular_motor_x/force_limit** @@ -536,7 +584,7 @@ If ``true``, a rotating motor at the x-axis is enabled. Maximum acceleration for the motor at the x-axis. -.. _class_Generic6DOFJoint_angular_motor_x/target_velocity: +.. _class_Generic6DOFJoint_property_angular_motor_x/target_velocity: - :ref:`float` **angular_motor_x/target_velocity** @@ -548,7 +596,7 @@ Maximum acceleration for the motor at the x-axis. Target speed for the motor at the x-axis. -.. _class_Generic6DOFJoint_angular_motor_y/enabled: +.. _class_Generic6DOFJoint_property_angular_motor_y/enabled: - :ref:`bool` **angular_motor_y/enabled** @@ -560,7 +608,7 @@ Target speed for the motor at the x-axis. If ``true``, a rotating motor at the y-axis is enabled. -.. _class_Generic6DOFJoint_angular_motor_y/force_limit: +.. _class_Generic6DOFJoint_property_angular_motor_y/force_limit: - :ref:`float` **angular_motor_y/force_limit** @@ -572,7 +620,7 @@ If ``true``, a rotating motor at the y-axis is enabled. Maximum acceleration for the motor at the y-axis. -.. _class_Generic6DOFJoint_angular_motor_y/target_velocity: +.. _class_Generic6DOFJoint_property_angular_motor_y/target_velocity: - :ref:`float` **angular_motor_y/target_velocity** @@ -584,7 +632,7 @@ Maximum acceleration for the motor at the y-axis. Target speed for the motor at the y-axis. -.. _class_Generic6DOFJoint_angular_motor_z/enabled: +.. _class_Generic6DOFJoint_property_angular_motor_z/enabled: - :ref:`bool` **angular_motor_z/enabled** @@ -596,7 +644,7 @@ Target speed for the motor at the y-axis. If ``true``, a rotating motor at the z-axis is enabled. -.. _class_Generic6DOFJoint_angular_motor_z/force_limit: +.. _class_Generic6DOFJoint_property_angular_motor_z/force_limit: - :ref:`float` **angular_motor_z/force_limit** @@ -608,7 +656,7 @@ If ``true``, a rotating motor at the z-axis is enabled. Maximum acceleration for the motor at the z-axis. -.. _class_Generic6DOFJoint_angular_motor_z/target_velocity: +.. _class_Generic6DOFJoint_property_angular_motor_z/target_velocity: - :ref:`float` **angular_motor_z/target_velocity** @@ -620,7 +668,7 @@ Maximum acceleration for the motor at the z-axis. Target speed for the motor at the z-axis. -.. _class_Generic6DOFJoint_angular_spring_x/damping: +.. _class_Generic6DOFJoint_property_angular_spring_x/damping: - :ref:`float` **angular_spring_x/damping** @@ -630,7 +678,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ -.. _class_Generic6DOFJoint_angular_spring_x/enabled: +.. _class_Generic6DOFJoint_property_angular_spring_x/enabled: - :ref:`bool` **angular_spring_x/enabled** @@ -640,7 +688,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_flag_x() | +----------+-------------------+ -.. _class_Generic6DOFJoint_angular_spring_x/equilibrium_point: +.. _class_Generic6DOFJoint_property_angular_spring_x/equilibrium_point: - :ref:`float` **angular_spring_x/equilibrium_point** @@ -650,7 +698,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ -.. _class_Generic6DOFJoint_angular_spring_x/stiffness: +.. _class_Generic6DOFJoint_property_angular_spring_x/stiffness: - :ref:`float` **angular_spring_x/stiffness** @@ -660,7 +708,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ -.. _class_Generic6DOFJoint_angular_spring_y/damping: +.. _class_Generic6DOFJoint_property_angular_spring_y/damping: - :ref:`float` **angular_spring_y/damping** @@ -670,7 +718,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ -.. _class_Generic6DOFJoint_angular_spring_y/enabled: +.. _class_Generic6DOFJoint_property_angular_spring_y/enabled: - :ref:`bool` **angular_spring_y/enabled** @@ -680,7 +728,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_flag_y() | +----------+-------------------+ -.. _class_Generic6DOFJoint_angular_spring_y/equilibrium_point: +.. _class_Generic6DOFJoint_property_angular_spring_y/equilibrium_point: - :ref:`float` **angular_spring_y/equilibrium_point** @@ -690,7 +738,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ -.. _class_Generic6DOFJoint_angular_spring_y/stiffness: +.. _class_Generic6DOFJoint_property_angular_spring_y/stiffness: - :ref:`float` **angular_spring_y/stiffness** @@ -700,7 +748,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ -.. _class_Generic6DOFJoint_angular_spring_z/damping: +.. _class_Generic6DOFJoint_property_angular_spring_z/damping: - :ref:`float` **angular_spring_z/damping** @@ -710,7 +758,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ -.. _class_Generic6DOFJoint_angular_spring_z/enabled: +.. _class_Generic6DOFJoint_property_angular_spring_z/enabled: - :ref:`bool` **angular_spring_z/enabled** @@ -720,7 +768,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_flag_z() | +----------+-------------------+ -.. _class_Generic6DOFJoint_angular_spring_z/equilibrium_point: +.. _class_Generic6DOFJoint_property_angular_spring_z/equilibrium_point: - :ref:`float` **angular_spring_z/equilibrium_point** @@ -730,7 +778,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ -.. _class_Generic6DOFJoint_angular_spring_z/stiffness: +.. _class_Generic6DOFJoint_property_angular_spring_z/stiffness: - :ref:`float` **angular_spring_z/stiffness** @@ -740,7 +788,7 @@ Target speed for the motor at the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ -.. _class_Generic6DOFJoint_linear_limit_x/damping: +.. _class_Generic6DOFJoint_property_linear_limit_x/damping: - :ref:`float` **linear_limit_x/damping** @@ -752,7 +800,7 @@ Target speed for the motor at the z-axis. The amount of damping that happens at the x-motion. -.. _class_Generic6DOFJoint_linear_limit_x/enabled: +.. _class_Generic6DOFJoint_property_linear_limit_x/enabled: - :ref:`bool` **linear_limit_x/enabled** @@ -764,7 +812,7 @@ The amount of damping that happens at the x-motion. If ``true``, the linear motion across the x-axis is limited. -.. _class_Generic6DOFJoint_linear_limit_x/lower_distance: +.. _class_Generic6DOFJoint_property_linear_limit_x/lower_distance: - :ref:`float` **linear_limit_x/lower_distance** @@ -776,7 +824,7 @@ If ``true``, the linear motion across the x-axis is limited. The minimum difference between the pivot points' x-axis. -.. _class_Generic6DOFJoint_linear_limit_x/restitution: +.. _class_Generic6DOFJoint_property_linear_limit_x/restitution: - :ref:`float` **linear_limit_x/restitution** @@ -788,7 +836,7 @@ The minimum difference between the pivot points' x-axis. The amount of restitution on the x-axis movement The lower, the more momentum gets lost. -.. _class_Generic6DOFJoint_linear_limit_x/softness: +.. _class_Generic6DOFJoint_property_linear_limit_x/softness: - :ref:`float` **linear_limit_x/softness** @@ -800,7 +848,7 @@ The amount of restitution on the x-axis movement The lower, the more momentum ge A factor applied to the movement across the x-axis The lower, the slower the movement. -.. _class_Generic6DOFJoint_linear_limit_x/upper_distance: +.. _class_Generic6DOFJoint_property_linear_limit_x/upper_distance: - :ref:`float` **linear_limit_x/upper_distance** @@ -812,7 +860,7 @@ A factor applied to the movement across the x-axis The lower, the slower the mov The maximum difference between the pivot points' x-axis. -.. _class_Generic6DOFJoint_linear_limit_y/damping: +.. _class_Generic6DOFJoint_property_linear_limit_y/damping: - :ref:`float` **linear_limit_y/damping** @@ -824,7 +872,7 @@ The maximum difference between the pivot points' x-axis. The amount of damping that happens at the y-motion. -.. _class_Generic6DOFJoint_linear_limit_y/enabled: +.. _class_Generic6DOFJoint_property_linear_limit_y/enabled: - :ref:`bool` **linear_limit_y/enabled** @@ -836,7 +884,7 @@ The amount of damping that happens at the y-motion. If ``true``, the linear motion across the y-axis is limited. -.. _class_Generic6DOFJoint_linear_limit_y/lower_distance: +.. _class_Generic6DOFJoint_property_linear_limit_y/lower_distance: - :ref:`float` **linear_limit_y/lower_distance** @@ -848,7 +896,7 @@ If ``true``, the linear motion across the y-axis is limited. The minimum difference between the pivot points' y-axis. -.. _class_Generic6DOFJoint_linear_limit_y/restitution: +.. _class_Generic6DOFJoint_property_linear_limit_y/restitution: - :ref:`float` **linear_limit_y/restitution** @@ -860,7 +908,7 @@ The minimum difference between the pivot points' y-axis. The amount of restitution on the y-axis movement The lower, the more momentum gets lost. -.. _class_Generic6DOFJoint_linear_limit_y/softness: +.. _class_Generic6DOFJoint_property_linear_limit_y/softness: - :ref:`float` **linear_limit_y/softness** @@ -872,7 +920,7 @@ The amount of restitution on the y-axis movement The lower, the more momentum ge A factor applied to the movement across the y-axis The lower, the slower the movement. -.. _class_Generic6DOFJoint_linear_limit_y/upper_distance: +.. _class_Generic6DOFJoint_property_linear_limit_y/upper_distance: - :ref:`float` **linear_limit_y/upper_distance** @@ -884,7 +932,7 @@ A factor applied to the movement across the y-axis The lower, the slower the mov The maximum difference between the pivot points' y-axis. -.. _class_Generic6DOFJoint_linear_limit_z/damping: +.. _class_Generic6DOFJoint_property_linear_limit_z/damping: - :ref:`float` **linear_limit_z/damping** @@ -896,7 +944,7 @@ The maximum difference between the pivot points' y-axis. The amount of damping that happens at the z-motion. -.. _class_Generic6DOFJoint_linear_limit_z/enabled: +.. _class_Generic6DOFJoint_property_linear_limit_z/enabled: - :ref:`bool` **linear_limit_z/enabled** @@ -908,7 +956,7 @@ The amount of damping that happens at the z-motion. If ``true``, the linear motion across the z-axis is limited. -.. _class_Generic6DOFJoint_linear_limit_z/lower_distance: +.. _class_Generic6DOFJoint_property_linear_limit_z/lower_distance: - :ref:`float` **linear_limit_z/lower_distance** @@ -920,7 +968,7 @@ If ``true``, the linear motion across the z-axis is limited. The minimum difference between the pivot points' z-axis. -.. _class_Generic6DOFJoint_linear_limit_z/restitution: +.. _class_Generic6DOFJoint_property_linear_limit_z/restitution: - :ref:`float` **linear_limit_z/restitution** @@ -932,7 +980,7 @@ The minimum difference between the pivot points' z-axis. The amount of restitution on the z-axis movement The lower, the more momentum gets lost. -.. _class_Generic6DOFJoint_linear_limit_z/softness: +.. _class_Generic6DOFJoint_property_linear_limit_z/softness: - :ref:`float` **linear_limit_z/softness** @@ -944,7 +992,7 @@ The amount of restitution on the z-axis movement The lower, the more momentum ge A factor applied to the movement across the z-axis The lower, the slower the movement. -.. _class_Generic6DOFJoint_linear_limit_z/upper_distance: +.. _class_Generic6DOFJoint_property_linear_limit_z/upper_distance: - :ref:`float` **linear_limit_z/upper_distance** @@ -956,7 +1004,7 @@ A factor applied to the movement across the z-axis The lower, the slower the mov The maximum difference between the pivot points' z-axis. -.. _class_Generic6DOFJoint_linear_motor_x/enabled: +.. _class_Generic6DOFJoint_property_linear_motor_x/enabled: - :ref:`bool` **linear_motor_x/enabled** @@ -968,7 +1016,7 @@ The maximum difference between the pivot points' z-axis. If ``true``, then there is a linear motor on the x-axis. It will attempt to reach the target velocity while staying within the force limits. -.. _class_Generic6DOFJoint_linear_motor_x/force_limit: +.. _class_Generic6DOFJoint_property_linear_motor_x/force_limit: - :ref:`float` **linear_motor_x/force_limit** @@ -980,7 +1028,7 @@ If ``true``, then there is a linear motor on the x-axis. It will attempt to reac The maximum force the linear motor can apply on the x-axis while trying to reach the target velocity. -.. _class_Generic6DOFJoint_linear_motor_x/target_velocity: +.. _class_Generic6DOFJoint_property_linear_motor_x/target_velocity: - :ref:`float` **linear_motor_x/target_velocity** @@ -992,7 +1040,7 @@ The maximum force the linear motor can apply on the x-axis while trying to reach The speed that the linear motor will attempt to reach on the x-axis. -.. _class_Generic6DOFJoint_linear_motor_y/enabled: +.. _class_Generic6DOFJoint_property_linear_motor_y/enabled: - :ref:`bool` **linear_motor_y/enabled** @@ -1004,7 +1052,7 @@ The speed that the linear motor will attempt to reach on the x-axis. If ``true``, then there is a linear motor on the y-axis. It will attempt to reach the target velocity while staying within the force limits. -.. _class_Generic6DOFJoint_linear_motor_y/force_limit: +.. _class_Generic6DOFJoint_property_linear_motor_y/force_limit: - :ref:`float` **linear_motor_y/force_limit** @@ -1016,7 +1064,7 @@ If ``true``, then there is a linear motor on the y-axis. It will attempt to reac The maximum force the linear motor can apply on the y-axis while trying to reach the target velocity. -.. _class_Generic6DOFJoint_linear_motor_y/target_velocity: +.. _class_Generic6DOFJoint_property_linear_motor_y/target_velocity: - :ref:`float` **linear_motor_y/target_velocity** @@ -1028,7 +1076,7 @@ The maximum force the linear motor can apply on the y-axis while trying to reach The speed that the linear motor will attempt to reach on the y-axis. -.. _class_Generic6DOFJoint_linear_motor_z/enabled: +.. _class_Generic6DOFJoint_property_linear_motor_z/enabled: - :ref:`bool` **linear_motor_z/enabled** @@ -1040,7 +1088,7 @@ The speed that the linear motor will attempt to reach on the y-axis. If ``true``, then there is a linear motor on the z-axis. It will attempt to reach the target velocity while staying within the force limits. -.. _class_Generic6DOFJoint_linear_motor_z/force_limit: +.. _class_Generic6DOFJoint_property_linear_motor_z/force_limit: - :ref:`float` **linear_motor_z/force_limit** @@ -1052,7 +1100,7 @@ If ``true``, then there is a linear motor on the z-axis. It will attempt to reac The maximum force the linear motor can apply on the z-axis while trying to reach the target velocity. -.. _class_Generic6DOFJoint_linear_motor_z/target_velocity: +.. _class_Generic6DOFJoint_property_linear_motor_z/target_velocity: - :ref:`float` **linear_motor_z/target_velocity** @@ -1064,7 +1112,7 @@ The maximum force the linear motor can apply on the z-axis while trying to reach The speed that the linear motor will attempt to reach on the z-axis. -.. _class_Generic6DOFJoint_linear_spring_x/damping: +.. _class_Generic6DOFJoint_property_linear_spring_x/damping: - :ref:`float` **linear_spring_x/damping** @@ -1074,7 +1122,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ -.. _class_Generic6DOFJoint_linear_spring_x/enabled: +.. _class_Generic6DOFJoint_property_linear_spring_x/enabled: - :ref:`bool` **linear_spring_x/enabled** @@ -1084,7 +1132,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_flag_x() | +----------+-------------------+ -.. _class_Generic6DOFJoint_linear_spring_x/equilibrium_point: +.. _class_Generic6DOFJoint_property_linear_spring_x/equilibrium_point: - :ref:`float` **linear_spring_x/equilibrium_point** @@ -1094,7 +1142,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ -.. _class_Generic6DOFJoint_linear_spring_x/stiffness: +.. _class_Generic6DOFJoint_property_linear_spring_x/stiffness: - :ref:`float` **linear_spring_x/stiffness** @@ -1104,7 +1152,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_x() | +----------+--------------------+ -.. _class_Generic6DOFJoint_linear_spring_y/damping: +.. _class_Generic6DOFJoint_property_linear_spring_y/damping: - :ref:`float` **linear_spring_y/damping** @@ -1114,7 +1162,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ -.. _class_Generic6DOFJoint_linear_spring_y/enabled: +.. _class_Generic6DOFJoint_property_linear_spring_y/enabled: - :ref:`bool` **linear_spring_y/enabled** @@ -1124,7 +1172,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_flag_y() | +----------+-------------------+ -.. _class_Generic6DOFJoint_linear_spring_y/equilibrium_point: +.. _class_Generic6DOFJoint_property_linear_spring_y/equilibrium_point: - :ref:`float` **linear_spring_y/equilibrium_point** @@ -1134,7 +1182,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ -.. _class_Generic6DOFJoint_linear_spring_y/stiffness: +.. _class_Generic6DOFJoint_property_linear_spring_y/stiffness: - :ref:`float` **linear_spring_y/stiffness** @@ -1144,7 +1192,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_y() | +----------+--------------------+ -.. _class_Generic6DOFJoint_linear_spring_z/damping: +.. _class_Generic6DOFJoint_property_linear_spring_z/damping: - :ref:`float` **linear_spring_z/damping** @@ -1154,7 +1202,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ -.. _class_Generic6DOFJoint_linear_spring_z/enabled: +.. _class_Generic6DOFJoint_property_linear_spring_z/enabled: - :ref:`bool` **linear_spring_z/enabled** @@ -1164,7 +1212,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_flag_z() | +----------+-------------------+ -.. _class_Generic6DOFJoint_linear_spring_z/equilibrium_point: +.. _class_Generic6DOFJoint_property_linear_spring_z/equilibrium_point: - :ref:`float` **linear_spring_z/equilibrium_point** @@ -1174,7 +1222,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ -.. _class_Generic6DOFJoint_linear_spring_z/stiffness: +.. _class_Generic6DOFJoint_property_linear_spring_z/stiffness: - :ref:`float` **linear_spring_z/stiffness** @@ -1184,7 +1232,7 @@ The speed that the linear motor will attempt to reach on the z-axis. | *Getter* | get_param_z() | +----------+--------------------+ -.. _class_Generic6DOFJoint_precision: +.. _class_Generic6DOFJoint_property_precision: - :ref:`int` **precision** diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index f2bc3ce1e..c3d4cfe4c 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -19,188 +19,188 @@ Brief Description Methods ------- -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`Axis` axis=2 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`Axis` axis=2 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`clip_polygon` **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`convex_hull_2d` **(** :ref:`PoolVector2Array` points **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`line_intersects_line_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, Vector3.Axis axis=2 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, Vector3.Axis axis=2 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`clip_polygon` **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`convex_hull_2d` **(** :ref:`PoolVector2Array` points **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`line_intersects_line_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_Geometry_build_box_planes: +.. _class_Geometry_method_build_box_planes: - :ref:`Array` **build_box_planes** **(** :ref:`Vector3` extents **)** Returns an array with 6 :ref:`Plane`\ s that describe the sides of a box centered at the origin. The box size is defined by ``extents``, which represents one (positive) corner of the box (i.e. half its actual size). -.. _class_Geometry_build_capsule_planes: +.. _class_Geometry_method_build_capsule_planes: -- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`Axis` axis=2 **)** +- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, Vector3.Axis axis=2 **)** Returns an array of :ref:`Plane`\ s closely bounding a faceted capsule centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the side part of the capsule, whereas ``lats`` gives the number of latitudinal steps at the bottom and top of the capsule. The parameter ``axis`` describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z). -.. _class_Geometry_build_cylinder_planes: +.. _class_Geometry_method_build_cylinder_planes: -- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`Axis` axis=2 **)** +- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, Vector3.Axis axis=2 **)** Returns an array of :ref:`Plane`\ s closely bounding a faceted cylinder centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the round part of the cylinder. The parameter ``axis`` describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). -.. _class_Geometry_clip_polygon: +.. _class_Geometry_method_clip_polygon: - :ref:`PoolVector3Array` **clip_polygon** **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** Clips the polygon defined by the points in ``points`` against the ``plane`` and returns the points of the clipped polygon. -.. _class_Geometry_convex_hull_2d: +.. _class_Geometry_method_convex_hull_2d: - :ref:`PoolVector2Array` **convex_hull_2d** **(** :ref:`PoolVector2Array` points **)** Given an array of :ref:`Vector2`\ s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one. -.. _class_Geometry_get_closest_point_to_segment: +.. _class_Geometry_method_get_closest_point_to_segment: - :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** Returns the 3d point on the 3d segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. -.. _class_Geometry_get_closest_point_to_segment_2d: +.. _class_Geometry_method_get_closest_point_to_segment_2d: - :ref:`Vector2` **get_closest_point_to_segment_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** Returns the 2d point on the 2d segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. -.. _class_Geometry_get_closest_point_to_segment_uncapped: +.. _class_Geometry_method_get_closest_point_to_segment_uncapped: - :ref:`Vector3` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** Returns the 3d point on the 3d line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. -.. _class_Geometry_get_closest_point_to_segment_uncapped_2d: +.. _class_Geometry_method_get_closest_point_to_segment_uncapped_2d: - :ref:`Vector2` **get_closest_point_to_segment_uncapped_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** Returns the 2d point on the 2d line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. -.. _class_Geometry_get_closest_points_between_segments: +.. _class_Geometry_method_get_closest_points_between_segments: - :ref:`PoolVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** Given the two 3d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector3Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). -.. _class_Geometry_get_closest_points_between_segments_2d: +.. _class_Geometry_method_get_closest_points_between_segments_2d: - :ref:`PoolVector2Array` **get_closest_points_between_segments_2d** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** Given the two 2d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector2Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). -.. _class_Geometry_get_uv84_normal_bit: +.. _class_Geometry_method_get_uv84_normal_bit: - :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** -.. _class_Geometry_line_intersects_line_2d: +.. _class_Geometry_method_line_intersects_line_2d: - :ref:`Variant` **line_intersects_line_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns an empty :ref:`Variant`. Note that the lines are specified using direction vectors, not end points. -.. _class_Geometry_make_atlas: +.. _class_Geometry_method_make_atlas: - :ref:`Dictionary` **make_atlas** **(** :ref:`PoolVector2Array` sizes **)** Given an array of :ref:`Vector2`\ s representing tiles, builds an atlas. The returned dictionary has two keys: ``points`` is a vector of :ref:`Vector2` that specifies the positions of each tile, ``size`` contains the overall size of the whole atlas as :ref:`Vector2`. -.. _class_Geometry_point_is_inside_triangle: +.. _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 Returns if ``point`` is inside the triangle specified by ``a``, ``b`` and ``c``. -.. _class_Geometry_ray_intersects_triangle: +.. _class_Geometry_method_ray_intersects_triangle: - :ref:`Variant` **ray_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** Tests if the 3d ray starting at ``from`` with the direction of ``dir`` intersects the triangle specified by ``a``, ``b`` and ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, an empty :ref:`Variant` is returned. -.. _class_Geometry_segment_intersects_circle: +.. _class_Geometry_method_segment_intersects_circle: - :ref:`float` **segment_intersects_circle** **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** Given the 2d segment (``segment_from``, ``segment_to``), returns the position on the segment (as a number between 0 and 1) at which the segment hits the circle that is located at position ``circle_position`` and has radius ``circle_radius``. If the segment does not intersect the circle, -1 is returned (this is also the case if the line extending the segment would intersect the circle, but the segment does not). -.. _class_Geometry_segment_intersects_convex: +.. _class_Geometry_method_segment_intersects_convex: - :ref:`PoolVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** Given a convex hull defined though the :ref:`Plane`\ s in the array ``planes``, tests if the segment (``from``, ``to``) intersects with that hull. If an intersection is found, returns a :ref:`PoolVector3Array` containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty. -.. _class_Geometry_segment_intersects_cylinder: +.. _class_Geometry_method_segment_intersects_cylinder: - :ref:`PoolVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** Checks if the segment (``from``, ``to``) intersects the cylinder with height ``height`` that is centered at the origin and has radius ``radius``. If no, returns an empty :ref:`PoolVector3Array`. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. -.. _class_Geometry_segment_intersects_segment_2d: +.. _class_Geometry_method_segment_intersects_segment_2d: - :ref:`Variant` **segment_intersects_segment_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns an empty :ref:`Variant`. -.. _class_Geometry_segment_intersects_sphere: +.. _class_Geometry_method_segment_intersects_sphere: - :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** Checks if the segment (``from``, ``to``) intersects the sphere that is located at ``sphere_position`` and has radius ``sphere_radius``. If no, returns an empty :ref:`PoolVector3Array`. If yes, returns a :ref:`PoolVector3Array` containing the point of intersection and the sphere's normal at the point of intersection. -.. _class_Geometry_segment_intersects_triangle: +.. _class_Geometry_method_segment_intersects_triangle: - :ref:`Variant` **segment_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, an empty :ref:`Variant` is returned. -.. _class_Geometry_triangulate_polygon: +.. _class_Geometry_method_triangulate_polygon: - :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 7a3ba47c0..75dda39fa 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -21,29 +21,37 @@ Base node for geometry based visual instances. Properties ---------- -+-------------------------------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`ShadowCastingSetting` | :ref:`cast_shadow` | -+-------------------------------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`extra_cull_margin` | -+-------------------------------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`lod_max_distance` | -+-------------------------------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`lod_max_hysteresis` | -+-------------------------------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`lod_min_distance` | -+-------------------------------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`lod_min_hysteresis` | -+-------------------------------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`Material` | :ref:`material_override` | -+-------------------------------------------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_in_baked_light` | -+-------------------------------------------------------------------------+----------------------------------------------------------------------+ ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`ShadowCastingSetting` | :ref:`cast_shadow` | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`extra_cull_margin` | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lod_max_distance` | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lod_max_hysteresis` | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lod_min_distance` | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lod_min_hysteresis` | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`material_override` | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_in_baked_light` | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_GeometryInstance_ShadowCastingSetting: +.. _class_GeometryInstance_constant_SHADOW_CASTING_SETTING_OFF: + +.. _class_GeometryInstance_constant_SHADOW_CASTING_SETTING_ON: + +.. _class_GeometryInstance_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED: + +.. _class_GeometryInstance_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY: + enum **ShadowCastingSetting**: - **SHADOW_CASTING_SETTING_OFF** = **0** --- Will not cast any shadows. @@ -62,6 +70,10 @@ In other words: The actual mesh will not be visible, only the shadows casted fro .. _enum_GeometryInstance_Flags: +.. _class_GeometryInstance_constant_FLAG_USE_BAKED_LIGHT: + +.. _class_GeometryInstance_constant_FLAG_MAX: + enum **Flags**: - **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. @@ -78,7 +90,7 @@ Base node for geometry based visual instances. Shares some common functionality Property Descriptions --------------------- -.. _class_GeometryInstance_cast_shadow: +.. _class_GeometryInstance_property_cast_shadow: - :ref:`ShadowCastingSetting` **cast_shadow** @@ -90,7 +102,7 @@ Property Descriptions The selected shadow casting flag. See SHADOW_CASTING_SETTING\_\* constants for values. -.. _class_GeometryInstance_extra_cull_margin: +.. _class_GeometryInstance_property_extra_cull_margin: - :ref:`float` **extra_cull_margin** @@ -102,7 +114,7 @@ The selected shadow casting flag. See SHADOW_CASTING_SETTING\_\* constants for v The extra distance added to the GeometryInstance's bounding box (:ref:`AABB`) to increase its cull box. -.. _class_GeometryInstance_lod_max_distance: +.. _class_GeometryInstance_property_lod_max_distance: - :ref:`float` **lod_max_distance** @@ -114,7 +126,7 @@ The extra distance added to the GeometryInstance's bounding box (:ref:`AABB` **lod_max_hysteresis** @@ -126,7 +138,7 @@ The GeometryInstance's max LOD distance. The GeometryInstance's max LOD margin. -.. _class_GeometryInstance_lod_min_distance: +.. _class_GeometryInstance_property_lod_min_distance: - :ref:`float` **lod_min_distance** @@ -138,7 +150,7 @@ The GeometryInstance's max LOD margin. The GeometryInstance's min LOD distance. -.. _class_GeometryInstance_lod_min_hysteresis: +.. _class_GeometryInstance_property_lod_min_hysteresis: - :ref:`float` **lod_min_hysteresis** @@ -150,7 +162,7 @@ The GeometryInstance's min LOD distance. The GeometryInstance's min LOD margin. -.. _class_GeometryInstance_material_override: +.. _class_GeometryInstance_property_material_override: - :ref:`Material` **material_override** @@ -164,7 +176,7 @@ The material override for the whole geometry. If there is a material in material_override, it will be used instead of any material set in any material slot of the mesh. -.. _class_GeometryInstance_use_in_baked_light: +.. _class_GeometryInstance_property_use_in_baked_light: - :ref:`bool` **use_in_baked_light** diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 5ef16decd..18378cec3 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -19,42 +19,52 @@ Brief Description Properties ---------- -+---------------------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`bias` | -+---------------------------------------+---------------------------------------------------+ -| :ref:`bool` | :ref:`compress` | -+---------------------------------------+---------------------------------------------------+ -| :ref:`GIProbeData` | :ref:`data` | -+---------------------------------------+---------------------------------------------------+ -| :ref:`int` | :ref:`dynamic_range` | -+---------------------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`energy` | -+---------------------------------------+---------------------------------------------------+ -| :ref:`Vector3` | :ref:`extents` | -+---------------------------------------+---------------------------------------------------+ -| :ref:`bool` | :ref:`interior` | -+---------------------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`normal_bias` | -+---------------------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`propagation` | -+---------------------------------------+---------------------------------------------------+ -| :ref:`Subdiv` | :ref:`subdiv` | -+---------------------------------------+---------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`bias` | ++---------------------------------------+------------------------------------------------------------+ +| :ref:`bool` | :ref:`compress` | ++---------------------------------------+------------------------------------------------------------+ +| :ref:`GIProbeData` | :ref:`data` | ++---------------------------------------+------------------------------------------------------------+ +| :ref:`int` | :ref:`dynamic_range` | ++---------------------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`energy` | ++---------------------------------------+------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`extents` | ++---------------------------------------+------------------------------------------------------------+ +| :ref:`bool` | :ref:`interior` | ++---------------------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`normal_bias` | ++---------------------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`propagation` | ++---------------------------------------+------------------------------------------------------------+ +| :ref:`Subdiv` | :ref:`subdiv` | ++---------------------------------------+------------------------------------------------------------+ Methods ------- -+-------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`debug_bake` **(** **)** | -+-------+---------------------------------------------------------------------------------------------------------------------------------------+ ++------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`debug_bake` **(** **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_GIProbe_Subdiv: +.. _class_GIProbe_constant_SUBDIV_64: + +.. _class_GIProbe_constant_SUBDIV_128: + +.. _class_GIProbe_constant_SUBDIV_256: + +.. _class_GIProbe_constant_SUBDIV_512: + +.. _class_GIProbe_constant_SUBDIV_MAX: + enum **Subdiv**: - **SUBDIV_64** = **0** @@ -75,7 +85,7 @@ Tutorials Property Descriptions --------------------- -.. _class_GIProbe_bias: +.. _class_GIProbe_property_bias: - :ref:`float` **bias** @@ -85,7 +95,7 @@ Property Descriptions | *Getter* | get_bias() | +----------+-----------------+ -.. _class_GIProbe_compress: +.. _class_GIProbe_property_compress: - :ref:`bool` **compress** @@ -95,7 +105,7 @@ Property Descriptions | *Getter* | is_compressed() | +----------+---------------------+ -.. _class_GIProbe_data: +.. _class_GIProbe_property_data: - :ref:`GIProbeData` **data** @@ -105,7 +115,7 @@ Property Descriptions | *Getter* | get_probe_data() | +----------+-----------------------+ -.. _class_GIProbe_dynamic_range: +.. _class_GIProbe_property_dynamic_range: - :ref:`int` **dynamic_range** @@ -115,7 +125,7 @@ Property Descriptions | *Getter* | get_dynamic_range() | +----------+--------------------------+ -.. _class_GIProbe_energy: +.. _class_GIProbe_property_energy: - :ref:`float` **energy** @@ -125,7 +135,7 @@ Property Descriptions | *Getter* | get_energy() | +----------+-------------------+ -.. _class_GIProbe_extents: +.. _class_GIProbe_property_extents: - :ref:`Vector3` **extents** @@ -135,7 +145,7 @@ Property Descriptions | *Getter* | get_extents() | +----------+--------------------+ -.. _class_GIProbe_interior: +.. _class_GIProbe_property_interior: - :ref:`bool` **interior** @@ -145,7 +155,7 @@ Property Descriptions | *Getter* | is_interior() | +----------+---------------------+ -.. _class_GIProbe_normal_bias: +.. _class_GIProbe_property_normal_bias: - :ref:`float` **normal_bias** @@ -155,7 +165,7 @@ Property Descriptions | *Getter* | get_normal_bias() | +----------+------------------------+ -.. _class_GIProbe_propagation: +.. _class_GIProbe_property_propagation: - :ref:`float` **propagation** @@ -165,7 +175,7 @@ Property Descriptions | *Getter* | get_propagation() | +----------+------------------------+ -.. _class_GIProbe_subdiv: +.. _class_GIProbe_property_subdiv: - :ref:`Subdiv` **subdiv** @@ -178,11 +188,11 @@ Property Descriptions Method Descriptions ------------------- -.. _class_GIProbe_bake: +.. _class_GIProbe_method_bake: - void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** -.. _class_GIProbe_debug_bake: +.. _class_GIProbe_method_debug_bake: - void **debug_bake** **(** **)** diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index ab02f88a7..12d736a1a 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -19,34 +19,34 @@ Brief Description Properties ---------- -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`float` | :ref:`bias` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`AABB` | :ref:`bounds` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`float` | :ref:`cell_size` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`compress` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`dynamic_data` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`dynamic_range` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`float` | :ref:`energy` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`interior` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`float` | :ref:`normal_bias` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`float` | :ref:`propagation` | -+-----------------------------------------+-------------------------------------------------------+ -| :ref:`Transform` | :ref:`to_cell_xform` | -+-----------------------------------------+-------------------------------------------------------+ ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`bias` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`AABB` | :ref:`bounds` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`cell_size` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`compress` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`dynamic_data` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`int` | :ref:`dynamic_range` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`energy` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`interior` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`normal_bias` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`propagation` | ++-----------------------------------------+----------------------------------------------------------------+ +| :ref:`Transform` | :ref:`to_cell_xform` | ++-----------------------------------------+----------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_GIProbeData_bias: +.. _class_GIProbeData_property_bias: - :ref:`float` **bias** @@ -56,7 +56,7 @@ Property Descriptions | *Getter* | get_bias() | +----------+-----------------+ -.. _class_GIProbeData_bounds: +.. _class_GIProbeData_property_bounds: - :ref:`AABB` **bounds** @@ -66,7 +66,7 @@ Property Descriptions | *Getter* | get_bounds() | +----------+-------------------+ -.. _class_GIProbeData_cell_size: +.. _class_GIProbeData_property_cell_size: - :ref:`float` **cell_size** @@ -76,7 +76,7 @@ Property Descriptions | *Getter* | get_cell_size() | +----------+----------------------+ -.. _class_GIProbeData_compress: +.. _class_GIProbeData_property_compress: - :ref:`bool` **compress** @@ -86,7 +86,7 @@ Property Descriptions | *Getter* | is_compressed() | +----------+---------------------+ -.. _class_GIProbeData_dynamic_data: +.. _class_GIProbeData_property_dynamic_data: - :ref:`PoolIntArray` **dynamic_data** @@ -96,7 +96,7 @@ Property Descriptions | *Getter* | get_dynamic_data() | +----------+-------------------------+ -.. _class_GIProbeData_dynamic_range: +.. _class_GIProbeData_property_dynamic_range: - :ref:`int` **dynamic_range** @@ -106,7 +106,7 @@ Property Descriptions | *Getter* | get_dynamic_range() | +----------+--------------------------+ -.. _class_GIProbeData_energy: +.. _class_GIProbeData_property_energy: - :ref:`float` **energy** @@ -116,7 +116,7 @@ Property Descriptions | *Getter* | get_energy() | +----------+-------------------+ -.. _class_GIProbeData_interior: +.. _class_GIProbeData_property_interior: - :ref:`bool` **interior** @@ -126,7 +126,7 @@ Property Descriptions | *Getter* | is_interior() | +----------+---------------------+ -.. _class_GIProbeData_normal_bias: +.. _class_GIProbeData_property_normal_bias: - :ref:`float` **normal_bias** @@ -136,7 +136,7 @@ Property Descriptions | *Getter* | get_normal_bias() | +----------+------------------------+ -.. _class_GIProbeData_propagation: +.. _class_GIProbeData_property_propagation: - :ref:`float` **propagation** @@ -146,7 +146,7 @@ Property Descriptions | *Getter* | get_propagation() | +----------+------------------------+ -.. _class_GIProbeData_to_cell_xform: +.. _class_GIProbeData_property_to_cell_xform: - :ref:`Transform` **to_cell_xform** diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index 3695b9723..0a8b0a483 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -19,62 +19,62 @@ Brief Description Methods ------- -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`attach_thread` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`detach_thread` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_domain_id` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_scripts_domain_id` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_domain_finalizing_for_unload` **(** :ref:`int` domain_id **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_runtime_initialized` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_runtime_shutting_down` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scripts_domain_loaded` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`attach_thread` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`detach_thread` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_domain_id` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_scripts_domain_id` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_domain_finalizing_for_unload` **(** :ref:`int` domain_id **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_runtime_initialized` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_runtime_shutting_down` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scripts_domain_loaded` **(** **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_GodotSharp_attach_thread: +.. _class_GodotSharp_method_attach_thread: - void **attach_thread** **(** **)** Attaches the current thread to the mono runtime. -.. _class_GodotSharp_detach_thread: +.. _class_GodotSharp_method_detach_thread: - void **detach_thread** **(** **)** Detaches the current thread from the mono runtime. -.. _class_GodotSharp_get_domain_id: +.. _class_GodotSharp_method_get_domain_id: - :ref:`int` **get_domain_id** **(** **)** -.. _class_GodotSharp_get_scripts_domain_id: +.. _class_GodotSharp_method_get_scripts_domain_id: - :ref:`int` **get_scripts_domain_id** **(** **)** -.. _class_GodotSharp_is_domain_finalizing_for_unload: +.. _class_GodotSharp_method_is_domain_finalizing_for_unload: - :ref:`bool` **is_domain_finalizing_for_unload** **(** :ref:`int` domain_id **)** Returns whether the domain is being finalized. -.. _class_GodotSharp_is_runtime_initialized: +.. _class_GodotSharp_method_is_runtime_initialized: - :ref:`bool` **is_runtime_initialized** **(** **)** -.. _class_GodotSharp_is_runtime_shutting_down: +.. _class_GodotSharp_method_is_runtime_shutting_down: - :ref:`bool` **is_runtime_shutting_down** **(** **)** -.. _class_GodotSharp_is_scripts_domain_loaded: +.. _class_GodotSharp_method_is_scripts_domain_loaded: - :ref:`bool` **is_scripts_domain_loaded** **(** **)** diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 19e185215..c49e099f5 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -19,32 +19,32 @@ Color interpolator node. Properties ---------- -+---------------------------------------------+----------------------------------------+ -| :ref:`PoolColorArray` | :ref:`colors` | -+---------------------------------------------+----------------------------------------+ -| :ref:`PoolRealArray` | :ref:`offsets` | -+---------------------------------------------+----------------------------------------+ ++---------------------------------------------+-------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`colors` | ++---------------------------------------------+-------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`offsets` | ++---------------------------------------------+-------------------------------------------------+ Methods ------- -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` offset **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` offset **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -54,7 +54,7 @@ Given a set of colors, this node will interpolate them in order, meaning, that i Property Descriptions --------------------- -.. _class_Gradient_colors: +.. _class_Gradient_property_colors: - :ref:`PoolColorArray` **colors** @@ -66,7 +66,7 @@ Property Descriptions Gradient's colors returned as a :ref:`PoolColorArray`. -.. _class_Gradient_offsets: +.. _class_Gradient_property_offsets: - :ref:`PoolRealArray` **offsets** @@ -81,49 +81,49 @@ Gradient's offsets returned as a :ref:`PoolRealArray`. Method Descriptions ------------------- -.. _class_Gradient_add_point: +.. _class_Gradient_method_add_point: - void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** Adds the specified color to the end of the ramp, with the specified offset -.. _class_Gradient_get_color: +.. _class_Gradient_method_get_color: - :ref:`Color` **get_color** **(** :ref:`int` point **)** const Returns the color of the ramp color at index *point* -.. _class_Gradient_get_offset: +.. _class_Gradient_method_get_offset: - :ref:`float` **get_offset** **(** :ref:`int` point **)** const Returns the offset of the ramp color at index *point* -.. _class_Gradient_get_point_count: +.. _class_Gradient_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of colors in the ramp -.. _class_Gradient_interpolate: +.. _class_Gradient_method_interpolate: - :ref:`Color` **interpolate** **(** :ref:`float` offset **)** Returns the interpolated color specified by *offset* -.. _class_Gradient_remove_point: +.. _class_Gradient_method_remove_point: - void **remove_point** **(** :ref:`int` offset **)** Removes the color at the index *offset* -.. _class_Gradient_set_color: +.. _class_Gradient_method_set_color: - void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** Sets the color of the ramp color at index *point* -.. _class_Gradient_set_offset: +.. _class_Gradient_method_set_offset: - void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index bb52af81a..48d212f67 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -19,21 +19,21 @@ Gradient filled texture. Properties ---------- -+---------------------------------+-------------------------------------------------+ -| :ref:`Gradient` | :ref:`gradient` | -+---------------------------------+-------------------------------------------------+ -| :ref:`int` | :ref:`width` | -+---------------------------------+-------------------------------------------------+ ++---------------------------------+----------------------------------------------------------+ +| :ref:`Gradient` | :ref:`gradient` | ++---------------------------------+----------------------------------------------------------+ +| :ref:`int` | :ref:`width` | ++---------------------------------+----------------------------------------------------------+ Description ----------- -Uses a :ref:`Gradient` to fill the texture data, the gradient will be filled from left to right using colors obtained from the gradient, this means that the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width`). +Uses a :ref:`Gradient` to fill the texture data, the gradient will be filled from left to right using colors obtained from the gradient, this means that the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width`). Property Descriptions --------------------- -.. _class_GradientTexture_gradient: +.. _class_GradientTexture_property_gradient: - :ref:`Gradient` **gradient** @@ -45,7 +45,7 @@ Property Descriptions The :ref:`Gradient` that will be used to fill the texture. -.. _class_GradientTexture_width: +.. _class_GradientTexture_property_width: - :ref:`int` **width** diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 17c5c6297..481506635 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -19,138 +19,138 @@ GraphEdit is an area capable of showing various GraphNodes. It manages connectio Properties ---------- -+-------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`right_disconnects` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_offset` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`int` | :ref:`snap_distance` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_snap` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`zoom` | -+-------------------------------+-------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`right_disconnects` | ++-------------------------------+----------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`scroll_offset` | ++-------------------------------+----------------------------------------------------------------------+ +| :ref:`int` | :ref:`snap_distance` | ++-------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_snap` | ++-------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`zoom` | ++-------------------------------+----------------------------------------------------------------------+ Methods ------- -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_valid_left_disconnect_type` **(** :ref:`int` type **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_valid_right_disconnect_type` **(** :ref:`int` type **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_connections` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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 | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_valid_left_disconnect_type` **(** :ref:`int` type **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_valid_right_disconnect_type` **(** :ref:`int` type **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_connection_activity` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`Node` node **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_left_disconnect_type` **(** :ref:`int` type **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_right_disconnect_type` **(** :ref:`int` type **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_connections` **(** **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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 | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_left_disconnect_type` **(** :ref:`int` type **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_right_disconnect_type` **(** :ref:`int` type **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_connection_activity` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`Node` node **)** | ++-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`activity` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bezier_len_neg` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bezier_len_pos` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`grid_major` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`grid_minor` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`minus` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`more` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`port_grab_distance_horizontal` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`port_grab_distance_vertical` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`reset` | -+---------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`snap` | -+---------------------------------+-------------------------------------------------------------------------------------+ ++---------------------------------+-------------------------------+ +| :ref:`Color` | activity | ++---------------------------------+-------------------------------+ +| :ref:`int` | bezier_len_neg | ++---------------------------------+-------------------------------+ +| :ref:`int` | bezier_len_pos | ++---------------------------------+-------------------------------+ +| :ref:`StyleBox` | bg | ++---------------------------------+-------------------------------+ +| :ref:`Color` | grid_major | ++---------------------------------+-------------------------------+ +| :ref:`Color` | grid_minor | ++---------------------------------+-------------------------------+ +| :ref:`Texture` | minus | ++---------------------------------+-------------------------------+ +| :ref:`Texture` | more | ++---------------------------------+-------------------------------+ +| :ref:`int` | port_grab_distance_horizontal | ++---------------------------------+-------------------------------+ +| :ref:`int` | port_grab_distance_vertical | ++---------------------------------+-------------------------------+ +| :ref:`Texture` | reset | ++---------------------------------+-------------------------------+ +| :ref:`Texture` | snap | ++---------------------------------+-------------------------------+ Signals ------- -.. _class_GraphEdit__begin_node_move: +.. _class_GraphEdit_signal__begin_node_move: - **_begin_node_move** **(** **)** Signal sent at the beginning of a GraphNode movement. -.. _class_GraphEdit__end_node_move: +.. _class_GraphEdit_signal__end_node_move: - **_end_node_move** **(** **)** Signal sent at the end of a GraphNode movement. -.. _class_GraphEdit_connection_request: +.. _class_GraphEdit_signal_connection_request: - **connection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. -.. _class_GraphEdit_connection_to_empty: +.. _class_GraphEdit_signal_connection_to_empty: - **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** -.. _class_GraphEdit_delete_nodes_request: +.. _class_GraphEdit_signal_delete_nodes_request: - **delete_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be removed from the GraphEdit. -.. _class_GraphEdit_disconnection_request: +.. _class_GraphEdit_signal_disconnection_request: - **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. -.. _class_GraphEdit_duplicate_nodes_request: +.. _class_GraphEdit_signal_duplicate_nodes_request: - **duplicate_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. -.. _class_GraphEdit_node_selected: +.. _class_GraphEdit_signal_node_selected: - **node_selected** **(** :ref:`Node` node **)** Emitted when a GraphNode is selected. -.. _class_GraphEdit_popup_request: +.. _class_GraphEdit_signal_popup_request: - **popup_request** **(** :ref:`Vector2` position **)** Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. -.. _class_GraphEdit_scroll_offset_changed: +.. _class_GraphEdit_signal_scroll_offset_changed: - **scroll_offset_changed** **(** :ref:`Vector2` ofs **)** @@ -159,12 +159,12 @@ Description GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. -It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_processor_usage_mode`) when using GraphEdits. +It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_processor_usage_mode`) when using GraphEdits. Property Descriptions --------------------- -.. _class_GraphEdit_right_disconnects: +.. _class_GraphEdit_property_right_disconnects: - :ref:`bool` **right_disconnects** @@ -176,7 +176,7 @@ Property Descriptions If ``true``, enables disconnection of existing connections in the GraphEdit by dragging the right end. -.. _class_GraphEdit_scroll_offset: +.. _class_GraphEdit_property_scroll_offset: - :ref:`Vector2` **scroll_offset** @@ -188,7 +188,7 @@ If ``true``, enables disconnection of existing connections in the GraphEdit by d The scroll offset. -.. _class_GraphEdit_snap_distance: +.. _class_GraphEdit_property_snap_distance: - :ref:`int` **snap_distance** @@ -200,7 +200,7 @@ The scroll offset. The snapping distance in pixels. -.. _class_GraphEdit_use_snap: +.. _class_GraphEdit_property_use_snap: - :ref:`bool` **use_snap** @@ -212,7 +212,7 @@ The snapping distance in pixels. If ``true``, enables snapping. -.. _class_GraphEdit_zoom: +.. _class_GraphEdit_property_zoom: - :ref:`float` **zoom** @@ -227,87 +227,87 @@ The current zoom value. Method Descriptions ------------------- -.. _class_GraphEdit_add_valid_connection_type: +.. _class_GraphEdit_method_add_valid_connection_type: - void **add_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** -Makes possible the connection between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. +Makes possible the connection between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. -.. _class_GraphEdit_add_valid_left_disconnect_type: +.. _class_GraphEdit_method_add_valid_left_disconnect_type: - void **add_valid_left_disconnect_type** **(** :ref:`int` type **)** Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type. -.. _class_GraphEdit_add_valid_right_disconnect_type: +.. _class_GraphEdit_method_add_valid_right_disconnect_type: - void **add_valid_right_disconnect_type** **(** :ref:`int` type **)** Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type. -.. _class_GraphEdit_clear_connections: +.. _class_GraphEdit_method_clear_connections: - void **clear_connections** **(** **)** Remove all connections between nodes. -.. _class_GraphEdit_connect_node: +.. _class_GraphEdit_method_connect_node: - :ref:`Error` **connect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. -.. _class_GraphEdit_disconnect_node: +.. _class_GraphEdit_method_disconnect_node: - void **disconnect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. -.. _class_GraphEdit_get_connection_list: +.. _class_GraphEdit_method_get_connection_list: - :ref:`Array` **get_connection_list** **(** **)** const Return 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" } -.. _class_GraphEdit_get_zoom_hbox: +.. _class_GraphEdit_method_get_zoom_hbox: - :ref:`HBoxContainer` **get_zoom_hbox** **(** **)** -.. _class_GraphEdit_is_node_connected: +.. _class_GraphEdit_method_is_node_connected: - :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. -.. _class_GraphEdit_is_valid_connection_type: +.. _class_GraphEdit_method_is_valid_connection_type: - :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. -.. _class_GraphEdit_remove_valid_connection_type: +.. _class_GraphEdit_method_remove_valid_connection_type: - void **remove_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** -Makes it not possible to connect between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. +Makes it not possible to connect between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. -.. _class_GraphEdit_remove_valid_left_disconnect_type: +.. _class_GraphEdit_method_remove_valid_left_disconnect_type: - void **remove_valid_left_disconnect_type** **(** :ref:`int` type **)** Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type. -.. _class_GraphEdit_remove_valid_right_disconnect_type: +.. _class_GraphEdit_method_remove_valid_right_disconnect_type: - void **remove_valid_right_disconnect_type** **(** :ref:`int` type **)** Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type. -.. _class_GraphEdit_set_connection_activity: +.. _class_GraphEdit_method_set_connection_activity: - void **set_connection_activity** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** -.. _class_GraphEdit_set_selected: +.. _class_GraphEdit_method_set_selected: - void **set_selected** **(** :ref:`Node` node **)** diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 63afb85c6..539ae5b64 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -19,130 +19,130 @@ A GraphNode is a container with several input and output slots allowing connecti Properties ---------- -+----------------------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`comment` | -+----------------------------------------+-----------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+----------------------------------------+-----------------------------------------------+ -| :ref:`Overlay` | :ref:`overlay` | -+----------------------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`resizable` | -+----------------------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`selected` | -+----------------------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`show_close` | -+----------------------------------------+-----------------------------------------------+ -| :ref:`String` | :ref:`title` | -+----------------------------------------+-----------------------------------------------+ ++----------------------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`comment` | ++----------------------------------------+--------------------------------------------------------+ +| :ref:`Vector2` | :ref:`offset` | ++----------------------------------------+--------------------------------------------------------+ +| :ref:`Overlay` | :ref:`overlay` | ++----------------------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`resizable` | ++----------------------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`selected` | ++----------------------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`show_close` | ++----------------------------------------+--------------------------------------------------------+ +| :ref:`String` | :ref:`title` | ++----------------------------------------+--------------------------------------------------------+ Methods ------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all_slots` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_input_position` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_output_position` **(** :ref:`int` idx **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_right` **(** :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:`bool` | :ref:`is_slot_enabled_left` **(** :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 **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all_slots` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_input_position` **(** :ref:`int` idx **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_output_position` **(** :ref:`int` idx **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_right` **(** :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:`bool` | :ref:`is_slot_enabled_left` **(** :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 **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`breakpoint` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Texture` | :ref:`close` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Color` | :ref:`close_color` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`close_offset` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`comment` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`commentfocus` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`defaultfocus` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`defaultframe` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`frame` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Texture` | :ref:`port` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`port_offset` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`position` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Texture` | :ref:`resizer` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`selectedframe` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`separation` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Color` | :ref:`title_color` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Font` | :ref:`title_font` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`title_offset` | -+---------------------------------+-----------------------------------------------------+ ++---------------------------------+---------------+ +| :ref:`StyleBox` | breakpoint | ++---------------------------------+---------------+ +| :ref:`Texture` | close | ++---------------------------------+---------------+ +| :ref:`Color` | close_color | ++---------------------------------+---------------+ +| :ref:`int` | close_offset | ++---------------------------------+---------------+ +| :ref:`StyleBox` | comment | ++---------------------------------+---------------+ +| :ref:`StyleBox` | commentfocus | ++---------------------------------+---------------+ +| :ref:`StyleBox` | defaultfocus | ++---------------------------------+---------------+ +| :ref:`StyleBox` | defaultframe | ++---------------------------------+---------------+ +| :ref:`StyleBox` | frame | ++---------------------------------+---------------+ +| :ref:`Texture` | port | ++---------------------------------+---------------+ +| :ref:`int` | port_offset | ++---------------------------------+---------------+ +| :ref:`StyleBox` | position | ++---------------------------------+---------------+ +| :ref:`Texture` | resizer | ++---------------------------------+---------------+ +| :ref:`StyleBox` | selectedframe | ++---------------------------------+---------------+ +| :ref:`int` | separation | ++---------------------------------+---------------+ +| :ref:`Color` | title_color | ++---------------------------------+---------------+ +| :ref:`Font` | title_font | ++---------------------------------+---------------+ +| :ref:`int` | title_offset | ++---------------------------------+---------------+ Signals ------- -.. _class_GraphNode_close_request: +.. _class_GraphNode_signal_close_request: - **close_request** **(** **)** Signal sent on closing the GraphNode. -.. _class_GraphNode_dragged: +.. _class_GraphNode_signal_dragged: - **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** Signal sent when the GraphNode is dragged. -.. _class_GraphNode_offset_changed: +.. _class_GraphNode_signal_offset_changed: - **offset_changed** **(** **)** Signal sent when the GraphNode is moved. -.. _class_GraphNode_raise_request: +.. _class_GraphNode_signal_raise_request: - **raise_request** **(** **)** Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. -.. _class_GraphNode_resize_request: +.. _class_GraphNode_signal_resize_request: - **resize_request** **(** :ref:`Vector2` new_minsize **)** @@ -151,6 +151,12 @@ Enumerations .. _enum_GraphNode_Overlay: +.. _class_GraphNode_constant_OVERLAY_DISABLED: + +.. _class_GraphNode_constant_OVERLAY_BREAKPOINT: + +.. _class_GraphNode_constant_OVERLAY_POSITION: + enum **Overlay**: - **OVERLAY_DISABLED** = **0** @@ -167,7 +173,7 @@ A GraphNode is a container defined by a title. It can have 1 or more input and o Property Descriptions --------------------- -.. _class_GraphNode_comment: +.. _class_GraphNode_property_comment: - :ref:`bool` **comment** @@ -177,7 +183,7 @@ Property Descriptions | *Getter* | is_comment() | +----------+--------------------+ -.. _class_GraphNode_offset: +.. _class_GraphNode_property_offset: - :ref:`Vector2` **offset** @@ -189,7 +195,7 @@ Property Descriptions The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdit`. Note that you cannot use position directly, as :ref:`GraphEdit` is a :ref:`Container`. -.. _class_GraphNode_overlay: +.. _class_GraphNode_property_overlay: - :ref:`Overlay` **overlay** @@ -199,7 +205,7 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | get_overlay() | +----------+--------------------+ -.. _class_GraphNode_resizable: +.. _class_GraphNode_property_resizable: - :ref:`bool` **resizable** @@ -209,7 +215,7 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | is_resizable() | +----------+----------------------+ -.. _class_GraphNode_selected: +.. _class_GraphNode_property_selected: - :ref:`bool` **selected** @@ -219,7 +225,7 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | is_selected() | +----------+---------------------+ -.. _class_GraphNode_show_close: +.. _class_GraphNode_property_show_close: - :ref:`bool` **show_close** @@ -229,7 +235,7 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | is_close_button_visible() | +----------+------------------------------+ -.. _class_GraphNode_title: +.. _class_GraphNode_property_title: - :ref:`String` **title** @@ -242,103 +248,103 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi Method Descriptions ------------------- -.. _class_GraphNode_clear_all_slots: +.. _class_GraphNode_method_clear_all_slots: - void **clear_all_slots** **(** **)** Disable all input and output slots of the GraphNode. -.. _class_GraphNode_clear_slot: +.. _class_GraphNode_method_clear_slot: - void **clear_slot** **(** :ref:`int` idx **)** Disable input and output slot whose index is 'idx'. -.. _class_GraphNode_get_connection_input_color: +.. _class_GraphNode_method_get_connection_input_color: - :ref:`Color` **get_connection_input_color** **(** :ref:`int` idx **)** Return the color of the input connection 'idx'. -.. _class_GraphNode_get_connection_input_count: +.. _class_GraphNode_method_get_connection_input_count: - :ref:`int` **get_connection_input_count** **(** **)** Return the number of enabled input slots (connections) to the GraphNode. -.. _class_GraphNode_get_connection_input_position: +.. _class_GraphNode_method_get_connection_input_position: - :ref:`Vector2` **get_connection_input_position** **(** :ref:`int` idx **)** Return the position of the input connection 'idx'. -.. _class_GraphNode_get_connection_input_type: +.. _class_GraphNode_method_get_connection_input_type: - :ref:`int` **get_connection_input_type** **(** :ref:`int` idx **)** Return the type of the input connection 'idx'. -.. _class_GraphNode_get_connection_output_color: +.. _class_GraphNode_method_get_connection_output_color: - :ref:`Color` **get_connection_output_color** **(** :ref:`int` idx **)** Return the color of the output connection 'idx'. -.. _class_GraphNode_get_connection_output_count: +.. _class_GraphNode_method_get_connection_output_count: - :ref:`int` **get_connection_output_count** **(** **)** Return the number of enabled output slots (connections) of the GraphNode. -.. _class_GraphNode_get_connection_output_position: +.. _class_GraphNode_method_get_connection_output_position: - :ref:`Vector2` **get_connection_output_position** **(** :ref:`int` idx **)** Return the position of the output connection 'idx'. -.. _class_GraphNode_get_connection_output_type: +.. _class_GraphNode_method_get_connection_output_type: - :ref:`int` **get_connection_output_type** **(** :ref:`int` idx **)** Return the type of the output connection 'idx'. -.. _class_GraphNode_get_slot_color_left: +.. _class_GraphNode_method_get_slot_color_left: - :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** const Return the color set to 'idx' left (input) slot. -.. _class_GraphNode_get_slot_color_right: +.. _class_GraphNode_method_get_slot_color_right: - :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const Return the color set to 'idx' right (output) slot. -.. _class_GraphNode_get_slot_type_left: +.. _class_GraphNode_method_get_slot_type_left: - :ref:`int` **get_slot_type_left** **(** :ref:`int` idx **)** const Return the (integer) type of left (input) 'idx' slot. -.. _class_GraphNode_get_slot_type_right: +.. _class_GraphNode_method_get_slot_type_right: - :ref:`int` **get_slot_type_right** **(** :ref:`int` idx **)** const Return the (integer) type of right (output) 'idx' slot. -.. _class_GraphNode_is_slot_enabled_left: +.. _class_GraphNode_method_is_slot_enabled_left: - :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const Return true if left (input) slot 'idx' is enabled. False otherwise. -.. _class_GraphNode_is_slot_enabled_right: +.. _class_GraphNode_method_is_slot_enabled_right: - :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** const Return true if right (output) slot 'idx' is enabled. False otherwise. -.. _class_GraphNode_set_slot: +.. _class_GraphNode_method_set_slot: - void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 64c6aa413..fb5362be8 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -19,28 +19,28 @@ Grid container used to arrange elements in a grid like layout. Properties ---------- -+-----------------------+---------------------------------------------+ -| :ref:`int` | :ref:`columns` | -+-----------------------+---------------------------------------------+ ++-----------------------+------------------------------------------------------+ +| :ref:`int` | :ref:`columns` | ++-----------------------+------------------------------------------------------+ Theme Properties ---------------- -+-----------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+-----------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`vseparation` | -+-----------------------+-----------------------------------------------------+ ++-----------------------+-------------+ +| :ref:`int` | hseparation | ++-----------------------+-------------+ +| :ref:`int` | vseparation | ++-----------------------+-------------+ 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. Notice that grid layout will preserve the columns and rows for every size of the container. +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. Notice that grid layout will preserve the columns and rows for every size of the container. Property Descriptions --------------------- -.. _class_GridContainer_columns: +.. _class_GridContainer_property_columns: - :ref:`int` **columns** diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 49df61b27..8b8b41d1e 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -19,73 +19,75 @@ Node for 3D tile-based maps. Properties ---------- -+---------------------------------------+---------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_center_x` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_center_y` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_center_z` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`int` | :ref:`cell_octant_size` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`float` | :ref:`cell_scale` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cell_size` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`MeshLibrary` | :ref:`mesh_library` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`MeshLibrary` | :ref:`theme` | -+---------------------------------------+---------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cell_center_x` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cell_center_y` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cell_center_z` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`cell_octant_size` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`float` | :ref:`cell_scale` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`cell_size` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`MeshLibrary` | :ref:`mesh_library` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`MeshLibrary` | :ref:`theme` | ++---------------------------------------+------------------------------------------------------------------+ Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_baked_meshes` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_bake_mesh_instance` **(** :ref:`int` idx **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_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_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_meshes` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`Axis` axis=0 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`world_to_map` **(** :ref:`Vector3` pos **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_baked_meshes` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_bake_mesh_instance` **(** :ref:`int` idx **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_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_mask_bit` **(** :ref:`int` bit **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_meshes` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, Vector3.Axis axis=0 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`world_to_map` **(** :ref:`Vector3` pos **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- -- **INVALID_CELL_ITEM** = **-1** --- Invalid cell item that can be used in :ref:`set_cell_item` to clear cells (or represent an empty cell in :ref:`get_cell_item`). +.. _class_GridMap_constant_INVALID_CELL_ITEM: + +- **INVALID_CELL_ITEM** = **-1** --- Invalid cell item that can be used in :ref:`set_cell_item` to clear cells (or represent an empty cell in :ref:`get_cell_item`). Description ----------- @@ -106,7 +108,7 @@ Tutorials Property Descriptions --------------------- -.. _class_GridMap_cell_center_x: +.. _class_GridMap_property_cell_center_x: - :ref:`bool` **cell_center_x** @@ -118,7 +120,7 @@ Property Descriptions If ``true``, grid items are centered on the X axis. -.. _class_GridMap_cell_center_y: +.. _class_GridMap_property_cell_center_y: - :ref:`bool` **cell_center_y** @@ -130,7 +132,7 @@ If ``true``, grid items are centered on the X axis. If ``true``, grid items are centered on the Y axis. -.. _class_GridMap_cell_center_z: +.. _class_GridMap_property_cell_center_z: - :ref:`bool` **cell_center_z** @@ -142,7 +144,7 @@ If ``true``, grid items are centered on the Y axis. If ``true``, grid items are centered on the Z axis. -.. _class_GridMap_cell_octant_size: +.. _class_GridMap_property_cell_octant_size: - :ref:`int` **cell_octant_size** @@ -154,7 +156,7 @@ If ``true``, grid items are centered on the Z axis. The size of each octant measured in number of cells. This applies to all three axis. -.. _class_GridMap_cell_scale: +.. _class_GridMap_property_cell_scale: - :ref:`float` **cell_scale** @@ -164,7 +166,7 @@ The size of each octant measured in number of cells. This applies to all three a | *Getter* | get_cell_scale() | +----------+-----------------------+ -.. _class_GridMap_cell_size: +.. _class_GridMap_property_cell_size: - :ref:`Vector3` **cell_size** @@ -176,7 +178,7 @@ The size of each octant measured in number of cells. This applies to all three a The dimensions of the grid's cells. -.. _class_GridMap_collision_layer: +.. _class_GridMap_property_collision_layer: - :ref:`int` **collision_layer** @@ -186,7 +188,7 @@ The dimensions of the grid's cells. | *Getter* | get_collision_layer() | +----------+----------------------------+ -.. _class_GridMap_collision_mask: +.. _class_GridMap_property_collision_mask: - :ref:`int` **collision_mask** @@ -196,7 +198,7 @@ The dimensions of the grid's cells. | *Getter* | get_collision_mask() | +----------+---------------------------+ -.. _class_GridMap_mesh_library: +.. _class_GridMap_property_mesh_library: - :ref:`MeshLibrary` **mesh_library** @@ -208,7 +210,7 @@ The dimensions of the grid's cells. The assigned :ref:`MeshLibrary`. -.. _class_GridMap_theme: +.. _class_GridMap_property_theme: - :ref:`MeshLibrary` **theme** @@ -218,74 +220,74 @@ The assigned :ref:`MeshLibrary`. | *Getter* | get_theme() | +----------+------------------+ -Deprecated, use :ref:`mesh_library` instead. +Deprecated, use :ref:`mesh_library` instead. Method Descriptions ------------------- -.. _class_GridMap_clear: +.. _class_GridMap_method_clear: - void **clear** **(** **)** Clear all cells. -.. _class_GridMap_clear_baked_meshes: +.. _class_GridMap_method_clear_baked_meshes: - void **clear_baked_meshes** **(** **)** -.. _class_GridMap_get_bake_mesh_instance: +.. _class_GridMap_method_get_bake_mesh_instance: - :ref:`RID` **get_bake_mesh_instance** **(** :ref:`int` idx **)** -.. _class_GridMap_get_bake_meshes: +.. _class_GridMap_method_get_bake_meshes: - :ref:`Array` **get_bake_meshes** **(** **)** -.. _class_GridMap_get_cell_item: +.. _class_GridMap_method_get_cell_item: - :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, constant INVALID_CELL_ITEM will be returned. +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. -.. _class_GridMap_get_cell_item_orientation: +.. _class_GridMap_method_get_cell_item_orientation: - :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. -.. _class_GridMap_get_collision_layer_bit: +.. _class_GridMap_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const -.. _class_GridMap_get_collision_mask_bit: +.. _class_GridMap_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -.. _class_GridMap_get_meshes: +.. _class_GridMap_method_get_meshes: - :ref:`Array` **get_meshes** **(** **)** Array of :ref:`Transform` and :ref:`Mesh` references corresponding to the non empty cells in the grid. The transforms are specified in world space. -.. _class_GridMap_get_used_cells: +.. _class_GridMap_method_get_used_cells: - :ref:`Array` **get_used_cells** **(** **)** const Array of :ref:`Vector3` with the non empty cell coordinates in the grid map. -.. _class_GridMap_make_baked_meshes: +.. _class_GridMap_method_make_baked_meshes: - void **make_baked_meshes** **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** -.. _class_GridMap_map_to_world: +.. _class_GridMap_method_map_to_world: - :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const -.. _class_GridMap_resource_changed: +.. _class_GridMap_method_resource_changed: - void **resource_changed** **(** :ref:`Resource` resource **)** -.. _class_GridMap_set_cell_item: +.. _class_GridMap_method_set_cell_item: - void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** @@ -295,19 +297,19 @@ A negative item index will clear the cell. Optionally, the item's orientation can be passed. -.. _class_GridMap_set_clip: +.. _class_GridMap_method_set_clip: -- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`Axis` axis=0 **)** +- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, Vector3.Axis axis=0 **)** -.. _class_GridMap_set_collision_layer_bit: +.. _class_GridMap_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_GridMap_set_collision_mask_bit: +.. _class_GridMap_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_GridMap_world_to_map: +.. _class_GridMap_method_world_to_map: - :ref:`Vector3` **world_to_map** **(** :ref:`Vector3` pos **)** const diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 0c6bd1a5d..08887aba5 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -19,11 +19,11 @@ Groove constraint for 2D physics. Properties ---------- -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`initial_offset` | -+---------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+-----------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`initial_offset` | ++---------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+--------------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Groove constraint for 2D physics. This is useful for making a body "slide" throu Property Descriptions --------------------- -.. _class_GrooveJoint2D_initial_offset: +.. _class_GrooveJoint2D_property_initial_offset: - :ref:`float` **initial_offset** @@ -43,9 +43,9 @@ Property Descriptions | *Getter* | get_initial_offset() | +----------+---------------------------+ -The body B's initial anchor position defined by the joint's origin and a local offset :ref:`initial_offset` along the joint's y axis (along the groove). Default value: ``25`` +The body B's initial anchor position defined by the joint's origin and a local offset :ref:`initial_offset` along the joint's y axis (along the groove). Default value: ``25`` -.. _class_GrooveJoint2D_length: +.. _class_GrooveJoint2D_property_length: - :ref:`float` **length** @@ -55,5 +55,5 @@ The body B's initial anchor position defined by the joint's origin and a local o | *Getter* | get_length() | +----------+-------------------+ -The groove's length. The groove is from the joint's origin towards :ref:`length` along the joint's local y axis. Default value: ``50`` +The groove's length. The groove is from the joint's origin towards :ref:`length` along the joint's local y axis. Default value: ``50`` diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index d2225a6b3..6b39c6a68 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -19,9 +19,9 @@ Horizontal box container. Theme Properties ---------------- -+-----------------------+---------------------------------------------------+ -| :ref:`int` | :ref:`separation` | -+-----------------------+---------------------------------------------------+ ++-----------------------+------------+ +| :ref:`int` | separation | ++-----------------------+------------+ Description ----------- diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 65ed66ffe..9595dd73b 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -19,40 +19,58 @@ A hinge between two 3D bodies. Properties ---------- -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/bias` | -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`angular_limit/enable` | -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/lower` | -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/relaxation` | -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/softness` | -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/upper` | -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`motor/enable` | -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`motor/max_impulse` | -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`motor/target_velocity` | -+---------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params/bias` | -+---------------------------+----------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/bias` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`angular_limit/enable` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/lower` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/relaxation` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/softness` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/upper` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`motor/enable` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`motor/max_impulse` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`motor/target_velocity` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`params/bias` | ++---------------------------+-------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_HingeJoint_Param: +.. _class_HingeJoint_constant_PARAM_BIAS: + +.. _class_HingeJoint_constant_PARAM_LIMIT_UPPER: + +.. _class_HingeJoint_constant_PARAM_LIMIT_LOWER: + +.. _class_HingeJoint_constant_PARAM_LIMIT_BIAS: + +.. _class_HingeJoint_constant_PARAM_LIMIT_SOFTNESS: + +.. _class_HingeJoint_constant_PARAM_LIMIT_RELAXATION: + +.. _class_HingeJoint_constant_PARAM_MOTOR_TARGET_VELOCITY: + +.. _class_HingeJoint_constant_PARAM_MOTOR_MAX_IMPULSE: + +.. _class_HingeJoint_constant_PARAM_MAX: + enum **Param**: - **PARAM_BIAS** = **0** --- The speed with which the two bodies get pulled together when they move in different directions. -- **PARAM_LIMIT_UPPER** = **1** --- The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. +- **PARAM_LIMIT_UPPER** = **1** --- The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. -- **PARAM_LIMIT_LOWER** = **2** --- The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. +- **PARAM_LIMIT_LOWER** = **2** --- The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. - **PARAM_LIMIT_BIAS** = **3** --- The speed with which the rotation across the axis perpendicular to the hinge gets corrected. @@ -68,9 +86,15 @@ enum **Param**: .. _enum_HingeJoint_Flag: +.. _class_HingeJoint_constant_FLAG_USE_LIMIT: + +.. _class_HingeJoint_constant_FLAG_ENABLE_MOTOR: + +.. _class_HingeJoint_constant_FLAG_MAX: + enum **Flag**: -- **FLAG_USE_LIMIT** = **0** --- If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. +- **FLAG_USE_LIMIT** = **0** --- If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. - **FLAG_ENABLE_MOTOR** = **1** --- When activated, a motor turns the hinge. @@ -84,7 +108,7 @@ Normally uses the z-axis of body A as the hinge axis, another axis can be specif Property Descriptions --------------------- -.. _class_HingeJoint_angular_limit/bias: +.. _class_HingeJoint_property_angular_limit/bias: - :ref:`float` **angular_limit/bias** @@ -96,7 +120,7 @@ Property Descriptions The speed with which the rotation across the axis perpendicular to the hinge gets corrected. -.. _class_HingeJoint_angular_limit/enable: +.. _class_HingeJoint_property_angular_limit/enable: - :ref:`bool` **angular_limit/enable** @@ -106,15 +130,15 @@ The speed with which the rotation across the axis perpendicular to the hinge get | *Getter* | get_flag() | +----------+-----------------+ -If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. +If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. -.. _class_HingeJoint_angular_limit/lower: +.. _class_HingeJoint_property_angular_limit/lower: - :ref:`float` **angular_limit/lower** -The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. +The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. -.. _class_HingeJoint_angular_limit/relaxation: +.. _class_HingeJoint_property_angular_limit/relaxation: - :ref:`float` **angular_limit/relaxation** @@ -126,7 +150,7 @@ The minimum rotation. only active if :ref:`angular_limit/enable` **angular_limit/softness** @@ -136,13 +160,13 @@ The lower this value, the more the rotation gets slowed down. | *Getter* | get_param() | +----------+------------------+ -.. _class_HingeJoint_angular_limit/upper: +.. _class_HingeJoint_property_angular_limit/upper: - :ref:`float` **angular_limit/upper** -The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. +The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. -.. _class_HingeJoint_motor/enable: +.. _class_HingeJoint_property_motor/enable: - :ref:`bool` **motor/enable** @@ -154,7 +178,7 @@ The maximum rotation. only active if :ref:`angular_limit/enable` **motor/max_impulse** @@ -166,7 +190,7 @@ When activated, a motor turns the hinge. Maximum acceleration for the motor. -.. _class_HingeJoint_motor/target_velocity: +.. _class_HingeJoint_property_motor/target_velocity: - :ref:`float` **motor/target_velocity** @@ -178,7 +202,7 @@ Maximum acceleration for the motor. Target speed for the motor. -.. _class_HingeJoint_params/bias: +.. _class_HingeJoint_property_params/bias: - :ref:`float` **params/bias** diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index 674e1b039..64ba63770 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -19,25 +19,25 @@ Horizontal scroll bar. Theme Properties ---------------- -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`decrement` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`decrement_highlight` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_highlight` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_pressed` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`increment` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`increment_highlight` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`scroll` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`scroll_focus` | -+---------------------------------+------------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`Texture` | decrement | ++---------------------------------+---------------------+ +| :ref:`Texture` | decrement_highlight | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | grabber | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | grabber_highlight | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | grabber_pressed | ++---------------------------------+---------------------+ +| :ref:`Texture` | increment | ++---------------------------------+---------------------+ +| :ref:`Texture` | increment_highlight | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | scroll | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | scroll_focus | ++---------------------------------+---------------------+ Description ----------- diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index 79c9a860a..36dfaee55 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -19,11 +19,11 @@ Horizontal separator. Theme Properties ---------------- -+---------------------------------+------------------------------------------------+ -| :ref:`int` | :ref:`separation` | -+---------------------------------+------------------------------------------------+ -| :ref:`StyleBox` | :ref:`separator` | -+---------------------------------+------------------------------------------------+ ++---------------------------------+------------+ +| :ref:`int` | separation | ++---------------------------------+------------+ +| :ref:`StyleBox` | separator | ++---------------------------------+------------+ Description ----------- diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index 30a1f4d45..5c0ae6b00 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -19,25 +19,25 @@ Horizontal slider. Theme Properties ---------------- -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`Texture` | :ref:`grabber` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_area` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`Texture` | :ref:`grabber_disabled` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_disabled` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`Texture` | :ref:`grabber_highlight` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_highlight` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`slider` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`Texture` | :ref:`tick` | -+---------------------------------+-----------------------------------------------------------+ ++---------------------------------+-------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+-------------------+ +| :ref:`Texture` | grabber | ++---------------------------------+-------------------+ +| :ref:`StyleBox` | grabber_area | ++---------------------------------+-------------------+ +| :ref:`Texture` | grabber_disabled | ++---------------------------------+-------------------+ +| :ref:`StyleBox` | grabber_disabled | ++---------------------------------+-------------------+ +| :ref:`Texture` | grabber_highlight | ++---------------------------------+-------------------+ +| :ref:`StyleBox` | grabber_highlight | ++---------------------------------+-------------------+ +| :ref:`StyleBox` | slider | ++---------------------------------+-------------------+ +| :ref:`Texture` | tick | ++---------------------------------+-------------------+ Description ----------- diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index 5b62e36c0..cacbd858e 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -19,15 +19,15 @@ Horizontal split container. Theme Properties ---------------- -+---------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`autohide` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Texture` | :ref:`grabber` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`separation` | -+---------------------------------+-----------------------------------------------------+ ++---------------------------------+------------+ +| :ref:`int` | autohide | ++---------------------------------+------------+ +| :ref:`StyleBox` | bg | ++---------------------------------+------------+ +| :ref:`Texture` | grabber | ++---------------------------------+------------+ +| :ref:`int` | separation | ++---------------------------------+------------+ Description ----------- diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index cb39aa437..2cf5c4188 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -19,52 +19,72 @@ Hyper-text transfer protocol client. Properties ---------- -+-------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`blocking_mode_enabled` | -+-------------------------------------+----------------------------------------------------------------------+ -| :ref:`StreamPeer` | :ref:`connection` | -+-------------------------------------+----------------------------------------------------------------------+ ++-------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`blocking_mode_enabled` | ++-------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`StreamPeer` | :ref:`connection` | ++-------------------------------------+-------------------------------------------------------------------------------+ Methods ------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_code` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_response_headers` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_response` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`poll` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request_raw` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_code` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_response_headers` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Status` | :ref:`get_status` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_response` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`poll` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`request` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`request_raw` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_HTTPClient_Method: +.. _class_HTTPClient_constant_METHOD_GET: + +.. _class_HTTPClient_constant_METHOD_HEAD: + +.. _class_HTTPClient_constant_METHOD_POST: + +.. _class_HTTPClient_constant_METHOD_PUT: + +.. _class_HTTPClient_constant_METHOD_DELETE: + +.. _class_HTTPClient_constant_METHOD_OPTIONS: + +.. _class_HTTPClient_constant_METHOD_TRACE: + +.. _class_HTTPClient_constant_METHOD_CONNECT: + +.. _class_HTTPClient_constant_METHOD_PATCH: + +.. _class_HTTPClient_constant_METHOD_MAX: + enum **Method**: - **METHOD_GET** = **0** --- HTTP GET method. The GET method requests a representation of the specified resource. Requests using GET should only retrieve data. @@ -89,6 +109,26 @@ enum **Method**: .. _enum_HTTPClient_Status: +.. _class_HTTPClient_constant_STATUS_DISCONNECTED: + +.. _class_HTTPClient_constant_STATUS_RESOLVING: + +.. _class_HTTPClient_constant_STATUS_CANT_RESOLVE: + +.. _class_HTTPClient_constant_STATUS_CONNECTING: + +.. _class_HTTPClient_constant_STATUS_CANT_CONNECT: + +.. _class_HTTPClient_constant_STATUS_CONNECTED: + +.. _class_HTTPClient_constant_STATUS_REQUESTING: + +.. _class_HTTPClient_constant_STATUS_BODY: + +.. _class_HTTPClient_constant_STATUS_CONNECTION_ERROR: + +.. _class_HTTPClient_constant_STATUS_SSL_HANDSHAKE_ERROR: + enum **Status**: - **STATUS_DISCONNECTED** = **0** --- Status: Disconnected from the server. @@ -113,6 +153,128 @@ enum **Status**: .. _enum_HTTPClient_ResponseCode: +.. _class_HTTPClient_constant_RESPONSE_CONTINUE: + +.. _class_HTTPClient_constant_RESPONSE_SWITCHING_PROTOCOLS: + +.. _class_HTTPClient_constant_RESPONSE_PROCESSING: + +.. _class_HTTPClient_constant_RESPONSE_OK: + +.. _class_HTTPClient_constant_RESPONSE_CREATED: + +.. _class_HTTPClient_constant_RESPONSE_ACCEPTED: + +.. _class_HTTPClient_constant_RESPONSE_NON_AUTHORITATIVE_INFORMATION: + +.. _class_HTTPClient_constant_RESPONSE_NO_CONTENT: + +.. _class_HTTPClient_constant_RESPONSE_RESET_CONTENT: + +.. _class_HTTPClient_constant_RESPONSE_PARTIAL_CONTENT: + +.. _class_HTTPClient_constant_RESPONSE_MULTI_STATUS: + +.. _class_HTTPClient_constant_RESPONSE_ALREADY_REPORTED: + +.. _class_HTTPClient_constant_RESPONSE_IM_USED: + +.. _class_HTTPClient_constant_RESPONSE_MULTIPLE_CHOICES: + +.. _class_HTTPClient_constant_RESPONSE_MOVED_PERMANENTLY: + +.. _class_HTTPClient_constant_RESPONSE_FOUND: + +.. _class_HTTPClient_constant_RESPONSE_SEE_OTHER: + +.. _class_HTTPClient_constant_RESPONSE_NOT_MODIFIED: + +.. _class_HTTPClient_constant_RESPONSE_USE_PROXY: + +.. _class_HTTPClient_constant_RESPONSE_SWITCH_PROXY: + +.. _class_HTTPClient_constant_RESPONSE_TEMPORARY_REDIRECT: + +.. _class_HTTPClient_constant_RESPONSE_PERMANENT_REDIRECT: + +.. _class_HTTPClient_constant_RESPONSE_BAD_REQUEST: + +.. _class_HTTPClient_constant_RESPONSE_UNAUTHORIZED: + +.. _class_HTTPClient_constant_RESPONSE_PAYMENT_REQUIRED: + +.. _class_HTTPClient_constant_RESPONSE_FORBIDDEN: + +.. _class_HTTPClient_constant_RESPONSE_NOT_FOUND: + +.. _class_HTTPClient_constant_RESPONSE_METHOD_NOT_ALLOWED: + +.. _class_HTTPClient_constant_RESPONSE_NOT_ACCEPTABLE: + +.. _class_HTTPClient_constant_RESPONSE_PROXY_AUTHENTICATION_REQUIRED: + +.. _class_HTTPClient_constant_RESPONSE_REQUEST_TIMEOUT: + +.. _class_HTTPClient_constant_RESPONSE_CONFLICT: + +.. _class_HTTPClient_constant_RESPONSE_GONE: + +.. _class_HTTPClient_constant_RESPONSE_LENGTH_REQUIRED: + +.. _class_HTTPClient_constant_RESPONSE_PRECONDITION_FAILED: + +.. _class_HTTPClient_constant_RESPONSE_REQUEST_ENTITY_TOO_LARGE: + +.. _class_HTTPClient_constant_RESPONSE_REQUEST_URI_TOO_LONG: + +.. _class_HTTPClient_constant_RESPONSE_UNSUPPORTED_MEDIA_TYPE: + +.. _class_HTTPClient_constant_RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE: + +.. _class_HTTPClient_constant_RESPONSE_EXPECTATION_FAILED: + +.. _class_HTTPClient_constant_RESPONSE_IM_A_TEAPOT: + +.. _class_HTTPClient_constant_RESPONSE_MISDIRECTED_REQUEST: + +.. _class_HTTPClient_constant_RESPONSE_UNPROCESSABLE_ENTITY: + +.. _class_HTTPClient_constant_RESPONSE_LOCKED: + +.. _class_HTTPClient_constant_RESPONSE_FAILED_DEPENDENCY: + +.. _class_HTTPClient_constant_RESPONSE_UPGRADE_REQUIRED: + +.. _class_HTTPClient_constant_RESPONSE_PRECONDITION_REQUIRED: + +.. _class_HTTPClient_constant_RESPONSE_TOO_MANY_REQUESTS: + +.. _class_HTTPClient_constant_RESPONSE_REQUEST_HEADER_FIELDS_TOO_LARGE: + +.. _class_HTTPClient_constant_RESPONSE_UNAVAILABLE_FOR_LEGAL_REASONS: + +.. _class_HTTPClient_constant_RESPONSE_INTERNAL_SERVER_ERROR: + +.. _class_HTTPClient_constant_RESPONSE_NOT_IMPLEMENTED: + +.. _class_HTTPClient_constant_RESPONSE_BAD_GATEWAY: + +.. _class_HTTPClient_constant_RESPONSE_SERVICE_UNAVAILABLE: + +.. _class_HTTPClient_constant_RESPONSE_GATEWAY_TIMEOUT: + +.. _class_HTTPClient_constant_RESPONSE_HTTP_VERSION_NOT_SUPPORTED: + +.. _class_HTTPClient_constant_RESPONSE_VARIANT_ALSO_NEGOTIATES: + +.. _class_HTTPClient_constant_RESPONSE_INSUFFICIENT_STORAGE: + +.. _class_HTTPClient_constant_RESPONSE_LOOP_DETECTED: + +.. _class_HTTPClient_constant_RESPONSE_NOT_EXTENDED: + +.. _class_HTTPClient_constant_RESPONSE_NETWORK_AUTH_REQUIRED: + enum **ResponseCode**: - **RESPONSE_CONTINUE** = **100** --- HTTP status code ``100 Continue``. Interim response that indicates everything so far is OK and that the client should continue with the request (or ignore this status if already finished). @@ -242,7 +404,7 @@ 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. -Note that 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. +Note that 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. A ``HTTPClient`` should be reused between multiple requests or to connect to different hosts instead of creating one client per request. Supports SSL and SSL server certificate verification. HTTP status codes in the 2xx range indicate success, 3xx redirection (i.e. "try again, but over here"), 4xx something was wrong with the request, and 5xx something went wrong on the server's side. @@ -258,7 +420,7 @@ Tutorials Property Descriptions --------------------- -.. _class_HTTPClient_blocking_mode_enabled: +.. _class_HTTPClient_property_blocking_mode_enabled: - :ref:`bool` **blocking_mode_enabled** @@ -270,7 +432,7 @@ Property Descriptions If ``true``, execution will block until all data is read from the response. -.. _class_HTTPClient_connection: +.. _class_HTTPClient_property_connection: - :ref:`StreamPeer` **connection** @@ -285,13 +447,13 @@ The connection to use for this client. Method Descriptions ------------------- -.. _class_HTTPClient_close: +.. _class_HTTPClient_method_close: - void **close** **(** **)** Closes the current connection, allowing reuse of this ``HTTPClient``. -.. _class_HTTPClient_connect_to_host: +.. _class_HTTPClient_method_connect_to_host: - :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** @@ -303,25 +465,25 @@ If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 f ``verify_host`` will check the SSL identity of the host if set to ``true``. -.. _class_HTTPClient_get_response_body_length: +.. _class_HTTPClient_method_get_response_body_length: - :ref:`int` **get_response_body_length** **(** **)** const Returns the response's body length. -.. _class_HTTPClient_get_response_code: +.. _class_HTTPClient_method_get_response_code: - :ref:`int` **get_response_code** **(** **)** const Returns the response's HTTP status code. -.. _class_HTTPClient_get_response_headers: +.. _class_HTTPClient_method_get_response_headers: - :ref:`PoolStringArray` **get_response_headers** **(** **)** Returns the response headers. -.. _class_HTTPClient_get_response_headers_as_dictionary: +.. _class_HTTPClient_method_get_response_headers_as_dictionary: - :ref:`Dictionary` **get_response_headers_as_dictionary** **(** **)** @@ -331,31 +493,31 @@ Structure: ("key":"value1; value2") Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) -.. _class_HTTPClient_get_status: +.. _class_HTTPClient_method_get_status: - :ref:`Status` **get_status** **(** **)** const -Returns a STATUS\_\* enum constant. Need to call :ref:`poll` in order to get status updates. +Returns a STATUS\_\* enum constant. Need to call :ref:`poll` in order to get status updates. -.. _class_HTTPClient_has_response: +.. _class_HTTPClient_method_has_response: - :ref:`bool` **has_response** **(** **)** const If ``true``, this ``HTTPClient`` has a response available. -.. _class_HTTPClient_is_response_chunked: +.. _class_HTTPClient_method_is_response_chunked: - :ref:`bool` **is_response_chunked** **(** **)** const If ``true``, this ``HTTPClient`` has a response that is chunked. -.. _class_HTTPClient_poll: +.. _class_HTTPClient_method_poll: - :ref:`Error` **poll** **(** **)** -This needs to be called in order to have any request processed. Check results with :ref:`get_status` +This needs to be called in order to have any request processed. Check results with :ref:`get_status` -.. _class_HTTPClient_query_string_from_dict: +.. _class_HTTPClient_method_query_string_from_dict: - :ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** @@ -375,13 +537,13 @@ Furthermore, if a key has a null value, only the key itself is added, without eq String query_string = http_client.query_string_from_dict(fields) # returns: "single=123¬_valued&multiple=22&multiple=33&multiple=44" -.. _class_HTTPClient_read_response_body_chunk: +.. _class_HTTPClient_method_read_response_body_chunk: - :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** Reads one chunk from the response. -.. _class_HTTPClient_request: +.. _class_HTTPClient_method_request: - :ref:`Error` **request** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** @@ -398,7 +560,7 @@ 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) -.. _class_HTTPClient_request_raw: +.. _class_HTTPClient_method_request_raw: - :ref:`Error` **request_raw** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** @@ -408,9 +570,9 @@ Headers are HTTP request headers. For available HTTP methods, see ``METHOD_*``. Sends the body data raw, as a byte array and does not encode it in any way. -.. _class_HTTPClient_set_read_chunk_size: +.. _class_HTTPClient_method_set_read_chunk_size: - void **set_read_chunk_size** **(** :ref:`int` bytes **)** -Sets the size of the buffer used and maximum bytes to read per iteration. see :ref:`read_response_body_chunk` +Sets the size of the buffer used and maximum bytes to read per iteration. see :ref:`read_response_body_chunk` diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index bba35d2e0..3350259ef 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -19,35 +19,35 @@ A node with the ability to send HTTP requests. Properties ---------- -+-----------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`body_size_limit` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`download_file` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`max_redirects` | -+-----------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`use_threads` | -+-----------------------------+-----------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_size_limit` | ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`download_file` | ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`max_redirects` | ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_threads` | ++-----------------------------+--------------------------------------------------------------------+ Methods ------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cancel_request` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** 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="" **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cancel_request` **(** **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** 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="" **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_HTTPRequest_request_completed: +.. _class_HTTPRequest_signal_request_completed: - **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** @@ -58,6 +58,30 @@ Enumerations .. _enum_HTTPRequest_Result: +.. _class_HTTPRequest_constant_RESULT_SUCCESS: + +.. _class_HTTPRequest_constant_RESULT_CHUNKED_BODY_SIZE_MISMATCH: + +.. _class_HTTPRequest_constant_RESULT_CANT_CONNECT: + +.. _class_HTTPRequest_constant_RESULT_CANT_RESOLVE: + +.. _class_HTTPRequest_constant_RESULT_CONNECTION_ERROR: + +.. _class_HTTPRequest_constant_RESULT_SSL_HANDSHAKE_ERROR: + +.. _class_HTTPRequest_constant_RESULT_NO_RESPONSE: + +.. _class_HTTPRequest_constant_RESULT_BODY_SIZE_LIMIT_EXCEEDED: + +.. _class_HTTPRequest_constant_RESULT_REQUEST_FAILED: + +.. _class_HTTPRequest_constant_RESULT_DOWNLOAD_FILE_CANT_OPEN: + +.. _class_HTTPRequest_constant_RESULT_DOWNLOAD_FILE_WRITE_ERROR: + +.. _class_HTTPRequest_constant_RESULT_REDIRECT_LIMIT_REACHED: + enum **Result**: - **RESULT_SUCCESS** = **0** --- Request successful. @@ -74,7 +98,7 @@ enum **Result**: - **RESULT_NO_RESPONSE** = **6** --- Request does not have a response (yet). -- **RESULT_BODY_SIZE_LIMIT_EXCEEDED** = **7** --- Request exceeded its maximum size limit, see :ref:`body_size_limit`. +- **RESULT_BODY_SIZE_LIMIT_EXCEEDED** = **7** --- Request exceeded its maximum size limit, see :ref:`body_size_limit`. - **RESULT_REQUEST_FAILED** = **8** --- Request failed. (Unused) @@ -82,7 +106,7 @@ enum **Result**: - **RESULT_DOWNLOAD_FILE_WRITE_ERROR** = **10** --- HTTPRequest couldn't write to the download file. -- **RESULT_REDIRECT_LIMIT_REACHED** = **11** --- Request reached its maximum redirect limit, see :ref:`max_redirects`. +- **RESULT_REDIRECT_LIMIT_REACHED** = **11** --- Request reached its maximum redirect limit, see :ref:`max_redirects`. Description ----------- @@ -99,7 +123,7 @@ Tutorials Property Descriptions --------------------- -.. _class_HTTPRequest_body_size_limit: +.. _class_HTTPRequest_property_body_size_limit: - :ref:`int` **body_size_limit** @@ -111,7 +135,7 @@ Property Descriptions Maximum allowed size for response bodies. -.. _class_HTTPRequest_download_file: +.. _class_HTTPRequest_property_download_file: - :ref:`String` **download_file** @@ -123,7 +147,7 @@ Maximum allowed size for response bodies. The file to download into. Will output any received file into it. -.. _class_HTTPRequest_max_redirects: +.. _class_HTTPRequest_property_max_redirects: - :ref:`int` **max_redirects** @@ -135,7 +159,7 @@ The file to download into. Will output any received file into it. Maximum number of allowed redirects. -.. _class_HTTPRequest_use_threads: +.. _class_HTTPRequest_property_use_threads: - :ref:`bool` **use_threads** @@ -150,35 +174,35 @@ If ``true``, multithreading is used to improve performance. Method Descriptions ------------------- -.. _class_HTTPRequest_cancel_request: +.. _class_HTTPRequest_method_cancel_request: - void **cancel_request** **(** **)** Cancels the current request. -.. _class_HTTPRequest_get_body_size: +.. _class_HTTPRequest_method_get_body_size: - :ref:`int` **get_body_size** **(** **)** const Returns the response body length. -.. _class_HTTPRequest_get_downloaded_bytes: +.. _class_HTTPRequest_method_get_downloaded_bytes: - :ref:`int` **get_downloaded_bytes** **(** **)** const Returns the amount of bytes this HTTPRequest downloaded. -.. _class_HTTPRequest_get_http_client_status: +.. _class_HTTPRequest_method_get_http_client_status: - :ref:`Status` **get_http_client_status** **(** **)** const Returns the current status of the underlying :ref:`HTTPClient`. See ``STATUS_*`` enum on :ref:`HTTPClient`. -.. _class_HTTPRequest_request: +.. _class_HTTPRequest_method_request: - :ref:`Error` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** -Creates request on the underlying :ref:`HTTPClient`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. +Creates request on the underlying :ref:`HTTPClient`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. Returns ``OK`` if request is successfully created. (Does not imply that the server has responded), ``ERR_UNCONFIGURED`` if not in the tree, ``ERR_BUSY`` if still processing previous request, ``ERR_INVALID_PARAMETER`` if given string is not a valid URL format, or ``ERR_CANT_CONNECT`` if not using thread and the :ref:`HTTPClient` cannot connect to host. diff --git a/classes/class_image.rst b/classes/class_image.rst index 98e616ac7..e3f9bba60 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -19,120 +19,196 @@ Image datatype. Properties ---------- -+-------------------------------------+-------------------------------+ -| :ref:`Dictionary` | :ref:`data` | -+-------------------------------------+-------------------------------+ ++-------------------------------------+----------------------------------------+ +| :ref:`Dictionary` | :ref:`data` | ++-------------------------------------+----------------------------------------+ Methods ------- -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bumpmap_to_normalmap` **(** :ref:`float` bump_scale=1.0 **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_mipmaps` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`compress` **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`convert` **(** :ref:`Format` format **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_from` **(** :ref:`Image` src **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`crop` **(** :ref:`int` width, :ref:`int` height **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`decompress` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AlphaMode` | :ref:`detect_alpha` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`expand_x2_hq2x` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`Color` color **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fix_alpha_edges` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`flip_x` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`flip_y` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`generate_mipmaps` **(** :ref:`bool` renormalize=false **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** 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_pixelv` **(** :ref:`Vector2` src **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_mipmaps` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_compressed` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_invisible` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_jpg_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_png_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_webp_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`normalmap_to_xy` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`premultiply_alpha` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`rgbe_to_srgb` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pixelv` **(** :ref:`Vector2` dst, :ref:`Color` color **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shrink_x2` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`srgb_to_linear` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bumpmap_to_normalmap` **(** :ref:`float` bump_scale=1.0 **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_mipmaps` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`compress` **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`convert` **(** :ref:`Format` format **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_from` **(** :ref:`Image` src **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`crop` **(** :ref:`int` width, :ref:`int` height **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`decompress` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AlphaMode` | :ref:`detect_alpha` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`expand_x2_hq2x` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`Color` color **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fix_alpha_edges` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`flip_x` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`flip_y` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`generate_mipmaps` **(** :ref:`bool` renormalize=false **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Format` | :ref:`get_format` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** 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_pixelv` **(** :ref:`Vector2` src **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_mipmaps` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_invisible` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_jpg_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_png_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_webp_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`normalmap_to_xy` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`premultiply_alpha` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`rgbe_to_srgb` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pixelv` **(** :ref:`Vector2` dst, :ref:`Color` color **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shrink_x2` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`srgb_to_linear` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Image_Format: +.. _class_Image_constant_FORMAT_L8: + +.. _class_Image_constant_FORMAT_LA8: + +.. _class_Image_constant_FORMAT_R8: + +.. _class_Image_constant_FORMAT_RG8: + +.. _class_Image_constant_FORMAT_RGB8: + +.. _class_Image_constant_FORMAT_RGBA8: + +.. _class_Image_constant_FORMAT_RGBA4444: + +.. _class_Image_constant_FORMAT_RGBA5551: + +.. _class_Image_constant_FORMAT_RF: + +.. _class_Image_constant_FORMAT_RGF: + +.. _class_Image_constant_FORMAT_RGBF: + +.. _class_Image_constant_FORMAT_RGBAF: + +.. _class_Image_constant_FORMAT_RH: + +.. _class_Image_constant_FORMAT_RGH: + +.. _class_Image_constant_FORMAT_RGBH: + +.. _class_Image_constant_FORMAT_RGBAH: + +.. _class_Image_constant_FORMAT_RGBE9995: + +.. _class_Image_constant_FORMAT_DXT1: + +.. _class_Image_constant_FORMAT_DXT3: + +.. _class_Image_constant_FORMAT_DXT5: + +.. _class_Image_constant_FORMAT_RGTC_R: + +.. _class_Image_constant_FORMAT_RGTC_RG: + +.. _class_Image_constant_FORMAT_BPTC_RGBA: + +.. _class_Image_constant_FORMAT_BPTC_RGBF: + +.. _class_Image_constant_FORMAT_BPTC_RGBFU: + +.. _class_Image_constant_FORMAT_PVRTC2: + +.. _class_Image_constant_FORMAT_PVRTC2A: + +.. _class_Image_constant_FORMAT_PVRTC4: + +.. _class_Image_constant_FORMAT_PVRTC4A: + +.. _class_Image_constant_FORMAT_ETC: + +.. _class_Image_constant_FORMAT_ETC2_R11: + +.. _class_Image_constant_FORMAT_ETC2_R11S: + +.. _class_Image_constant_FORMAT_ETC2_RG11: + +.. _class_Image_constant_FORMAT_ETC2_RG11S: + +.. _class_Image_constant_FORMAT_ETC2_RGB8: + +.. _class_Image_constant_FORMAT_ETC2_RGBA8: + +.. _class_Image_constant_FORMAT_ETC2_RGB8A1: + +.. _class_Image_constant_FORMAT_MAX: + enum **Format**: - **FORMAT_L8** = **0** @@ -213,6 +289,14 @@ enum **Format**: .. _enum_Image_Interpolation: +.. _class_Image_constant_INTERPOLATE_NEAREST: + +.. _class_Image_constant_INTERPOLATE_BILINEAR: + +.. _class_Image_constant_INTERPOLATE_CUBIC: + +.. _class_Image_constant_INTERPOLATE_TRILINEAR: + enum **Interpolation**: - **INTERPOLATE_NEAREST** = **0** @@ -231,6 +315,12 @@ On the other hand, if the image already has mipmaps, they will be used, and a ne .. _enum_Image_AlphaMode: +.. _class_Image_constant_ALPHA_NONE: + +.. _class_Image_constant_ALPHA_BIT: + +.. _class_Image_constant_ALPHA_BLEND: + enum **AlphaMode**: - **ALPHA_NONE** = **0** @@ -241,6 +331,16 @@ enum **AlphaMode**: .. _enum_Image_CompressMode: +.. _class_Image_constant_COMPRESS_S3TC: + +.. _class_Image_constant_COMPRESS_PVRTC2: + +.. _class_Image_constant_COMPRESS_PVRTC4: + +.. _class_Image_constant_COMPRESS_ETC: + +.. _class_Image_constant_COMPRESS_ETC2: + enum **CompressMode**: - **COMPRESS_S3TC** = **0** @@ -255,6 +355,12 @@ enum **CompressMode**: .. _enum_Image_CompressSource: +.. _class_Image_constant_COMPRESS_SOURCE_GENERIC: + +.. _class_Image_constant_COMPRESS_SOURCE_SRGB: + +.. _class_Image_constant_COMPRESS_SOURCE_NORMAL: + enum **CompressSource**: - **COMPRESS_SOURCE_GENERIC** = **0** @@ -271,7 +377,7 @@ Native image datatype. Contains image data, which can be converted to a :ref:`Te Property Descriptions --------------------- -.. _class_Image_data: +.. _class_Image_property_data: - :ref:`Dictionary` **data** @@ -280,271 +386,271 @@ Holds all of the image's color data in a given format. See ``FORMAT_*`` constant Method Descriptions ------------------- -.. _class_Image_blend_rect: +.. _class_Image_method_blend_rect: - void **blend_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Alpha-blends ``src_rect`` from ``src`` image to this image at coordinates ``dest``. -.. _class_Image_blend_rect_mask: +.. _class_Image_method_blend_rect_mask: - void **blend_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Alpha-blends ``src_rect`` from ``src`` image to this image using ``mask`` image at coordinates ``dst``. Alpha channels are required for both ``src`` and ``mask``. ``dst`` pixels and ``src`` pixels will blend if the corresponding mask pixel's alpha value is not 0. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. -.. _class_Image_blit_rect: +.. _class_Image_method_blit_rect: - void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Copies ``src_rect`` from ``src`` image to this image at coordinates ``dst``. -.. _class_Image_blit_rect_mask: +.. _class_Image_method_blit_rect_mask: - void **blit_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Blits ``src_rect`` area from ``src`` image to this image at the coordinates given by ``dst``. ``src`` pixel is copied onto ``dst`` if the corresponding ``mask`` pixel's alpha value is not 0. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. -.. _class_Image_bumpmap_to_normalmap: +.. _class_Image_method_bumpmap_to_normalmap: - void **bumpmap_to_normalmap** **(** :ref:`float` bump_scale=1.0 **)** -.. _class_Image_clear_mipmaps: +.. _class_Image_method_clear_mipmaps: - void **clear_mipmaps** **(** **)** Removes the image's mipmaps. -.. _class_Image_compress: +.. _class_Image_method_compress: - :ref:`Error` **compress** **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See ``COMPRESS_*`` constants. -.. _class_Image_convert: +.. _class_Image_method_convert: - void **convert** **(** :ref:`Format` format **)** Converts the image's format. See ``FORMAT_*`` constants. -.. _class_Image_copy_from: +.. _class_Image_method_copy_from: - void **copy_from** **(** :ref:`Image` src **)** Copies ``src`` image to this image. -.. _class_Image_create: +.. _class_Image_method_create: - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** Creates an empty image of given size and format. See ``FORMAT_*`` constants. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. -.. _class_Image_create_from_data: +.. _class_Image_method_create_from_data: - void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** Creates a new image of given size and format. See ``FORMAT_*`` constants. Fills the image with the given raw data. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. -.. _class_Image_crop: +.. _class_Image_method_crop: - void **crop** **(** :ref:`int` width, :ref:`int` height **)** Crops the image to the given ``width`` and ``height``. If the specified size is larger than the current size, the extra area is filled with black pixels. -.. _class_Image_decompress: +.. _class_Image_method_decompress: - :ref:`Error` **decompress** **(** **)** Decompresses the image if it is compressed. Returns an error if decompress function is not available. -.. _class_Image_detect_alpha: +.. _class_Image_method_detect_alpha: - :ref:`AlphaMode` **detect_alpha** **(** **)** const Returns ALPHA_BLEND if the image has data for alpha values. Returns ALPHA_BIT if all the alpha values are below a certain threshold or the maximum value. Returns ALPHA_NONE if no data for alpha values is found. -.. _class_Image_expand_x2_hq2x: +.. _class_Image_method_expand_x2_hq2x: - void **expand_x2_hq2x** **(** **)** Stretches the image and enlarges it by a factor of 2. No interpolation is done. -.. _class_Image_fill: +.. _class_Image_method_fill: - void **fill** **(** :ref:`Color` color **)** Fills the image with a given :ref:`Color`. -.. _class_Image_fix_alpha_edges: +.. _class_Image_method_fix_alpha_edges: - void **fix_alpha_edges** **(** **)** Blends low-alpha pixels with nearby pixels. -.. _class_Image_flip_x: +.. _class_Image_method_flip_x: - void **flip_x** **(** **)** Flips the image horizontally. -.. _class_Image_flip_y: +.. _class_Image_method_flip_y: - void **flip_y** **(** **)** Flips the image vertically. -.. _class_Image_generate_mipmaps: +.. _class_Image_method_generate_mipmaps: - :ref:`Error` **generate_mipmaps** **(** :ref:`bool` renormalize=false **)** Generates mipmaps for the image. Mipmaps are pre-calculated and lower resolution copies of the image. Mipmaps are automatically used if the image needs to be scaled down when rendered. This improves image quality and the performance of the rendering. Returns an error if the image is compressed, in a custom format or if the image's width/height is 0. -.. _class_Image_get_data: +.. _class_Image_method_get_data: - :ref:`PoolByteArray` **get_data** **(** **)** const Returns the image's raw data. -.. _class_Image_get_format: +.. _class_Image_method_get_format: - :ref:`Format` **get_format** **(** **)** const Returns the image’s format. See ``FORMAT_*`` constants. -.. _class_Image_get_height: +.. _class_Image_method_get_height: - :ref:`int` **get_height** **(** **)** const Returns the image's height. -.. _class_Image_get_mipmap_offset: +.. _class_Image_method_get_mipmap_offset: - :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. -.. _class_Image_get_pixel: +.. _class_Image_method_get_pixel: - :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)``. -.. _class_Image_get_pixelv: +.. _class_Image_method_get_pixelv: - :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** const -.. _class_Image_get_rect: +.. _class_Image_method_get_rect: - :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** const Returns a new image that is a copy of the image's area specified with ``rect``. -.. _class_Image_get_size: +.. _class_Image_method_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns the image's size (width and height). -.. _class_Image_get_used_rect: +.. _class_Image_method_get_used_rect: - :ref:`Rect2` **get_used_rect** **(** **)** const Returns a :ref:`Rect2` enclosing the visible portion of the image. -.. _class_Image_get_width: +.. _class_Image_method_get_width: - :ref:`int` **get_width** **(** **)** const Returns the image's width. -.. _class_Image_has_mipmaps: +.. _class_Image_method_has_mipmaps: - :ref:`bool` **has_mipmaps** **(** **)** const Returns ``true`` if the image has generated mipmaps. -.. _class_Image_is_compressed: +.. _class_Image_method_is_compressed: - :ref:`bool` **is_compressed** **(** **)** const Returns ``true`` if the image is compressed. -.. _class_Image_is_empty: +.. _class_Image_method_is_empty: - :ref:`bool` **is_empty** **(** **)** const Returns ``true`` if the image has no data. -.. _class_Image_is_invisible: +.. _class_Image_method_is_invisible: - :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. -.. _class_Image_load: +.. _class_Image_method_load: - :ref:`Error` **load** **(** :ref:`String` path **)** Loads an image from file ``path``. -.. _class_Image_load_jpg_from_buffer: +.. _class_Image_method_load_jpg_from_buffer: - :ref:`Error` **load_jpg_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a JPEG file. -.. _class_Image_load_png_from_buffer: +.. _class_Image_method_load_png_from_buffer: - :ref:`Error` **load_png_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a PNG file. -.. _class_Image_load_webp_from_buffer: +.. _class_Image_method_load_webp_from_buffer: - :ref:`Error` **load_webp_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a WebP file. -.. _class_Image_lock: +.. _class_Image_method_lock: - void **lock** **(** **)** Locks the data for writing access. -.. _class_Image_normalmap_to_xy: +.. _class_Image_method_normalmap_to_xy: - void **normalmap_to_xy** **(** **)** Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normalmap. A normalmap can add lots of detail to a 3D surface without increasing the polygon count. -.. _class_Image_premultiply_alpha: +.. _class_Image_method_premultiply_alpha: - void **premultiply_alpha** **(** **)** Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``. -.. _class_Image_resize: +.. _class_Image_method_resize: - void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** Resizes the image to the given ``width`` and ``height``. New pixels are calculated using ``interpolation``. See ``interpolation`` constants. -.. _class_Image_resize_to_po2: +.. _class_Image_method_resize_to_po2: - void **resize_to_po2** **(** :ref:`bool` square=false **)** Resizes the image to the nearest power of 2 for the width and height. If ``square`` is ``true`` then set width and height to be the same. -.. _class_Image_rgbe_to_srgb: +.. _class_Image_method_rgbe_to_srgb: - :ref:`Image` **rgbe_to_srgb** **(** **)** -.. _class_Image_save_png: +.. _class_Image_method_save_png: - :ref:`Error` **save_png** **(** :ref:`String` path **)** const Saves the image as a PNG file to ``path``. -.. _class_Image_set_pixel: +.. _class_Image_method_set_pixel: - void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** @@ -559,23 +665,23 @@ Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is lo img.unlock() img.set_pixel(x, y, color) # Does not have an effect -.. _class_Image_set_pixelv: +.. _class_Image_method_set_pixelv: - void **set_pixelv** **(** :ref:`Vector2` dst, :ref:`Color` color **)** -.. _class_Image_shrink_x2: +.. _class_Image_method_shrink_x2: - void **shrink_x2** **(** **)** Shrinks the image by a factor of 2. -.. _class_Image_srgb_to_linear: +.. _class_Image_method_srgb_to_linear: - void **srgb_to_linear** **(** **)** Converts the raw data from the sRGB colorspace to a linear scale. -.. _class_Image_unlock: +.. _class_Image_method_unlock: - void **unlock** **(** **)** diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 7ef3e5eef..40d2ccaa0 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -19,51 +19,57 @@ A :ref:`Texture` based on an :ref:`Image`. Properties ---------- -+-------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`lossy_quality` | -+-------------------------------------------+--------------------------------------------------------+ -| :ref:`Storage` | :ref:`storage` | -+-------------------------------------------+--------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`lossy_quality` | ++-------------------------------------------+-----------------------------------------------------------------+ +| :ref:`Storage` | :ref:`storage` | ++-------------------------------------------+-----------------------------------------------------------------+ Methods ------- -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`Image` image **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Format` | :ref:`get_format` **(** **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`Image` image **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_ImageTexture_Storage: +.. _class_ImageTexture_constant_STORAGE_RAW: + +.. _class_ImageTexture_constant_STORAGE_COMPRESS_LOSSY: + +.. _class_ImageTexture_constant_STORAGE_COMPRESS_LOSSLESS: + enum **Storage**: - **STORAGE_RAW** = **0** --- :ref:`Image` data is stored raw and unaltered. -- **STORAGE_COMPRESS_LOSSY** = **1** --- :ref:`Image` data is compressed with a lossy algorithm. You can set the storage quality with :ref:`lossy_quality`. +- **STORAGE_COMPRESS_LOSSY** = **1** --- :ref:`Image` data is compressed with a lossy algorithm. You can set the storage quality with :ref:`lossy_quality`. - **STORAGE_COMPRESS_LOSSLESS** = **2** --- :ref:`Image` data is compressed with a lossless algorithm. Description ----------- -A :ref:`Texture` based on an :ref:`Image`. Can be created from an :ref:`Image` with :ref:`create_from_image`. +A :ref:`Texture` based on an :ref:`Image`. Can be created from an :ref:`Image` with :ref:`create_from_image`. Property Descriptions --------------------- -.. _class_ImageTexture_lossy_quality: +.. _class_ImageTexture_property_lossy_quality: - :ref:`float` **lossy_quality** @@ -75,7 +81,7 @@ Property Descriptions The storage quality for ``STORAGE_COMPRESS_LOSSY``. -.. _class_ImageTexture_storage: +.. _class_ImageTexture_property_storage: - :ref:`Storage` **storage** @@ -90,7 +96,7 @@ The storage type (raw, lossy, or compressed). Method Descriptions ------------------- -.. _class_ImageTexture_create: +.. _class_ImageTexture_method_create: - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** @@ -98,31 +104,31 @@ Create a new ``ImageTexture`` with ``width`` and ``height``. ``format`` is a value from :ref:`Format`, ``flags`` is any combination of :ref:`Flags`. -.. _class_ImageTexture_create_from_image: +.. _class_ImageTexture_method_create_from_image: - void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** Create a new ``ImageTexture`` from an :ref:`Image` with ``flags`` from :ref:`Flags`. An sRGB to linear color space conversion can take place, according to :ref:`Format`. -.. _class_ImageTexture_get_format: +.. _class_ImageTexture_method_get_format: - :ref:`Format` **get_format** **(** **)** const Return the format of the ``ImageTexture``, one of :ref:`Format`. -.. _class_ImageTexture_load: +.. _class_ImageTexture_method_load: - :ref:`Error` **load** **(** :ref:`String` path **)** Load an ``ImageTexture`` from a file path. -.. _class_ImageTexture_set_data: +.. _class_ImageTexture_method_set_data: - void **set_data** **(** :ref:`Image` image **)** Set the :ref:`Image` of this ``ImageTexture``. -.. _class_ImageTexture_set_size_override: +.. _class_ImageTexture_method_set_size_override: - void **set_size_override** **(** :ref:`Vector2` size **)** diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index 96a4ff8ee..3157c89dd 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -19,27 +19,27 @@ Draws simple geometry from code. Methods ------- -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` position **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`end` **(** **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal` **(** :ref:`Vector3` normal **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tangent` **(** :ref:`Plane` tangent **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv` **(** :ref:`Vector2` uv **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2` **(** :ref:`Vector2` uv **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_vertex` **(** :ref:`Vector3` position **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`end` **(** **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal` **(** :ref:`Vector3` normal **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tangent` **(** :ref:`Plane` tangent **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv` **(** :ref:`Vector2` uv **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2` **(** :ref:`Vector2` uv **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,19 +49,19 @@ Draws simple geometry from code. Uses a drawing mode similar to OpenGL 1.x. Method Descriptions ------------------- -.. _class_ImmediateGeometry_add_sphere: +.. _class_ImmediateGeometry_method_add_sphere: - void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** Simple helper to draw a uvsphere, with given latitudes, longitude and radius. -.. _class_ImmediateGeometry_add_vertex: +.. _class_ImmediateGeometry_method_add_vertex: - void **add_vertex** **(** :ref:`Vector3` position **)** Adds a vertex with the currently set color/uv/etc. -.. _class_ImmediateGeometry_begin: +.. _class_ImmediateGeometry_method_begin: - void **begin** **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** @@ -69,43 +69,43 @@ Begin drawing (And optionally pass a texture override). When done call end(). Fo For the type of primitive, use the :ref:`Mesh`.PRIMITIVE\_\* enumerations. -.. _class_ImmediateGeometry_clear: +.. _class_ImmediateGeometry_method_clear: - void **clear** **(** **)** Clears everything that was drawn using begin/end. -.. _class_ImmediateGeometry_end: +.. _class_ImmediateGeometry_method_end: - void **end** **(** **)** Ends a drawing context and displays the results. -.. _class_ImmediateGeometry_set_color: +.. _class_ImmediateGeometry_method_set_color: - void **set_color** **(** :ref:`Color` color **)** The current drawing color. -.. _class_ImmediateGeometry_set_normal: +.. _class_ImmediateGeometry_method_set_normal: - void **set_normal** **(** :ref:`Vector3` normal **)** The next vertex's normal. -.. _class_ImmediateGeometry_set_tangent: +.. _class_ImmediateGeometry_method_set_tangent: - void **set_tangent** **(** :ref:`Plane` tangent **)** The next vertex's tangent (and binormal facing). -.. _class_ImmediateGeometry_set_uv: +.. _class_ImmediateGeometry_method_set_uv: - void **set_uv** **(** :ref:`Vector2` uv **)** The next vertex's UV. -.. _class_ImmediateGeometry_set_uv2: +.. _class_ImmediateGeometry_method_set_uv2: - void **set_uv2** **(** :ref:`Vector2` uv **)** diff --git a/classes/class_input.rst b/classes/class_input.rst index 76e825d00..d86f4cd73 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -21,86 +21,86 @@ A Singleton that deals with inputs. Methods ------- -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_press` **(** :ref:`String` action, :ref:`float` strength=1.0 **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_release` **(** :ref:`String` action **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** 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 **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_name` **(** :ref:`int` device **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** 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_released` **(** :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_known` **(** :ref:`int` device **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** 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 **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | -+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_press` **(** :ref:`String` action, :ref:`float` strength=1.0 **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_release` **(** :ref:`String` action **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** 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 **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_name` **(** :ref:`int` device **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** 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_released` **(** :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_known` **(** :ref:`int` device **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** 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 **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Input_joy_connection_changed: +.. _class_Input_signal_joy_connection_changed: - **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected **)** @@ -111,6 +111,14 @@ Enumerations .. _enum_Input_MouseMode: +.. _class_Input_constant_MOUSE_MODE_VISIBLE: + +.. _class_Input_constant_MOUSE_MODE_HIDDEN: + +.. _class_Input_constant_MOUSE_MODE_CAPTURED: + +.. _class_Input_constant_MOUSE_MODE_CONFINED: + enum **MouseMode**: - **MOUSE_MODE_VISIBLE** = **0** --- Makes the mouse cursor visible if it is hidden. @@ -123,6 +131,40 @@ enum **MouseMode**: .. _enum_Input_CursorShape: +.. _class_Input_constant_CURSOR_ARROW: + +.. _class_Input_constant_CURSOR_IBEAM: + +.. _class_Input_constant_CURSOR_POINTING_HAND: + +.. _class_Input_constant_CURSOR_CROSS: + +.. _class_Input_constant_CURSOR_WAIT: + +.. _class_Input_constant_CURSOR_BUSY: + +.. _class_Input_constant_CURSOR_DRAG: + +.. _class_Input_constant_CURSOR_CAN_DROP: + +.. _class_Input_constant_CURSOR_FORBIDDEN: + +.. _class_Input_constant_CURSOR_VSIZE: + +.. _class_Input_constant_CURSOR_HSIZE: + +.. _class_Input_constant_CURSOR_BDIAGSIZE: + +.. _class_Input_constant_CURSOR_FDIAGSIZE: + +.. _class_Input_constant_CURSOR_MOVE: + +.. _class_Input_constant_CURSOR_VSPLIT: + +.. _class_Input_constant_CURSOR_HSPLIT: + +.. _class_Input_constant_CURSOR_HELP: + enum **CursorShape**: - **CURSOR_ARROW** = **0** --- Arrow cursor. Standard, default pointing cursor. @@ -172,7 +214,7 @@ Tutorials Method Descriptions ------------------- -.. _class_Input_action_press: +.. _class_Input_method_action_press: - void **action_press** **(** :ref:`String` action, :ref:`float` strength=1.0 **)** @@ -180,19 +222,19 @@ This will simulate pressing the specified action. The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action. -.. _class_Input_action_release: +.. _class_Input_method_action_release: - void **action_release** **(** :ref:`String` action **)** If the specified action is already pressed, this will release it. -.. _class_Input_add_joy_mapping: +.. _class_Input_method_add_joy_mapping: - void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. -.. _class_Input_get_accelerometer: +.. _class_Input_method_get_accelerometer: - :ref:`Vector3` **get_accelerometer** **(** **)** const @@ -200,109 +242,109 @@ If the device has an accelerometer, this will return the acceleration. Otherwise 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. -.. _class_Input_get_action_strength: +.. _class_Input_method_get_action_strength: - :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. -.. _class_Input_get_connected_joypads: +.. _class_Input_method_get_connected_joypads: - :ref:`Array` **get_connected_joypads** **(** **)** Returns an :ref:`Array` containing the device IDs of all currently connected joypads. -.. _class_Input_get_gravity: +.. _class_Input_method_get_gravity: - :ref:`Vector3` **get_gravity** **(** **)** const If the device has an accelerometer, this will return the gravity. Otherwise, it returns an empty :ref:`Vector3`. -.. _class_Input_get_gyroscope: +.. _class_Input_method_get_gyroscope: - :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 axis. Otherwise, it returns an empty :ref:`Vector3`. -.. _class_Input_get_joy_axis: +.. _class_Input_method_get_joy_axis: - :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const Returns the current value of the joypad axis at given index (see ``JOY_*`` constants in :ref:`@GlobalScope`) -.. _class_Input_get_joy_axis_index_from_string: +.. _class_Input_method_get_joy_axis_index_from_string: - :ref:`int` **get_joy_axis_index_from_string** **(** :ref:`String` axis **)** Returns the index of the provided axis name. -.. _class_Input_get_joy_axis_string: +.. _class_Input_method_get_joy_axis_string: - :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** Receives a ``JOY_AXIS_*`` Enum and returns its equivalent name as a string. -.. _class_Input_get_joy_button_index_from_string: +.. _class_Input_method_get_joy_button_index_from_string: - :ref:`int` **get_joy_button_index_from_string** **(** :ref:`String` button **)** Returns the index of the provided button name. -.. _class_Input_get_joy_button_string: +.. _class_Input_method_get_joy_button_string: - :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** Receives a ``JOY_BUTTON_*`` Enum and returns its equivalent name as a string. -.. _class_Input_get_joy_guid: +.. _class_Input_method_get_joy_guid: - :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. -.. _class_Input_get_joy_name: +.. _class_Input_method_get_joy_name: - :ref:`String` **get_joy_name** **(** :ref:`int` device **)** Returns the name of the joypad at the specified device index -.. _class_Input_get_joy_vibration_duration: +.. _class_Input_method_get_joy_vibration_duration: - :ref:`float` **get_joy_vibration_duration** **(** :ref:`int` device **)** Returns the duration of the current vibration effect in seconds. -.. _class_Input_get_joy_vibration_strength: +.. _class_Input_method_get_joy_vibration_strength: - :ref:`Vector2` **get_joy_vibration_strength** **(** :ref:`int` device **)** Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. -.. _class_Input_get_last_mouse_speed: +.. _class_Input_method_get_last_mouse_speed: - :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. -.. _class_Input_get_magnetometer: +.. _class_Input_method_get_magnetometer: - :ref:`Vector3` **get_magnetometer** **(** **)** const If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. -.. _class_Input_get_mouse_button_mask: +.. _class_Input_method_get_mouse_button_mask: - :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. -.. _class_Input_get_mouse_mode: +.. _class_Input_method_get_mouse_mode: - :ref:`MouseMode` **get_mouse_mode** **(** **)** const Return the mouse mode. See the constants for more information. -.. _class_Input_is_action_just_pressed: +.. _class_Input_method_is_action_just_pressed: - :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const @@ -310,59 +352,59 @@ Returns ``true`` when the user starts pressing the action event, meaning it's tr This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. -.. _class_Input_is_action_just_released: +.. _class_Input_method_is_action_just_released: - :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. -.. _class_Input_is_action_pressed: +.. _class_Input_method_is_action_pressed: - :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const Returns ``true`` if you are pressing the action event. -.. _class_Input_is_joy_button_pressed: +.. _class_Input_method_is_joy_button_pressed: - :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const Returns ``true`` if you are pressing the joypad button. (see ``JOY_*`` constants in :ref:`@GlobalScope`) -.. _class_Input_is_joy_known: +.. _class_Input_method_is_joy_known: - :ref:`bool` **is_joy_known** **(** :ref:`int` device **)** Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY_*`` constants (see :ref:`@GlobalScope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. -.. _class_Input_is_key_pressed: +.. _class_Input_method_is_key_pressed: - :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** const Returns ``true`` if you are pressing the key. You can pass ``KEY_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. -.. _class_Input_is_mouse_button_pressed: +.. _class_Input_method_is_mouse_button_pressed: - :ref:`bool` **is_mouse_button_pressed** **(** :ref:`int` button **)** const Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. -.. _class_Input_joy_connection_changed: +.. _class_Input_method_joy_connection_changed: - void **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** -.. _class_Input_parse_input_event: +.. _class_Input_method_parse_input_event: - void **parse_input_event** **(** :ref:`InputEvent` event **)** Feeds an :ref:`InputEvent` to the game. Can be used to artificially trigger input events from code. -.. _class_Input_remove_joy_mapping: +.. _class_Input_method_remove_joy_mapping: - void **remove_joy_mapping** **(** :ref:`String` guid **)** Removes all mappings from the internal db that match the given uid. -.. _class_Input_set_custom_mouse_cursor: +.. _class_Input_method_set_custom_mouse_cursor: - void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** @@ -372,21 +414,21 @@ Sets a custom mouse cursor image, which is only visible inside the game window. ``hotspot`` must be within ``image``'s size. -.. _class_Input_set_default_cursor_shape: +.. _class_Input_method_set_default_cursor_shape: - void **set_default_cursor_shape** **(** :ref:`CursorShape` shape=0 **)** Sets the default cursor shape to be used in the viewport instead of ``CURSOR_ARROW``. -Note that if you want to change the default cursor shape for :ref:`Control`'s nodes, use :ref:`Control.mouse_default_cursor_shape` instead. +Note that if you want to change the default cursor shape for :ref:`Control`'s nodes, use :ref:`Control.mouse_default_cursor_shape` instead. -.. _class_Input_set_mouse_mode: +.. _class_Input_method_set_mouse_mode: - void **set_mouse_mode** **(** :ref:`MouseMode` mode **)** Set the mouse mode. See the constants for more information. -.. _class_Input_start_joy_vibration: +.. _class_Input_method_start_joy_vibration: - void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** @@ -394,13 +436,13 @@ Starts to vibrate the joypad. Joypads usually come with two rumble motors, a str Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds. -.. _class_Input_stop_joy_vibration: +.. _class_Input_method_stop_joy_vibration: - void **stop_joy_vibration** **(** :ref:`int` device **)** Stops the vibration of the joypad. -.. _class_Input_warp_mouse_position: +.. _class_Input_method_warp_mouse_position: - void **warp_mouse_position** **(** :ref:`Vector2` to **)** diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index dbb37dd0b..9bbc1d980 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -21,39 +21,39 @@ Generic input event Properties ---------- -+-----------------------+----------------------------------------+ -| :ref:`int` | :ref:`device` | -+-----------------------+----------------------------------------+ ++-----------------------+-------------------------------------------------+ +| :ref:`int` | :ref:`device` | ++-----------------------+-------------------------------------------------+ Methods ------- -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** 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:`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 **)** 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 | ++-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Base class of all sort of input event. See :ref:`Node._input`. +Base class of all sort of input event. See :ref:`Node._input`. Tutorials --------- @@ -65,7 +65,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEvent_device: +.. _class_InputEvent_property_device: - :ref:`int` **device** @@ -80,57 +80,57 @@ The event's device ID. Method Descriptions ------------------- -.. _class_InputEvent_as_text: +.. _class_InputEvent_method_as_text: - :ref:`String` **as_text** **(** **)** const Returns a :ref:`String` representation of the event. -.. _class_InputEvent_get_action_strength: +.. _class_InputEvent_method_get_action_strength: - :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const -.. _class_InputEvent_is_action: +.. _class_InputEvent_method_is_action: - :ref:`bool` **is_action** **(** :ref:`String` action **)** const Returns ``true`` if this input event matches a pre-defined action of any type. -.. _class_InputEvent_is_action_pressed: +.. _class_InputEvent_method_is_action_pressed: - :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const Returns ``true`` if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types ``MOUSE_MOTION``, ``SCREEN_DRAG`` or ``NONE``. -.. _class_InputEvent_is_action_released: +.. _class_InputEvent_method_is_action_released: - :ref:`bool` **is_action_released** **(** :ref:`String` action **)** const Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for the event types ``MOUSE_MOTION``, ``SCREEN_DRAG`` or ``NONE``. -.. _class_InputEvent_is_action_type: +.. _class_InputEvent_method_is_action_type: - :ref:`bool` **is_action_type** **(** **)** const Returns ``true`` if this input event's type is one of the ``InputEvent`` constants. -.. _class_InputEvent_is_echo: +.. _class_InputEvent_method_is_echo: - :ref:`bool` **is_echo** **(** **)** const Returns ``true`` if this input event is an echo event (only for events of type KEY). -.. _class_InputEvent_is_pressed: +.. _class_InputEvent_method_is_pressed: - :ref:`bool` **is_pressed** **(** **)** const Returns ``true`` if this input event is pressed. Not relevant for the event types ``MOUSE_MOTION``, ``SCREEN_DRAG`` or ``NONE``. -.. _class_InputEvent_shortcut_match: +.. _class_InputEvent_method_shortcut_match: - :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const -.. _class_InputEvent_xformed_by: +.. _class_InputEvent_method_xformed_by: - :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 1a9ae5a0d..956a36c33 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -19,16 +19,16 @@ Input event type for actions. Properties ---------- -+-----------------------------+------------------------------------------------+ -| :ref:`String` | :ref:`action` | -+-----------------------------+------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+-----------------------------+------------------------------------------------+ ++-----------------------------+---------------------------------------------------------+ +| :ref:`String` | :ref:`action` | ++-----------------------------+---------------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++-----------------------------+---------------------------------------------------------+ Description ----------- -Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu ``Project > Project Settings > Input Map``. See :ref:`Node._input`. +Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu ``Project > Project Settings > Input Map``. See :ref:`Node._input`. Tutorials --------- @@ -38,7 +38,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventAction_action: +.. _class_InputEventAction_property_action: - :ref:`String` **action** @@ -50,7 +50,7 @@ Property Descriptions The action's name. Actions are accessed via this :ref:`String`. -.. _class_InputEventAction_pressed: +.. _class_InputEventAction_property_pressed: - :ref:`bool` **pressed** diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 04256fffa..2d7267b11 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -21,14 +21,14 @@ Brief Description Properties ---------- -+-------------------------------+---------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+---------------------------------------------------+ ++-------------------------------+------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_InputEventGesture_position: +.. _class_InputEventGesture_property_position: - :ref:`Vector2` **position** diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 334c99512..d4acf638d 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -19,13 +19,13 @@ Input event for gamepad buttons. Properties ---------- -+---------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`button_index` | -+---------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+---------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`pressure` | -+---------------------------+----------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------+ +| :ref:`int` | :ref:`button_index` | ++---------------------------+-------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++---------------------------+-------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pressure` | ++---------------------------+-------------------------------------------------------------------------+ Description ----------- @@ -40,7 +40,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventJoypadButton_button_index: +.. _class_InputEventJoypadButton_property_button_index: - :ref:`int` **button_index** @@ -52,7 +52,7 @@ Property Descriptions Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope`. -.. _class_InputEventJoypadButton_pressed: +.. _class_InputEventJoypadButton_property_pressed: - :ref:`bool` **pressed** @@ -64,7 +64,7 @@ Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope If ``true``, the button's state is pressed. If ``false``, the button's state is released. -.. _class_InputEventJoypadButton_pressure: +.. _class_InputEventJoypadButton_property_pressure: - :ref:`float` **pressure** diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 00c02fdb2..a380e104b 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -19,11 +19,11 @@ Input event type for gamepad joysticks and other motions. For buttons see ``Inpu Properties ---------- -+---------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`axis` | -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`axis_value` | -+---------------------------+------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------+ +| :ref:`int` | :ref:`axis` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`axis_value` | ++---------------------------+---------------------------------------------------------------------+ Description ----------- @@ -38,7 +38,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventJoypadMotion_axis: +.. _class_InputEventJoypadMotion_property_axis: - :ref:`int` **axis** @@ -50,7 +50,7 @@ Property Descriptions Axis identifier. Use one of the ``JOY_AXIS_*`` constants in :ref:`@GlobalScope`. -.. _class_InputEventJoypadMotion_axis_value: +.. _class_InputEventJoypadMotion_property_axis_value: - :ref:`float` **axis_value** diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index e22b5497d..0e258ec6c 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -19,27 +19,27 @@ Input event type for keyboard events. Properties ---------- -+-------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`echo` | -+-------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+-------------------------+-----------------------------------------------+ -| :ref:`int` | :ref:`scancode` | -+-------------------------+-----------------------------------------------+ -| :ref:`int` | :ref:`unicode` | -+-------------------------+-----------------------------------------------+ ++-------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`echo` | ++-------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++-------------------------+--------------------------------------------------------+ +| :ref:`int` | :ref:`scancode` | ++-------------------------+--------------------------------------------------------+ +| :ref:`int` | :ref:`unicode` | ++-------------------------+--------------------------------------------------------+ Methods ------- -+------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_scancode_with_modifiers` **(** **)** const | -+------------------------+-------------------------------------------------------------------------------------------------------+ ++-----------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_scancode_with_modifiers` **(** **)** const | ++-----------------------+--------------------------------------------------------------------------------------------------------------+ Description ----------- -Stores key presses on the keyboard. Supports key presses, key releases and :ref:`echo` events. +Stores key presses on the keyboard. Supports key presses, key releases and :ref:`echo` events. Tutorials --------- @@ -49,7 +49,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventKey_echo: +.. _class_InputEventKey_property_echo: - :ref:`bool` **echo** @@ -61,7 +61,7 @@ Property Descriptions If ``true``, the key was already pressed before this event. It means the user is holding the key down. -.. _class_InputEventKey_pressed: +.. _class_InputEventKey_property_pressed: - :ref:`bool` **pressed** @@ -73,7 +73,7 @@ If ``true``, the key was already pressed before this event. It means the user is If ``true``, the key's state is pressed. If ``false``, the key's state is released. -.. _class_InputEventKey_scancode: +.. _class_InputEventKey_property_scancode: - :ref:`int` **scancode** @@ -85,7 +85,7 @@ If ``true``, the key's state is pressed. If ``false``, the key's state is releas Key scancode, one of the ``KEY_*`` constants in :ref:`@GlobalScope`. -.. _class_InputEventKey_unicode: +.. _class_InputEventKey_property_unicode: - :ref:`int` **unicode** @@ -100,7 +100,7 @@ Key unicode identifier when relevant. Method Descriptions ------------------- -.. _class_InputEventKey_get_scancode_with_modifiers: +.. _class_InputEventKey_method_get_scancode_with_modifiers: - :ref:`int` **get_scancode_with_modifiers** **(** **)** const diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index 8a97dfb8d..66163f3ff 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+---------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`factor` | -+---------------------------+------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`factor` | ++---------------------------+---------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_InputEventMagnifyGesture_factor: +.. _class_InputEventMagnifyGesture_property_factor: - :ref:`float` **factor** diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index c6214eef8..b86b91159 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -21,13 +21,13 @@ Base input event type for mouse events. Properties ---------- -+-------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`button_mask` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`global_position` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+---------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`button_mask` | ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`global_position` | ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+------------------------------------------------------------------------+ Description ----------- @@ -42,7 +42,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventMouse_button_mask: +.. _class_InputEventMouse_property_button_mask: - :ref:`int` **button_mask** @@ -54,7 +54,7 @@ Property Descriptions Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@GlobalScope`. -.. _class_InputEventMouse_global_position: +.. _class_InputEventMouse_property_global_position: - :ref:`Vector2` **global_position** @@ -64,9 +64,9 @@ Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK | *Getter* | get_global_position() | +----------+----------------------------+ -Mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. +Mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. -.. _class_InputEventMouse_position: +.. _class_InputEventMouse_property_position: - :ref:`Vector2` **position** @@ -76,5 +76,5 @@ Mouse position relative to the current :ref:`Viewport` when used | *Getter* | get_position() | +----------+---------------------+ -Mouse local 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. +Mouse local 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. diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 585317bc3..af8e44851 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -19,20 +19,20 @@ Input event type for mouse button events. Properties ---------- -+---------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`button_index` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`doubleclick` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`factor` | -+---------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+---------------------------+---------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`button_index` | ++---------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`doubleclick` | ++---------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`factor` | ++---------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++---------------------------+------------------------------------------------------------------------+ Description ----------- -Contains mouse click information. See :ref:`Node._input`. +Contains mouse click information. See :ref:`Node._input`. Tutorials --------- @@ -42,7 +42,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventMouseButton_button_index: +.. _class_InputEventMouseButton_property_button_index: - :ref:`int` **button_index** @@ -54,7 +54,7 @@ Property Descriptions Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope`. -.. _class_InputEventMouseButton_doubleclick: +.. _class_InputEventMouseButton_property_doubleclick: - :ref:`bool` **doubleclick** @@ -66,7 +66,7 @@ Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in If ``true``, the mouse button's state is a double-click. -.. _class_InputEventMouseButton_factor: +.. _class_InputEventMouseButton_property_factor: - :ref:`float` **factor** @@ -78,7 +78,7 @@ If ``true``, the mouse button's state is a double-click. Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scroll amount (vertically or horizontally). Only supported on some platforms, sensitivity varies by platform. May be 0 if not supported. -.. _class_InputEventMouseButton_pressed: +.. _class_InputEventMouseButton_property_pressed: - :ref:`bool` **pressed** diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 921e4150c..01a2535b8 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -19,16 +19,16 @@ Input event type for mouse motion events. Properties ---------- -+-------------------------------+-------------------------------------------------------+ -| :ref:`Vector2` | :ref:`relative` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`Vector2` | :ref:`speed` | -+-------------------------------+-------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`relative` | ++-------------------------------+----------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`speed` | ++-------------------------------+----------------------------------------------------------------+ Description ----------- -Contains mouse motion information. Supports relative, absolute positions and speed. See :ref:`Node._input`. +Contains mouse motion information. Supports relative, absolute positions and speed. See :ref:`Node._input`. Tutorials --------- @@ -38,7 +38,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventMouseMotion_relative: +.. _class_InputEventMouseMotion_property_relative: - :ref:`Vector2` **relative** @@ -50,7 +50,7 @@ Property Descriptions Mouse position relative to the previous position (position at the last frame). -.. _class_InputEventMouseMotion_speed: +.. _class_InputEventMouseMotion_property_speed: - :ref:`Vector2` **speed** diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 4584eb0bc..33088db9a 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-------------------------------+------------------------------------------------+ -| :ref:`Vector2` | :ref:`delta` | -+-------------------------------+------------------------------------------------+ ++-------------------------------+---------------------------------------------------------+ +| :ref:`Vector2` | :ref:`delta` | ++-------------------------------+---------------------------------------------------------+ Property Descriptions --------------------- -.. _class_InputEventPanGesture_delta: +.. _class_InputEventPanGesture_property_delta: - :ref:`Vector2` **delta** diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index e881da015..459ee5140 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -21,20 +21,20 @@ Input event type for screen drag events. Properties ---------- -+-------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`index` | -+-------------------------------+------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+------------------------------------------------------+ -| :ref:`Vector2` | :ref:`relative` | -+-------------------------------+------------------------------------------------------+ -| :ref:`Vector2` | :ref:`speed` | -+-------------------------------+------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`index` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`relative` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`speed` | ++-------------------------------+---------------------------------------------------------------+ Description ----------- -Contains screen drag information. See :ref:`Node._input`. +Contains screen drag information. See :ref:`Node._input`. Tutorials --------- @@ -44,7 +44,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventScreenDrag_index: +.. _class_InputEventScreenDrag_property_index: - :ref:`int` **index** @@ -56,7 +56,7 @@ Property Descriptions Drag event index in the case of a multi-drag event. -.. _class_InputEventScreenDrag_position: +.. _class_InputEventScreenDrag_property_position: - :ref:`Vector2` **position** @@ -68,7 +68,7 @@ Drag event index in the case of a multi-drag event. Drag position. -.. _class_InputEventScreenDrag_relative: +.. _class_InputEventScreenDrag_property_relative: - :ref:`Vector2` **relative** @@ -80,7 +80,7 @@ Drag position. Drag position relative to its start position. -.. _class_InputEventScreenDrag_speed: +.. _class_InputEventScreenDrag_property_speed: - :ref:`Vector2` **speed** diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 45d2780dd..3cfcbcb07 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -21,18 +21,18 @@ Input event type for screen touch events. Properties ---------- -+-------------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`index` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`pressed` | -+-------------------------------+-------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------+ +| :ref:`int` | :ref:`index` | ++-------------------------------+----------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++-------------------------------+----------------------------------------------------------------+ Description ----------- -Stores multi-touch press/release information. Supports touch press, touch release and :ref:`index` for multi-touch count and order. +Stores multi-touch press/release information. Supports touch press, touch release and :ref:`index` for multi-touch count and order. Tutorials --------- @@ -42,7 +42,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventScreenTouch_index: +.. _class_InputEventScreenTouch_property_index: - :ref:`int` **index** @@ -54,7 +54,7 @@ Property Descriptions Touch index in the case of a multi-touch event. One index = one finger. -.. _class_InputEventScreenTouch_position: +.. _class_InputEventScreenTouch_property_position: - :ref:`Vector2` **position** @@ -66,7 +66,7 @@ Touch index in the case of a multi-touch event. One index = one finger. Touch position. -.. _class_InputEventScreenTouch_pressed: +.. _class_InputEventScreenTouch_property_pressed: - :ref:`bool` **pressed** diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 02a53073d..90a41863e 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -21,22 +21,22 @@ Base class for keys events with modifiers. Properties ---------- -+-------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`alt` | -+-------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`command` | -+-------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`control` | -+-------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`meta` | -+-------------------------+-------------------------------------------------------+ -| :ref:`bool` | :ref:`shift` | -+-------------------------+-------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`alt` | ++-------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`command` | ++-------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`control` | ++-------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`meta` | ++-------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`shift` | ++-------------------------+----------------------------------------------------------------+ Description ----------- -Contains keys events information with modifiers support like ``SHIFT`` or ``ALT``. See :ref:`Node._input`. +Contains keys events information with modifiers support like ``SHIFT`` or ``ALT``. See :ref:`Node._input`. Tutorials --------- @@ -46,7 +46,7 @@ Tutorials Property Descriptions --------------------- -.. _class_InputEventWithModifiers_alt: +.. _class_InputEventWithModifiers_property_alt: - :ref:`bool` **alt** @@ -58,7 +58,7 @@ Property Descriptions State of the Alt modifier. -.. _class_InputEventWithModifiers_command: +.. _class_InputEventWithModifiers_property_command: - :ref:`bool` **command** @@ -70,7 +70,7 @@ State of the Alt modifier. State of the Command modifier. -.. _class_InputEventWithModifiers_control: +.. _class_InputEventWithModifiers_property_control: - :ref:`bool` **control** @@ -82,7 +82,7 @@ State of the Command modifier. State of the Ctrl modifier. -.. _class_InputEventWithModifiers_meta: +.. _class_InputEventWithModifiers_property_meta: - :ref:`bool` **meta** @@ -94,7 +94,7 @@ State of the Ctrl modifier. State of the Meta modifier. -.. _class_InputEventWithModifiers_shift: +.. _class_InputEventWithModifiers_property_shift: - :ref:`bool` **shift** diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 4b1865d00..aa0347bd5 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -19,36 +19,36 @@ Singleton that manages :ref:`InputEventAction`. 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` **(** **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Manages all :ref:`InputEventAction` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map`` or in code with :ref:`add_action` and :ref:`action_add_event`. See :ref:`Node._input`. +Manages all :ref:`InputEventAction` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map`` or in code with :ref:`add_action` and :ref:`action_add_event`. See :ref:`Node._input`. Tutorials --------- @@ -58,73 +58,73 @@ Tutorials Method Descriptions ------------------- -.. _class_InputMap_action_add_event: +.. _class_InputMap_method_action_add_event: - void **action_add_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. -.. _class_InputMap_action_erase_event: +.. _class_InputMap_method_action_erase_event: - void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Removes an :ref:`InputEvent` from an action. -.. _class_InputMap_action_erase_events: +.. _class_InputMap_method_action_erase_events: - void **action_erase_events** **(** :ref:`String` action **)** Removes all events from an action. -.. _class_InputMap_action_has_event: +.. _class_InputMap_method_action_has_event: - :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Returns ``true`` if the action has the given :ref:`InputEvent` associated with it. -.. _class_InputMap_action_set_deadzone: +.. _class_InputMap_method_action_set_deadzone: - void **action_set_deadzone** **(** :ref:`String` action, :ref:`float` deadzone **)** -.. _class_InputMap_add_action: +.. _class_InputMap_method_add_action: - void **add_action** **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** Adds an empty action to the ``InputMap`` with a configurable ``deadzone``. -An :ref:`InputEvent` can then be added to this action with :ref:`action_add_event`. +An :ref:`InputEvent` can then be added to this action with :ref:`action_add_event`. -.. _class_InputMap_erase_action: +.. _class_InputMap_method_erase_action: - void **erase_action** **(** :ref:`String` action **)** Removes an action from the ``InputMap``. -.. _class_InputMap_event_is_action: +.. _class_InputMap_method_event_is_action: - :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. +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. -.. _class_InputMap_get_action_list: +.. _class_InputMap_method_get_action_list: - :ref:`Array` **get_action_list** **(** :ref:`String` action **)** Returns an array of :ref:`InputEvent`\ s associated with a given action. -.. _class_InputMap_get_actions: +.. _class_InputMap_method_get_actions: - :ref:`Array` **get_actions** **(** **)** Returns an array of all actions in the ``InputMap``. -.. _class_InputMap_has_action: +.. _class_InputMap_method_has_action: - :ref:`bool` **has_action** **(** :ref:`String` action **)** const Returns ``true`` if the ``InputMap`` has a registered action with the given name. -.. _class_InputMap_load_from_globals: +.. _class_InputMap_method_load_from_globals: - void **load_from_globals** **(** **)** diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 1995c9173..c7807f339 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -19,41 +19,41 @@ Placeholder for the root :ref:`Node` of a :ref:`PackedScene` | :ref:`create_instance` **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_instance_path` **(** **)** const | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=null **)** | -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`create_instance` **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_instance_path` **(** **)** const | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=null **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Turning on the option **Load As Placeholder** for an instanced scene in the editor causes it to be replaced by an InstancePlaceholder when running the game. This makes it possible to delay actually loading the scene until calling :ref:`replace_by_instance`. This is useful to avoid loading large scenes all at once by loading parts of it selectively. +Turning on the option **Load As Placeholder** for an instanced scene in the editor causes it to be replaced by an InstancePlaceholder when running the game. This makes it possible to delay actually loading the scene until calling :ref:`replace_by_instance`. This is useful to avoid loading large scenes all at once by loading parts of it selectively. The InstancePlaceholder does not have a transform. This causes any child nodes to be positioned relatively to the Viewport from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again. Method Descriptions ------------------- -.. _class_InstancePlaceholder_create_instance: +.. _class_InstancePlaceholder_method_create_instance: - :ref:`Node` **create_instance** **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** -.. _class_InstancePlaceholder_get_instance_path: +.. _class_InstancePlaceholder_method_get_instance_path: - :ref:`String` **get_instance_path** **(** **)** const -Retrieve the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`replace_by_instance`. +Retrieve the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`replace_by_instance`. -.. _class_InstancePlaceholder_get_stored_values: +.. _class_InstancePlaceholder_method_get_stored_values: - :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** -.. _class_InstancePlaceholder_replace_by_instance: +.. _class_InstancePlaceholder_method_replace_by_instance: - void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=null **)** diff --git a/classes/class_int.rst b/classes/class_int.rst index 5b05ff355..833b5e3e2 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -17,13 +17,13 @@ Integer built-in type. Methods ------- -+------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** | -+------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`float` from **)** | -+------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`String` from **)** | -+------------------------+------------------------------------------------------------------------+ ++-----------------------+-------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** | ++-----------------------+-------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`float` from **)** | ++-----------------------+-------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`String` from **)** | ++-----------------------+-------------------------------------------------------------------------------+ Description ----------- @@ -33,20 +33,16 @@ Integer built-in type. Method Descriptions ------------------- -.. _class_int_int: +.. _class_int_method_int: - :ref:`int` **int** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to an integer value, ``int(true)`` will be equals to 1 and ``int(false)`` will be equals to 0. -.. _class_int_int: - - :ref:`int` **int** **(** :ref:`float` from **)** Cast a float value to an integer value, this method simply removes the number fractions, so for example ``int(2.7)`` will be equals to 2, ``int(.1)`` will be equals to 0 and ``int(-2.7)`` will be equals to -2. -.. _class_int_int: - - :ref:`int` **int** **(** :ref:`String` from **)** 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. diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index 9009bdf09..272a1c349 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -19,32 +19,32 @@ Camera which moves toward another node. Properties ---------- -+---------------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+---------------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`speed` | -+---------------------------------+--------------------------------------------------+ -| :ref:`NodePath` | :ref:`target` | -+---------------------------------+--------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`enabled` | ++---------------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`speed` | ++---------------------------------+-----------------------------------------------------------+ +| :ref:`NodePath` | :ref:`target` | ++---------------------------------+-----------------------------------------------------------+ Methods ------- -+-------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target` **(** :ref:`Object` target **)** | -+-------+-------------------------------------------------------------------------------------------------------+ ++------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target` **(** :ref:`Object` target **)** | ++------+--------------------------------------------------------------------------------------------------------------+ Description ----------- InterpolatedCamera is a :ref:`Camera` which smoothly moves to match a target node's position and rotation. -If it is not :ref:`enabled` or does not have a valid target set, InterpolatedCamera acts like a normal Camera. +If it is not :ref:`enabled` or does not have a valid target set, InterpolatedCamera acts like a normal Camera. Property Descriptions --------------------- -.. _class_InterpolatedCamera_enabled: +.. _class_InterpolatedCamera_property_enabled: - :ref:`bool` **enabled** @@ -56,7 +56,7 @@ Property Descriptions If ``true``, and a target is set, the camera will move automatically. -.. _class_InterpolatedCamera_speed: +.. _class_InterpolatedCamera_property_speed: - :ref:`float` **speed** @@ -68,7 +68,7 @@ If ``true``, and a target is set, the camera will move automatically. How quickly the camera moves toward its target. Higher values will result in tighter camera motion. -.. _class_InterpolatedCamera_target: +.. _class_InterpolatedCamera_property_target: - :ref:`NodePath` **target** @@ -83,7 +83,7 @@ The target's :ref:`NodePath`. Method Descriptions ------------------- -.. _class_InterpolatedCamera_set_target: +.. _class_InterpolatedCamera_method_set_target: - void **set_target** **(** :ref:`Object` target **)** diff --git a/classes/class_ip.rst b/classes/class_ip.rst index ece441dfe..2d529780a 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -21,27 +21,35 @@ Internet protocol (IP) support functions like DNS resolution. Methods ------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_cache` **(** :ref:`String` hostname="" **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resolve_item_address` **(** :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 **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_cache` **(** :ref:`String` hostname="" **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resolve_item_address` **(** :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 **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_IP_ResolverStatus: +.. _class_IP_constant_RESOLVER_STATUS_NONE: + +.. _class_IP_constant_RESOLVER_STATUS_WAITING: + +.. _class_IP_constant_RESOLVER_STATUS_DONE: + +.. _class_IP_constant_RESOLVER_STATUS_ERROR: + enum **ResolverStatus**: - **RESOLVER_STATUS_NONE** = **0** --- DNS hostname resolver status: No status. @@ -54,6 +62,14 @@ enum **ResolverStatus**: .. _enum_IP_Type: +.. _class_IP_constant_TYPE_NONE: + +.. _class_IP_constant_TYPE_IPV4: + +.. _class_IP_constant_TYPE_IPV6: + +.. _class_IP_constant_TYPE_ANY: + enum **Type**: - **TYPE_NONE** = **0** --- Address type: None. @@ -67,6 +83,10 @@ enum **Type**: Constants --------- +.. _class_IP_constant_RESOLVER_MAX_QUERIES: + +.. _class_IP_constant_RESOLVER_INVALID_ID: + - **RESOLVER_MAX_QUERIES** = **32** --- Maximum number of concurrent DNS resolver queries allowed, ``RESOLVER_INVALID_ID`` is returned if exceeded. - **RESOLVER_INVALID_ID** = **-1** --- Invalid ID constant. Returned if ``RESOLVER_MAX_QUERIES`` is exceeded. @@ -79,43 +99,43 @@ IP contains support functions for the Internet Protocol (IP). TCP/IP support is Method Descriptions ------------------- -.. _class_IP_clear_cache: +.. _class_IP_method_clear_cache: - void **clear_cache** **(** :ref:`String` hostname="" **)** Removes all of a "hostname"'s cached references. If no "hostname" is given then all cached IP addresses are removed. -.. _class_IP_erase_resolve_item: +.. _class_IP_method_erase_resolve_item: - void **erase_resolve_item** **(** :ref:`int` id **)** Removes a given item "id" from the queue. This should be used to free a queue after it has completed to enable more queries to happen. -.. _class_IP_get_local_addresses: +.. _class_IP_method_get_local_addresses: - :ref:`Array` **get_local_addresses** **(** **)** const Returns all of the user's current IPv4 and IPv6 addresses as an array. -.. _class_IP_get_resolve_item_address: +.. _class_IP_method_get_resolve_item_address: - :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`). +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`). -.. _class_IP_get_resolve_item_status: +.. _class_IP_method_get_resolve_item_status: - :ref:`ResolverStatus` **get_resolve_item_status** **(** :ref:`int` id **)** const Returns a queued hostname's status as a RESOLVER_STATUS\_\* constant, given its queue "id". -.. _class_IP_resolve_hostname: +.. _class_IP_method_resolve_hostname: - :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the TYPE\_\* constant given as "ip_type". -.. _class_IP_resolve_hostname_queue_item: +.. _class_IP_method_resolve_hostname_queue_item: - :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 9ea1d1488..1e9aa8ffc 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -19,158 +19,158 @@ Control that provides a list of selectable items (and/or icons) in a single colu Properties ---------- -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_reselect` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_rmb_select` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_height` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_column_width` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`fixed_icon_size` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`IconMode` | :ref:`icon_mode` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`float` | :ref:`icon_scale` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`max_columns` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`max_text_lines` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`bool` | :ref:`same_column_width` | -+---------------------------------------------+--------------------------------------------------------------+ -| :ref:`SelectMode` | :ref:`select_mode` | -+---------------------------------------------+--------------------------------------------------------------+ ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_reselect` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_rmb_select` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`auto_height` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`int` | :ref:`fixed_column_width` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`fixed_icon_size` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`IconMode` | :ref:`icon_mode` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`icon_scale` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`int` | :ref:`max_columns` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`int` | :ref:`max_text_lines` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`same_column_width` | ++---------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`SelectMode` | :ref:`select_mode` | ++---------------------------------------------+-----------------------------------------------------------------------+ Methods ------- -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_count` **(** **)** 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:`Texture` | :ref:`get_item_icon` **(** :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:`Variant` | :ref:`get_item_metadata` **(** :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:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_anything_selected` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_selectable` **(** :ref:`int` idx **)** const | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :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 **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_custom_fg_color` **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_modulate` **(** :ref:`int` idx, :ref:`Color` modulate **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_transposed` **(** :ref:`int` idx, :ref:`bool` rect **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_items_by_text` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unselect` **(** :ref:`int` idx **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unselect_all` **(** **)** | -+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_count` **(** **)** 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:`Texture` | :ref:`get_item_icon` **(** :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:`Variant` | :ref:`get_item_metadata` **(** :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:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_anything_selected` **(** **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_selectable` **(** :ref:`int` idx **)** const | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :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 **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_custom_fg_color` **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon_modulate` **(** :ref:`int` idx, :ref:`Color` modulate **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon_transposed` **(** :ref:`int` idx, :ref:`bool` rect **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_items_by_text` **(** **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unselect` **(** :ref:`int` idx **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unselect_all` **(** **)** | ++-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+----------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`bg_focus` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`cursor` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`cursor_unfocused` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_selected` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`Color` | :ref:`guide_color` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`icon_margin` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`line_separation` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`selected` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`selected_focus` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`vseparation` | -+---------------------------------+----------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`StyleBox` | bg | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | bg_focus | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | cursor | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | cursor_unfocused | ++---------------------------------+---------------------+ +| :ref:`Font` | font | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_selected | ++---------------------------------+---------------------+ +| :ref:`Color` | guide_color | ++---------------------------------+---------------------+ +| :ref:`int` | hseparation | ++---------------------------------+---------------------+ +| :ref:`int` | icon_margin | ++---------------------------------+---------------------+ +| :ref:`int` | line_separation | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | selected | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | selected_focus | ++---------------------------------+---------------------+ +| :ref:`int` | vseparation | ++---------------------------------+---------------------+ Signals ------- -.. _class_ItemList_item_activated: +.. _class_ItemList_signal_item_activated: - **item_activated** **(** :ref:`int` index **)** Fired when specified list item is activated via double click or Enter. -.. _class_ItemList_item_rmb_selected: +.. _class_ItemList_signal_item_rmb_selected: - **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** @@ -180,27 +180,27 @@ The click position is also provided to allow appropriate popup of context menus at the correct location. -:ref:`allow_rmb_select` must be enabled. +:ref:`allow_rmb_select` must be enabled. -.. _class_ItemList_item_selected: +.. _class_ItemList_signal_item_selected: - **item_selected** **(** :ref:`int` index **)** Fired when specified item has been selected. -:ref:`allow_reselect` must be enabled to reselect an item. +:ref:`allow_reselect` must be enabled to reselect an item. -.. _class_ItemList_multi_selected: +.. _class_ItemList_signal_multi_selected: - **multi_selected** **(** :ref:`int` index, :ref:`bool` selected **)** Fired when a multiple selection is altered on a list allowing multiple selection. -.. _class_ItemList_nothing_selected: +.. _class_ItemList_signal_nothing_selected: - **nothing_selected** **(** **)** -.. _class_ItemList_rmb_clicked: +.. _class_ItemList_signal_rmb_clicked: - **rmb_clicked** **(** :ref:`Vector2` at_position **)** @@ -209,6 +209,10 @@ Enumerations .. _enum_ItemList_IconMode: +.. _class_ItemList_constant_ICON_MODE_TOP: + +.. _class_ItemList_constant_ICON_MODE_LEFT: + enum **IconMode**: - **ICON_MODE_TOP** = **0** @@ -217,6 +221,10 @@ enum **IconMode**: .. _enum_ItemList_SelectMode: +.. _class_ItemList_constant_SELECT_SINGLE: + +.. _class_ItemList_constant_SELECT_MULTI: + enum **SelectMode**: - **SELECT_SINGLE** = **0** @@ -233,7 +241,7 @@ Selectable items in the list may be selected or deselected and multiple selectio Property Descriptions --------------------- -.. _class_ItemList_allow_reselect: +.. _class_ItemList_property_allow_reselect: - :ref:`bool` **allow_reselect** @@ -245,7 +253,7 @@ Property Descriptions If ``true``, the currently selected item may be selected again. -.. _class_ItemList_allow_rmb_select: +.. _class_ItemList_property_allow_rmb_select: - :ref:`bool` **allow_rmb_select** @@ -257,7 +265,7 @@ If ``true``, the currently selected item may be selected again. If ``true``, a right mouse button click can select items. -.. _class_ItemList_auto_height: +.. _class_ItemList_property_auto_height: - :ref:`bool` **auto_height** @@ -267,7 +275,7 @@ If ``true``, a right mouse button click can select items. | *Getter* | has_auto_height() | +----------+------------------------+ -.. _class_ItemList_fixed_column_width: +.. _class_ItemList_property_fixed_column_width: - :ref:`int` **fixed_column_width** @@ -277,7 +285,7 @@ If ``true``, a right mouse button click can select items. | *Getter* | get_fixed_column_width() | +----------+-------------------------------+ -.. _class_ItemList_fixed_icon_size: +.. _class_ItemList_property_fixed_icon_size: - :ref:`Vector2` **fixed_icon_size** @@ -287,7 +295,7 @@ If ``true``, a right mouse button click can select items. | *Getter* | get_fixed_icon_size() | +----------+----------------------------+ -.. _class_ItemList_icon_mode: +.. _class_ItemList_property_icon_mode: - :ref:`IconMode` **icon_mode** @@ -297,7 +305,7 @@ If ``true``, a right mouse button click can select items. | *Getter* | get_icon_mode() | +----------+----------------------+ -.. _class_ItemList_icon_scale: +.. _class_ItemList_property_icon_scale: - :ref:`float` **icon_scale** @@ -307,7 +315,7 @@ If ``true``, a right mouse button click can select items. | *Getter* | get_icon_scale() | +----------+-----------------------+ -.. _class_ItemList_max_columns: +.. _class_ItemList_property_max_columns: - :ref:`int` **max_columns** @@ -317,7 +325,7 @@ If ``true``, a right mouse button click can select items. | *Getter* | get_max_columns() | +----------+------------------------+ -.. _class_ItemList_max_text_lines: +.. _class_ItemList_property_max_text_lines: - :ref:`int` **max_text_lines** @@ -327,7 +335,7 @@ If ``true``, a right mouse button click can select items. | *Getter* | get_max_text_lines() | +----------+---------------------------+ -.. _class_ItemList_same_column_width: +.. _class_ItemList_property_same_column_width: - :ref:`bool` **same_column_width** @@ -337,7 +345,7 @@ If ``true``, a right mouse button click can select items. | *Getter* | is_same_column_width() | +----------+------------------------------+ -.. _class_ItemList_select_mode: +.. _class_ItemList_property_select_mode: - :ref:`SelectMode` **select_mode** @@ -352,13 +360,13 @@ Allow single or multiple selection. See the ``SELECT_*`` constants. Method Descriptions ------------------- -.. _class_ItemList_add_icon_item: +.. _class_ItemList_method_add_icon_item: - void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** Adds an item to the item list with no text, only an icon. -.. _class_ItemList_add_item: +.. _class_ItemList_method_add_item: - void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** @@ -366,127 +374,127 @@ Adds an item to the item list with specified text. Specify an icon of null for a If selectable is true the list item will be selectable. -.. _class_ItemList_clear: +.. _class_ItemList_method_clear: - void **clear** **(** **)** Remove all items from the list. -.. _class_ItemList_ensure_current_is_visible: +.. _class_ItemList_method_ensure_current_is_visible: - void **ensure_current_is_visible** **(** **)** Ensure selection is visible, adjusting the scroll position as necessary. -.. _class_ItemList_get_item_at_position: +.. _class_ItemList_method_get_item_at_position: - :ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const Given a position within the control return the item (if any) at that point. -.. _class_ItemList_get_item_count: +.. _class_ItemList_method_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Return count of items currently in the item list. -.. _class_ItemList_get_item_custom_bg_color: +.. _class_ItemList_method_get_item_custom_bg_color: - :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const -.. _class_ItemList_get_item_custom_fg_color: +.. _class_ItemList_method_get_item_custom_fg_color: - :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** const -.. _class_ItemList_get_item_icon: +.. _class_ItemList_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const -.. _class_ItemList_get_item_icon_modulate: +.. _class_ItemList_method_get_item_icon_modulate: - :ref:`Color` **get_item_icon_modulate** **(** :ref:`int` idx **)** const Returns a :ref:`Color` modulating item's icon at the specified index. -.. _class_ItemList_get_item_icon_region: +.. _class_ItemList_method_get_item_icon_region: - :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** const -.. _class_ItemList_get_item_metadata: +.. _class_ItemList_method_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const -.. _class_ItemList_get_item_text: +.. _class_ItemList_method_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text for specified item index. -.. _class_ItemList_get_item_tooltip: +.. _class_ItemList_method_get_item_tooltip: - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const Return tooltip hint for specified item index. -.. _class_ItemList_get_selected_items: +.. _class_ItemList_method_get_selected_items: - :ref:`PoolIntArray` **get_selected_items** **(** **)** Returns the list of selected indexes. -.. _class_ItemList_get_v_scroll: +.. _class_ItemList_method_get_v_scroll: - :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the current vertical scroll bar for the List. -.. _class_ItemList_is_anything_selected: +.. _class_ItemList_method_is_anything_selected: - :ref:`bool` **is_anything_selected** **(** **)** Returns ``true`` if one or more items are selected. -.. _class_ItemList_is_item_disabled: +.. _class_ItemList_method_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const Returns whether or not the item at the specified index is disabled -.. _class_ItemList_is_item_icon_transposed: +.. _class_ItemList_method_is_item_icon_transposed: - :ref:`bool` **is_item_icon_transposed** **(** :ref:`int` idx **)** const -.. _class_ItemList_is_item_selectable: +.. _class_ItemList_method_is_item_selectable: - :ref:`bool` **is_item_selectable** **(** :ref:`int` idx **)** const Returns whether or not the item at the specified index is selectable. -.. _class_ItemList_is_item_tooltip_enabled: +.. _class_ItemList_method_is_item_tooltip_enabled: - :ref:`bool` **is_item_tooltip_enabled** **(** :ref:`int` idx **)** const Returns whether the tooltip is enabled for specified item index. -.. _class_ItemList_is_selected: +.. _class_ItemList_method_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` idx **)** const Returns whether or not item at the specified index is currently selected. -.. _class_ItemList_move_item: +.. _class_ItemList_method_move_item: - void **move_item** **(** :ref:`int` from_idx, :ref:`int` to_idx **)** Moves item at index ``from_idx`` to ``to_idx``. -.. _class_ItemList_remove_item: +.. _class_ItemList_method_remove_item: - void **remove_item** **(** :ref:`int` idx **)** Remove item at specified index from the list. -.. _class_ItemList_select: +.. _class_ItemList_method_select: - void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** @@ -494,15 +502,15 @@ Select the item at the specified index. Note: This method does not trigger the item selection signal. -.. _class_ItemList_set_item_custom_bg_color: +.. _class_ItemList_method_set_item_custom_bg_color: - void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** -.. _class_ItemList_set_item_custom_fg_color: +.. _class_ItemList_method_set_item_custom_fg_color: - void **set_item_custom_fg_color** **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** -.. _class_ItemList_set_item_disabled: +.. _class_ItemList_method_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** @@ -510,69 +518,69 @@ Disable (or enable) item at specified index. Disabled items are not be selectable and do not fire activation (Enter or double-click) signals. -.. _class_ItemList_set_item_icon: +.. _class_ItemList_method_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** Set (or replace) icon of the item at the specified index. -.. _class_ItemList_set_item_icon_modulate: +.. _class_ItemList_method_set_item_icon_modulate: - void **set_item_icon_modulate** **(** :ref:`int` idx, :ref:`Color` modulate **)** Sets a modulating :ref:`Color` for item's icon at the specified index. -.. _class_ItemList_set_item_icon_region: +.. _class_ItemList_method_set_item_icon_region: - void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** -.. _class_ItemList_set_item_icon_transposed: +.. _class_ItemList_method_set_item_icon_transposed: - void **set_item_icon_transposed** **(** :ref:`int` idx, :ref:`bool` rect **)** -.. _class_ItemList_set_item_metadata: +.. _class_ItemList_method_set_item_metadata: - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** Sets a value (of any type) to be stored with the item at the specified index. -.. _class_ItemList_set_item_selectable: +.. _class_ItemList_method_set_item_selectable: - void **set_item_selectable** **(** :ref:`int` idx, :ref:`bool` selectable **)** Allow or disallow selection of the item at the specified index. -.. _class_ItemList_set_item_text: +.. _class_ItemList_method_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Sets text of item at specified index. -.. _class_ItemList_set_item_tooltip: +.. _class_ItemList_method_set_item_tooltip: - void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** Sets tooltip hint for item at specified index. -.. _class_ItemList_set_item_tooltip_enabled: +.. _class_ItemList_method_set_item_tooltip_enabled: - void **set_item_tooltip_enabled** **(** :ref:`int` idx, :ref:`bool` enable **)** Sets whether the tooltip is enabled for specified item index. -.. _class_ItemList_sort_items_by_text: +.. _class_ItemList_method_sort_items_by_text: - void **sort_items_by_text** **(** **)** Sorts items in the list by their text. -.. _class_ItemList_unselect: +.. _class_ItemList_method_unselect: - void **unselect** **(** :ref:`int` idx **)** Ensure item at specified index is not selected. -.. _class_ItemList_unselect_all: +.. _class_ItemList_method_unselect_all: - void **unselect_all** **(** **)** diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst index 0a9ce9677..568bd8955 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascript.rst @@ -19,9 +19,9 @@ Singleton that connects the engine with the browser's JavaScript context in HTML Methods ------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`eval` **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`eval` **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -36,7 +36,7 @@ Tutorials Method Descriptions ------------------- -.. _class_JavaScript_eval: +.. _class_JavaScript_method_eval: - :ref:`Variant` **eval** **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 983fd71e7..491150b59 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -21,15 +21,15 @@ Base class for all 3D joints Properties ---------- -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collision/exclude_nodes` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`nodes/node_a` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`nodes/node_b` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`solver/priority` | -+---------------------------------+---------------------------------------------------------------------+ ++---------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collision/exclude_nodes` | ++---------------------------------+------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`nodes/node_a` | ++---------------------------------+------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`nodes/node_b` | ++---------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`solver/priority` | ++---------------------------------+------------------------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ Joints are used to bind together two physics bodies. They have a solver priority Property Descriptions --------------------- -.. _class_Joint_collision/exclude_nodes: +.. _class_Joint_property_collision/exclude_nodes: - :ref:`bool` **collision/exclude_nodes** @@ -51,7 +51,7 @@ Property Descriptions If ``true``, the two bodies of the nodes are not able to collide with each other. -.. _class_Joint_nodes/node_a: +.. _class_Joint_property_nodes/node_a: - :ref:`NodePath` **nodes/node_a** @@ -63,7 +63,7 @@ If ``true``, the two bodies of the nodes are not able to collide with each other The node attached to the first side (A) of the joint. -.. _class_Joint_nodes/node_b: +.. _class_Joint_property_nodes/node_b: - :ref:`NodePath` **nodes/node_b** @@ -75,7 +75,7 @@ The node attached to the first side (A) of the joint. The node attached to the second side (B) of the joint. -.. _class_Joint_solver/priority: +.. _class_Joint_property_solver/priority: - :ref:`int` **solver/priority** diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 47641b4b4..b815cbcbb 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -21,15 +21,15 @@ Base node for all joint constraints in 2D physics. Properties ---------- -+---------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`bias` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`disable_collision` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_a` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_b` | -+---------------------------------+-----------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`bias` | ++---------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disable_collision` | ++---------------------------------+--------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`node_a` | ++---------------------------------+--------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`node_b` | ++---------------------------------+--------------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ Base node for all joint constraints in 2D physics. Joints take 2 bodies and appl Property Descriptions --------------------- -.. _class_Joint2D_bias: +.. _class_Joint2D_property_bias: - :ref:`float` **bias** @@ -49,9 +49,9 @@ Property Descriptions | *Getter* | get_bias() | +----------+-----------------+ -When :ref:`node_a` and :ref:`node_b` move in different directions the ``bias`` controls how fast the joint pulls them back to their original position. The lower the ``bias`` the more the two bodies can pull on the joint. Default value: ``0`` +When :ref:`node_a` and :ref:`node_b` move in different directions the ``bias`` controls how fast the joint pulls them back to their original position. The lower the ``bias`` the more the two bodies can pull on the joint. Default value: ``0`` -.. _class_Joint2D_disable_collision: +.. _class_Joint2D_property_disable_collision: - :ref:`bool` **disable_collision** @@ -61,9 +61,9 @@ When :ref:`node_a` and :ref:`node_b` | *Getter* | get_exclude_nodes_from_collision() | +----------+-----------------------------------------+ -If ``true``, :ref:`node_a` and :ref:`node_b` can collide. Default value: ``false``. +If ``true``, :ref:`node_a` and :ref:`node_b` can collide. Default value: ``false``. -.. _class_Joint2D_node_a: +.. _class_Joint2D_property_node_a: - :ref:`NodePath` **node_a** @@ -75,7 +75,7 @@ If ``true``, :ref:`node_a` and :ref:`node_b`. -.. _class_Joint2D_node_b: +.. _class_Joint2D_property_node_b: - :ref:`NodePath` **node_b** diff --git a/classes/class_json.rst b/classes/class_json.rst index 08261d808..105f62489 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -19,11 +19,11 @@ Helper class for parsing JSON data. Methods ------- -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JSONParseResult` | :ref:`parse` **(** :ref:`String` json **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`print` **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`JSONParseResult` | :ref:`parse` **(** :ref:`String` json **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`print` **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -33,13 +33,13 @@ Helper class for parsing JSON data. For usage example and other important hints, Method Descriptions ------------------- -.. _class_JSON_parse: +.. _class_JSON_method_parse: - :ref:`JSONParseResult` **parse** **(** :ref:`String` json **)** Parses a JSON encoded string and returns a :ref:`JSONParseResult` containing the result. -.. _class_JSON_print: +.. _class_JSON_method_print: - :ref:`String` **print** **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index 52f572b09..9469f247c 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -19,25 +19,25 @@ Data class wrapper for decoded JSON. Properties ---------- -+---------------------------------------+---------------------------------------------------------+ -| :ref:`Error` | :ref:`error` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`int` | :ref:`error_line` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`String` | :ref:`error_string` | -+---------------------------------------+---------------------------------------------------------+ -| :ref:`Variant` | :ref:`result` | -+---------------------------------------+---------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`Error` | :ref:`error` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`error_line` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`String` | :ref:`error_string` | ++---------------------------------------+------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`result` | ++---------------------------------------+------------------------------------------------------------------+ Description ----------- -Returned by :ref:`JSON.parse`, ``JSONParseResult`` contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with ``if json_result.error == OK``. +Returned by :ref:`JSON.parse`, ``JSONParseResult`` contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with ``if json_result.error == OK``. Property Descriptions --------------------- -.. _class_JSONParseResult_error: +.. _class_JSONParseResult_property_error: - :ref:`Error` **error** @@ -49,7 +49,7 @@ Property Descriptions The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. -.. _class_JSONParseResult_error_line: +.. _class_JSONParseResult_property_error_line: - :ref:`int` **error_line** @@ -61,7 +61,7 @@ The error type if JSON source was not successfully parsed. See :ref:`@GlobalScop The line number where the error occurred if JSON source was not successfully parsed. -.. _class_JSONParseResult_error_string: +.. _class_JSONParseResult_property_error_string: - :ref:`String` **error_string** @@ -73,7 +73,7 @@ The line number where the error occurred if JSON source was not successfully par The error message if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. -.. _class_JSONParseResult_result: +.. _class_JSONParseResult_property_result: - :ref:`Variant` **result** diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 3e1152285..8bbb51f63 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -19,40 +19,40 @@ Kinematic body 3D node. Properties ---------- -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`float` | :ref:`collision/safe_margin` | -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`move_lock_x` | -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`move_lock_y` | -+---------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`move_lock_z` | -+---------------------------+-------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`collision/safe_margin` | ++---------------------------+----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`move_lock_x` | ++---------------------------+----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`move_lock_y` | ++---------------------------+----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`move_lock_z` | ++---------------------------+----------------------------------------------------------------------------------+ Methods ------- -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** 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` test_only=false **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** 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` test_only=false **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -61,7 +61,7 @@ Kinematic bodies are special types of bodies that are meant to be user-controlle Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). -Kinematic Characters: KinematicBody also has an API for moving objects (the :ref:`move_and_collide` and :ref:`move_and_slide` methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. +Kinematic Characters: KinematicBody also has an API for moving objects (the :ref:`move_and_collide` and :ref:`move_and_slide` methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. Tutorials --------- @@ -71,7 +71,7 @@ Tutorials Property Descriptions --------------------- -.. _class_KinematicBody_collision/safe_margin: +.. _class_KinematicBody_property_collision/safe_margin: - :ref:`float` **collision/safe_margin** @@ -83,7 +83,7 @@ Property Descriptions If the body is at least this close to another body, this body will consider them to be colliding. -.. _class_KinematicBody_move_lock_x: +.. _class_KinematicBody_property_move_lock_x: - :ref:`bool` **move_lock_x** @@ -95,7 +95,7 @@ If the body is at least this close to another body, this body will consider them Lock the body's movement in the x-axis. -.. _class_KinematicBody_move_lock_y: +.. _class_KinematicBody_property_move_lock_y: - :ref:`bool` **move_lock_y** @@ -107,7 +107,7 @@ Lock the body's movement in the x-axis. Lock the body's movement in the y-axis. -.. _class_KinematicBody_move_lock_z: +.. _class_KinematicBody_property_move_lock_z: - :ref:`bool` **move_lock_z** @@ -122,43 +122,43 @@ Lock the body's movement in the z-axis. Method Descriptions ------------------- -.. _class_KinematicBody_get_floor_velocity: +.. _class_KinematicBody_method_get_floor_velocity: - :ref:`Vector3` **get_floor_velocity** **(** **)** const -Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. +Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody_get_slide_collision: +.. _class_KinematicBody_method_get_slide_collision: - :ref:`KinematicCollision` **get_slide_collision** **(** :ref:`int` slide_idx **)** -Returns a :ref:`KinematicCollision`, which contains information about a collision that occurred during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). +Returns a :ref:`KinematicCollision`, which contains information about a collision that occurred during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). -.. _class_KinematicBody_get_slide_count: +.. _class_KinematicBody_method_get_slide_count: - :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`. +Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. -.. _class_KinematicBody_is_on_ceiling: +.. _class_KinematicBody_method_is_on_ceiling: - :ref:`bool` **is_on_ceiling** **(** **)** const -Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. +Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody_is_on_floor: +.. _class_KinematicBody_method_is_on_floor: - :ref:`bool` **is_on_floor** **(** **)** const -Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. +Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody_is_on_wall: +.. _class_KinematicBody_method_is_on_wall: - :ref:`bool` **is_on_wall** **(** **)** const -Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. +Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody_move_and_collide: +.. _class_KinematicBody_method_move_and_collide: - :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` test_only=false **)** @@ -166,13 +166,13 @@ Moves the body along the vector ``rel_vec``. The body will stop if it collides. If ``test_only`` is ``true``, the body does not move but the would-be collision information is given. -.. _class_KinematicBody_move_and_slide: +.. _class_KinematicBody_method_move_and_slide: - :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody`` or :ref:`RigidBody`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. -``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — this is done by the method. +``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — this is done by the method. ``floor_normal`` is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of ``Vector3(0, 0, 0)``, everything is considered a wall. This is useful for topdown games. @@ -182,17 +182,17 @@ If the body collides, it will change direction a maximum of ``max_slides`` times ``floor_max_angle`` is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. -Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use :ref:`get_slide_collision`. +Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use :ref:`get_slide_collision`. -.. _class_KinematicBody_move_and_slide_with_snap: +.. _class_KinematicBody_method_move_and_slide_with_snap: - :ref:`Vector3` **move_and_slide_with_snap** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** -Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_slide`. +Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_slide`. -As long as the ``snap`` vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting``snap`` to``(0, 0, 0)`` or by using :ref:`move_and_slide` instead. +As long as the ``snap`` vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting``snap`` to``(0, 0, 0)`` or by using :ref:`move_and_slide` instead. -.. _class_KinematicBody_test_move: +.. _class_KinematicBody_method_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true **)** diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index edce2e2cd..673bb99c9 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -19,36 +19,36 @@ Kinematic body 2D node. Properties ---------- -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`collision/safe_margin` | -+---------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`motion/sync_to_physics` | -+---------------------------+-----------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`collision/safe_margin` | ++---------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`motion/sync_to_physics` | ++---------------------------+--------------------------------------------------------------------------------------+ Methods ------- -+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** 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 **)** | -+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | -+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | -+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true **)** | -+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** 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 **)** | ++---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | ++---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | ++---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true **)** | ++---------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -57,12 +57,12 @@ Kinematic bodies are special types of bodies that are meant to be user-controlle Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). -Kinematic Characters: KinematicBody2D also has an API for moving objects (the :ref:`move_and_collide` and :ref:`move_and_slide` methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. +Kinematic Characters: KinematicBody2D also has an API for moving objects (the :ref:`move_and_collide` and :ref:`move_and_slide` methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. Property Descriptions --------------------- -.. _class_KinematicBody2D_collision/safe_margin: +.. _class_KinematicBody2D_property_collision/safe_margin: - :ref:`float` **collision/safe_margin** @@ -74,7 +74,7 @@ Property Descriptions If the body is at least this close to another body, this body will consider them to be colliding. -.. _class_KinematicBody2D_motion/sync_to_physics: +.. _class_KinematicBody2D_property_motion/sync_to_physics: - :ref:`bool` **motion/sync_to_physics** @@ -89,55 +89,55 @@ If ``true``, the body's movement will be synchronized to the physics frame. This Method Descriptions ------------------- -.. _class_KinematicBody2D_get_floor_velocity: +.. _class_KinematicBody2D_method_get_floor_velocity: - :ref:`Vector2` **get_floor_velocity** **(** **)** const -Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. +Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody2D_get_slide_collision: +.. _class_KinematicBody2D_method_get_slide_collision: - :ref:`KinematicCollision2D` **get_slide_collision** **(** :ref:`int` slide_idx **)** -Returns a :ref:`KinematicCollision2D`, which contains information about a collision that occurred during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). +Returns a :ref:`KinematicCollision2D`, which contains information about a collision that occurred during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). -.. _class_KinematicBody2D_get_slide_count: +.. _class_KinematicBody2D_method_get_slide_count: - :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`. +Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. -.. _class_KinematicBody2D_is_on_ceiling: +.. _class_KinematicBody2D_method_is_on_ceiling: - :ref:`bool` **is_on_ceiling** **(** **)** const -Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. +Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody2D_is_on_floor: +.. _class_KinematicBody2D_method_is_on_floor: - :ref:`bool` **is_on_floor** **(** **)** const -Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. +Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody2D_is_on_wall: +.. _class_KinematicBody2D_method_is_on_wall: - :ref:`bool` **is_on_wall** **(** **)** const -Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. +Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody2D_move_and_collide: +.. _class_KinematicBody2D_method_move_and_collide: - :ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision2D`, which contains information about the collision. -.. _class_KinematicBody2D_move_and_slide: +.. _class_KinematicBody2D_method_move_and_slide: - :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody2D`` or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. -``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — this is done by the method. +``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — this is done by the method. ``floor_normal`` is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of ``Vector2(0, 0)``, everything is considered a wall. This is useful for topdown games. @@ -147,17 +147,17 @@ If the body collides, it will change direction a maximum of ``max_slides`` times ``floor_max_angle`` is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. -Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use :ref:`get_slide_collision`. +Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use :ref:`get_slide_collision`. -.. _class_KinematicBody2D_move_and_slide_with_snap: +.. _class_KinematicBody2D_method_move_and_slide_with_snap: - :ref:`Vector2` **move_and_slide_with_snap** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** -Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_slide`. +Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_slide`. -As long as the ``snap`` vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting ``snap`` to ``(0, 0)`` or by using :ref:`move_and_slide` instead. +As long as the ``snap`` vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting ``snap`` to ``(0, 0)`` or by using :ref:`move_and_slide` instead. -.. _class_KinematicBody2D_test_move: +.. _class_KinematicBody2D_method_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true **)** diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 345d20cfc..28fc24e32 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -19,41 +19,41 @@ Collision data for KinematicBody collisions. Properties ---------- -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_id` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collider_metadata` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider_shape` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_shape_index` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`collider_velocity` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`local_shape` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`normal` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`position` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`remainder` | -+-------------------------------+----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`travel` | -+-------------------------------+----------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`collider` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collider_id` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`collider_metadata` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`collider_shape` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collider_shape_index` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`collider_velocity` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`local_shape` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`normal` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`position` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`remainder` | ++-------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`travel` | ++-------------------------------+-------------------------------------------------------------------------------------+ Description ----------- -Contains collision data for KinematicBody collisions. When a :ref:`KinematicBody` is moved using :ref:`KinematicBody.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision object is returned. +Contains collision data for KinematicBody collisions. When a :ref:`KinematicBody` is moved using :ref:`KinematicBody.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision object is returned. This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. Property Descriptions --------------------- -.. _class_KinematicCollision_collider: +.. _class_KinematicCollision_property_collider: - :ref:`Object` **collider** @@ -63,7 +63,7 @@ Property Descriptions The colliding body. -.. _class_KinematicCollision_collider_id: +.. _class_KinematicCollision_property_collider_id: - :ref:`int` **collider_id** @@ -73,7 +73,7 @@ The colliding body. The colliding body's unique :ref:`RID`. -.. _class_KinematicCollision_collider_metadata: +.. _class_KinematicCollision_property_collider_metadata: - :ref:`Variant` **collider_metadata** @@ -83,7 +83,7 @@ The colliding body's unique :ref:`RID`. The colliding body's metadata. See :ref:`Object`. -.. _class_KinematicCollision_collider_shape: +.. _class_KinematicCollision_property_collider_shape: - :ref:`Object` **collider_shape** @@ -93,7 +93,7 @@ The colliding body's metadata. See :ref:`Object`. The colliding body's shape. -.. _class_KinematicCollision_collider_shape_index: +.. _class_KinematicCollision_property_collider_shape_index: - :ref:`int` **collider_shape_index** @@ -103,7 +103,7 @@ The colliding body's shape. The colliding shape's index. See :ref:`CollisionObject`. -.. _class_KinematicCollision_collider_velocity: +.. _class_KinematicCollision_property_collider_velocity: - :ref:`Vector3` **collider_velocity** @@ -113,7 +113,7 @@ The colliding shape's index. See :ref:`CollisionObject`. The colliding object's velocity. -.. _class_KinematicCollision_local_shape: +.. _class_KinematicCollision_property_local_shape: - :ref:`Object` **local_shape** @@ -123,7 +123,7 @@ The colliding object's velocity. The moving object's colliding shape. -.. _class_KinematicCollision_normal: +.. _class_KinematicCollision_property_normal: - :ref:`Vector3` **normal** @@ -133,7 +133,7 @@ The moving object's colliding shape. The colliding body's shape's normal at the point of collision. -.. _class_KinematicCollision_position: +.. _class_KinematicCollision_property_position: - :ref:`Vector3` **position** @@ -143,7 +143,7 @@ The colliding body's shape's normal at the point of collision. The point of collision. -.. _class_KinematicCollision_remainder: +.. _class_KinematicCollision_property_remainder: - :ref:`Vector3` **remainder** @@ -153,7 +153,7 @@ The point of collision. The moving object's remaining movement vector. -.. _class_KinematicCollision_travel: +.. _class_KinematicCollision_property_travel: - :ref:`Vector3` **travel** diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 766ea3bcc..d92814c15 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -19,41 +19,41 @@ Collision data for KinematicBody2D collisions. Properties ---------- -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_id` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collider_metadata` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider_shape` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_shape_index` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`collider_velocity` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`local_shape` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`normal` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`remainder` | -+-------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`travel` | -+-------------------------------+------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`collider` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collider_id` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`collider_metadata` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`collider_shape` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collider_shape_index` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`collider_velocity` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`local_shape` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`normal` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`remainder` | ++-------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`travel` | ++-------------------------------+---------------------------------------------------------------------------------------+ Description ----------- -Contains collision data for KinematicBody2D collisions. When a :ref:`KinematicBody2D` is moved using :ref:`KinematicBody2D.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision2D object is returned. +Contains collision data for KinematicBody2D collisions. When a :ref:`KinematicBody2D` is moved using :ref:`KinematicBody2D.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision2D object is returned. This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. Property Descriptions --------------------- -.. _class_KinematicCollision2D_collider: +.. _class_KinematicCollision2D_property_collider: - :ref:`Object` **collider** @@ -63,7 +63,7 @@ Property Descriptions The colliding body. -.. _class_KinematicCollision2D_collider_id: +.. _class_KinematicCollision2D_property_collider_id: - :ref:`int` **collider_id** @@ -73,7 +73,7 @@ The colliding body. The colliding body's unique :ref:`RID`. -.. _class_KinematicCollision2D_collider_metadata: +.. _class_KinematicCollision2D_property_collider_metadata: - :ref:`Variant` **collider_metadata** @@ -83,7 +83,7 @@ The colliding body's unique :ref:`RID`. The colliding body's metadata. See :ref:`Object`. -.. _class_KinematicCollision2D_collider_shape: +.. _class_KinematicCollision2D_property_collider_shape: - :ref:`Object` **collider_shape** @@ -93,7 +93,7 @@ The colliding body's metadata. See :ref:`Object`. The colliding body's shape. -.. _class_KinematicCollision2D_collider_shape_index: +.. _class_KinematicCollision2D_property_collider_shape_index: - :ref:`int` **collider_shape_index** @@ -103,7 +103,7 @@ The colliding body's shape. The colliding shape's index. See :ref:`CollisionObject2D`. -.. _class_KinematicCollision2D_collider_velocity: +.. _class_KinematicCollision2D_property_collider_velocity: - :ref:`Vector2` **collider_velocity** @@ -113,7 +113,7 @@ The colliding shape's index. See :ref:`CollisionObject2D` **local_shape** @@ -123,7 +123,7 @@ The colliding object's velocity. The moving object's colliding shape. -.. _class_KinematicCollision2D_normal: +.. _class_KinematicCollision2D_property_normal: - :ref:`Vector2` **normal** @@ -133,7 +133,7 @@ The moving object's colliding shape. The colliding body's shape's normal at the point of collision. -.. _class_KinematicCollision2D_position: +.. _class_KinematicCollision2D_property_position: - :ref:`Vector2` **position** @@ -143,7 +143,7 @@ The colliding body's shape's normal at the point of collision. The point of collision. -.. _class_KinematicCollision2D_remainder: +.. _class_KinematicCollision2D_property_remainder: - :ref:`Vector2` **remainder** @@ -153,7 +153,7 @@ The point of collision. The moving object's remaining movement vector. -.. _class_KinematicCollision2D_travel: +.. _class_KinematicCollision2D_property_travel: - :ref:`Vector2` **travel** diff --git a/classes/class_label.rst b/classes/class_label.rst index 9b27f3946..81c2c36c0 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -19,69 +19,77 @@ Displays plain text in a line or wrapped inside a rectangle. For formatted text, Properties ---------- -+----------------------------------+-----------------------------------------------------------+ -| :ref:`Align` | :ref:`align` | -+----------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`autowrap` | -+----------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`clip_text` | -+----------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`lines_skipped` | -+----------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`max_lines_visible` | -+----------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`percent_visible` | -+----------------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+----------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`uppercase` | -+----------------------------------+-----------------------------------------------------------+ -| :ref:`VAlign` | :ref:`valign` | -+----------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`visible_characters` | -+----------------------------------+-----------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`Align` | :ref:`align` | ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`autowrap` | ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`clip_text` | ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`lines_skipped` | ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`max_lines_visible` | ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`percent_visible` | ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`text` | ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`uppercase` | ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`VAlign` | :ref:`valign` | ++----------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`visible_characters` | ++----------------------------------+--------------------------------------------------------------------+ 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 ---------------- -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_shadow` | -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_outline_modulate` | -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`line_spacing` | -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_as_outline` | -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_offset_x` | -+---------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_offset_y` | -+---------------------------------+-----------------------------------------------------------------+ ++---------------------------------+-----------------------+ +| :ref:`Font` | font | ++---------------------------------+-----------------------+ +| :ref:`Color` | font_color | ++---------------------------------+-----------------------+ +| :ref:`Color` | font_color_shadow | ++---------------------------------+-----------------------+ +| :ref:`Color` | font_outline_modulate | ++---------------------------------+-----------------------+ +| :ref:`int` | line_spacing | ++---------------------------------+-----------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+-----------------------+ +| :ref:`int` | shadow_as_outline | ++---------------------------------+-----------------------+ +| :ref:`int` | shadow_offset_x | ++---------------------------------+-----------------------+ +| :ref:`int` | shadow_offset_y | ++---------------------------------+-----------------------+ Enumerations ------------ .. _enum_Label_Align: +.. _class_Label_constant_ALIGN_LEFT: + +.. _class_Label_constant_ALIGN_CENTER: + +.. _class_Label_constant_ALIGN_RIGHT: + +.. _class_Label_constant_ALIGN_FILL: + enum **Align**: - **ALIGN_LEFT** = **0** --- Align rows to the left (default). @@ -94,6 +102,14 @@ enum **Align**: .. _enum_Label_VAlign: +.. _class_Label_constant_VALIGN_TOP: + +.. _class_Label_constant_VALIGN_CENTER: + +.. _class_Label_constant_VALIGN_BOTTOM: + +.. _class_Label_constant_VALIGN_FILL: + enum **VAlign**: - **VALIGN_TOP** = **0** --- Align the whole text to the top. @@ -109,12 +125,12 @@ Description Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment, and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics or other formatting. For that, use :ref:`RichTextLabel` instead. -Note that contrarily to most other :ref:`Control`\ s, Label's :ref:`Control.mouse_filter` defaults to MOUSE_FILTER_IGNORE (i.e. it doesn't react to mouse input events). +Note that contrarily to most other :ref:`Control`\ s, Label's :ref:`Control.mouse_filter` defaults to MOUSE_FILTER_IGNORE (i.e. it doesn't react to mouse input events). Property Descriptions --------------------- -.. _class_Label_align: +.. _class_Label_property_align: - :ref:`Align` **align** @@ -126,7 +142,7 @@ Property Descriptions Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN_*`` constants. -.. _class_Label_autowrap: +.. _class_Label_property_autowrap: - :ref:`bool` **autowrap** @@ -138,7 +154,7 @@ Controls the text's horizontal align. Supports left, center, right, and fill, or If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: false. -.. _class_Label_clip_text: +.. _class_Label_property_clip_text: - :ref:`bool` **clip_text** @@ -150,7 +166,7 @@ If ``true``, wraps the text inside the node's bounding rectangle. If you resize If ``true``, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. -.. _class_Label_lines_skipped: +.. _class_Label_property_lines_skipped: - :ref:`int` **lines_skipped** @@ -162,7 +178,7 @@ If ``true``, the Label only shows the text that fits inside its bounding rectang The node ignores the first ``lines_skipped`` lines before it starts to display text. -.. _class_Label_max_lines_visible: +.. _class_Label_property_max_lines_visible: - :ref:`int` **max_lines_visible** @@ -174,7 +190,7 @@ The node ignores the first ``lines_skipped`` lines before it starts to display t Limits the lines of text the node shows on screen. -.. _class_Label_percent_visible: +.. _class_Label_property_percent_visible: - :ref:`float` **percent_visible** @@ -186,7 +202,7 @@ Limits the lines of text the node shows on screen. Limits the count of visible characters. If you set ``percent_visible`` to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box. -.. _class_Label_text: +.. _class_Label_property_text: - :ref:`String` **text** @@ -198,7 +214,7 @@ Limits the count of visible characters. If you set ``percent_visible`` to 50, on The text to display on screen. -.. _class_Label_uppercase: +.. _class_Label_property_uppercase: - :ref:`bool` **uppercase** @@ -210,7 +226,7 @@ The text to display on screen. If ``true``, all the text displays as UPPERCASE. -.. _class_Label_valign: +.. _class_Label_property_valign: - :ref:`VAlign` **valign** @@ -222,7 +238,7 @@ If ``true``, all the text displays as UPPERCASE. Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants. -.. _class_Label_visible_characters: +.. _class_Label_property_visible_characters: - :ref:`int` **visible_characters** @@ -237,25 +253,25 @@ Restricts the number of characters to display. Set to -1 to disable. Method Descriptions ------------------- -.. _class_Label_get_line_count: +.. _class_Label_method_get_line_count: - :ref:`int` **get_line_count** **(** **)** const Returns the amount of lines of text the Label has. -.. _class_Label_get_line_height: +.. _class_Label_method_get_line_height: - :ref:`int` **get_line_height** **(** **)** const Returns the font size in pixels. -.. _class_Label_get_total_character_count: +.. _class_Label_method_get_total_character_count: - :ref:`int` **get_total_character_count** **(** **)** const Returns the total number of printable characters in the text (excluding spaces and newlines). -.. _class_Label_get_visible_line_count: +.. _class_Label_method_get_visible_line_count: - :ref:`int` **get_visible_line_count** **(** **)** const diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index 18240f06c..36050cd5a 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -19,23 +19,23 @@ A Texture capable of storing many smaller Textures with offsets. Methods ------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_piece` **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_piece_count` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_piece_offset` **(** :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 **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_piece_texture` **(** :ref:`int` idx, :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_piece` **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_piece_count` **(** **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_piece_offset` **(** :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 **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_piece_texture` **(** :ref:`int` idx, :ref:`Texture` texture **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -47,49 +47,49 @@ You can dynamically add pieces(:ref:`Texture`) to this ``LargeTex Method Descriptions ------------------- -.. _class_LargeTexture_add_piece: +.. _class_LargeTexture_method_add_piece: - :ref:`int` **add_piece** **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** Add another :ref:`Texture` to this ``LargeTexture``, starting on offset "ofs". -.. _class_LargeTexture_clear: +.. _class_LargeTexture_method_clear: - void **clear** **(** **)** Clears the ``LargeTexture``. -.. _class_LargeTexture_get_piece_count: +.. _class_LargeTexture_method_get_piece_count: - :ref:`int` **get_piece_count** **(** **)** const Returns the number of pieces currently in this ``LargeTexture``. -.. _class_LargeTexture_get_piece_offset: +.. _class_LargeTexture_method_get_piece_offset: - :ref:`Vector2` **get_piece_offset** **(** :ref:`int` idx **)** const Returns the offset of the piece with index "idx". -.. _class_LargeTexture_get_piece_texture: +.. _class_LargeTexture_method_get_piece_texture: - :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** const Returns the :ref:`Texture` of the piece with index "idx". -.. _class_LargeTexture_set_piece_offset: +.. _class_LargeTexture_method_set_piece_offset: - void **set_piece_offset** **(** :ref:`int` idx, :ref:`Vector2` ofs **)** Sets the offset of the piece with index "idx" to "ofs". -.. _class_LargeTexture_set_piece_texture: +.. _class_LargeTexture_method_set_piece_texture: - void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture` texture **)** Sets the :ref:`Texture` of the piece with index "idx" to "texture". -.. _class_LargeTexture_set_size: +.. _class_LargeTexture_method_set_size: - void **set_size** **(** :ref:`Vector2` size **)** diff --git a/classes/class_light.rst b/classes/class_light.rst index 26450962b..be23253ff 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -21,39 +21,71 @@ Provides a base class for different kinds of light nodes. Properties ---------- -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_only` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`BakeMode` | :ref:`light_bake_mode` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`light_color` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`light_cull_mask` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`light_energy` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`light_indirect_energy` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`light_negative` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`light_specular` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`shadow_bias` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`shadow_color` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`shadow_contact` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shadow_enabled` | -+--------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shadow_reverse_cull_face` | -+--------------------------------------+-----------------------------------------------------------------------+ ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor_only` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`BakeMode` | :ref:`light_bake_mode` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`light_color` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`light_cull_mask` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`light_energy` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`light_indirect_energy` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`light_negative` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`light_specular` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shadow_bias` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`shadow_color` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shadow_contact` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shadow_enabled` | ++--------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shadow_reverse_cull_face` | ++--------------------------------------+--------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Light_Param: +.. _class_Light_constant_PARAM_ENERGY: + +.. _class_Light_constant_PARAM_INDIRECT_ENERGY: + +.. _class_Light_constant_PARAM_SPECULAR: + +.. _class_Light_constant_PARAM_RANGE: + +.. _class_Light_constant_PARAM_ATTENUATION: + +.. _class_Light_constant_PARAM_SPOT_ANGLE: + +.. _class_Light_constant_PARAM_SPOT_ATTENUATION: + +.. _class_Light_constant_PARAM_CONTACT_SHADOW_SIZE: + +.. _class_Light_constant_PARAM_SHADOW_MAX_DISTANCE: + +.. _class_Light_constant_PARAM_SHADOW_SPLIT_1_OFFSET: + +.. _class_Light_constant_PARAM_SHADOW_SPLIT_2_OFFSET: + +.. _class_Light_constant_PARAM_SHADOW_SPLIT_3_OFFSET: + +.. _class_Light_constant_PARAM_SHADOW_NORMAL_BIAS: + +.. _class_Light_constant_PARAM_SHADOW_BIAS: + +.. _class_Light_constant_PARAM_SHADOW_BIAS_SPLIT_SCALE: + +.. _class_Light_constant_PARAM_MAX: + enum **Param**: - **PARAM_ENERGY** = **0** @@ -90,6 +122,12 @@ enum **Param**: .. _enum_Light_BakeMode: +.. _class_Light_constant_BAKE_DISABLED: + +.. _class_Light_constant_BAKE_INDIRECT: + +.. _class_Light_constant_BAKE_ALL: + enum **BakeMode**: - **BAKE_DISABLED** = **0** --- Light is ignored when baking. Note: hiding a light does *not* affect baking. @@ -111,7 +149,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Light_editor_only: +.. _class_Light_property_editor_only: - :ref:`bool` **editor_only** @@ -123,7 +161,7 @@ Property Descriptions If ``true``, the light only appears in the editor and will not be visible at runtime. Default value:``false``. -.. _class_Light_light_bake_mode: +.. _class_Light_property_light_bake_mode: - :ref:`BakeMode` **light_bake_mode** @@ -133,9 +171,9 @@ If ``true``, the light only appears in the editor and will not be visible at run | *Getter* | get_bake_mode() | +----------+----------------------+ -The light's bake mode. See :ref:`BakeMode`. +The light's bake mode. See :ref:`BakeMode`. -.. _class_Light_light_color: +.. _class_Light_property_light_color: - :ref:`Color` **light_color** @@ -147,7 +185,7 @@ The light's bake mode. See :ref:`BakeMode`. The light's color. -.. _class_Light_light_cull_mask: +.. _class_Light_property_light_cull_mask: - :ref:`int` **light_cull_mask** @@ -159,7 +197,7 @@ The light's color. The light will affect objects in the selected layers. -.. _class_Light_light_energy: +.. _class_Light_property_light_energy: - :ref:`float` **light_energy** @@ -171,7 +209,7 @@ The light will affect objects in the selected layers. The light's strength multiplier. -.. _class_Light_light_indirect_energy: +.. _class_Light_property_light_indirect_energy: - :ref:`float` **light_indirect_energy** @@ -183,7 +221,7 @@ The light's strength multiplier. Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. -.. _class_Light_light_negative: +.. _class_Light_property_light_negative: - :ref:`bool` **light_negative** @@ -195,7 +233,7 @@ Secondary multiplier used with indirect light (light bounces). This works in bak If ``true``, the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. -.. _class_Light_light_specular: +.. _class_Light_property_light_specular: - :ref:`float` **light_specular** @@ -207,7 +245,7 @@ If ``true``, the light's effect is reversed, darkening areas and casting bright The intensity of the specular blob in objects affected by the light. At ``0`` the light becomes a pure diffuse light. -.. _class_Light_shadow_bias: +.. _class_Light_property_shadow_bias: - :ref:`float` **shadow_bias** @@ -219,7 +257,7 @@ The intensity of the specular blob in objects affected by the light. At ``0`` th Used to adjust shadow appearance. Too small a value results in self shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. -.. _class_Light_shadow_color: +.. _class_Light_property_shadow_color: - :ref:`Color` **shadow_color** @@ -231,7 +269,7 @@ Used to adjust shadow appearance. Too small a value results in self shadowing, w The color of shadows cast by this light. -.. _class_Light_shadow_contact: +.. _class_Light_property_shadow_contact: - :ref:`float` **shadow_contact** @@ -241,9 +279,9 @@ The color of shadows cast by this light. | *Getter* | get_param() | +----------+------------------+ -Attempts to reduce :ref:`shadow_bias` gap. +Attempts to reduce :ref:`shadow_bias` gap. -.. _class_Light_shadow_enabled: +.. _class_Light_property_shadow_enabled: - :ref:`bool` **shadow_enabled** @@ -255,7 +293,7 @@ Attempts to reduce :ref:`shadow_bias` gap. If ``true``, the light will cast shadows. Default value: ``false``. -.. _class_Light_shadow_reverse_cull_face: +.. _class_Light_property_shadow_reverse_cull_face: - :ref:`bool` **shadow_reverse_cull_face** diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index ed08c3821..687ad7be1 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -19,55 +19,63 @@ Casts light in a 2D environment. Properties ---------- -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor_only` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`energy` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`range_height` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_item_cull_mask` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_layer_max` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_layer_min` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_z_max` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`range_z_min` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_buffer_size` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`Color` | :ref:`shadow_color` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shadow_enabled` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`ShadowFilter` | :ref:`shadow_filter` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`shadow_filter_smooth` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`shadow_gradient_length` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_item_cull_mask` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`float` | :ref:`texture_scale` | -+------------------------------------------------+---------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor_only` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`enabled` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`energy` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`offset` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`range_height` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`range_item_cull_mask` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`range_layer_max` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`range_layer_min` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`range_z_max` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`range_z_min` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shadow_buffer_size` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`shadow_color` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shadow_enabled` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`ShadowFilter` | :ref:`shadow_filter` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shadow_filter_smooth` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shadow_gradient_length` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shadow_item_cull_mask` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`texture_scale` | ++------------------------------------------------+------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Light2D_Mode: +.. _class_Light2D_constant_MODE_ADD: + +.. _class_Light2D_constant_MODE_SUB: + +.. _class_Light2D_constant_MODE_MIX: + +.. _class_Light2D_constant_MODE_MASK: + enum **Mode**: - **MODE_ADD** = **0** --- Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. @@ -80,19 +88,31 @@ enum **Mode**: .. _enum_Light2D_ShadowFilter: +.. _class_Light2D_constant_SHADOW_FILTER_NONE: + +.. _class_Light2D_constant_SHADOW_FILTER_PCF3: + +.. _class_Light2D_constant_SHADOW_FILTER_PCF5: + +.. _class_Light2D_constant_SHADOW_FILTER_PCF7: + +.. _class_Light2D_constant_SHADOW_FILTER_PCF9: + +.. _class_Light2D_constant_SHADOW_FILTER_PCF13: + enum **ShadowFilter**: -- **SHADOW_FILTER_NONE** = **0** --- No filter applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_NONE** = **0** --- No filter applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF3** = **1** --- Percentage closer filtering (3 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF3** = **1** --- Percentage closer filtering (3 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF5** = **2** --- Percentage closer filtering (5 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF5** = **2** --- Percentage closer filtering (5 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF7** = **3** --- Percentage closer filtering (7 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF7** = **3** --- Percentage closer filtering (7 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF9** = **4** --- Percentage closer filtering (9 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF9** = **4** --- Percentage closer filtering (9 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF13** = **5** --- Percentage closer filtering (13 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF13** = **5** --- Percentage closer filtering (13 samples) applies to the shadow map. See :ref:`shadow_filter`. Description ----------- @@ -102,7 +122,7 @@ Casts light in a 2D environment. Light is defined by a (usually grayscale) textu Property Descriptions --------------------- -.. _class_Light2D_color: +.. _class_Light2D_property_color: - :ref:`Color` **color** @@ -114,7 +134,7 @@ Property Descriptions The Light2D's :ref:`Color`. -.. _class_Light2D_editor_only: +.. _class_Light2D_property_editor_only: - :ref:`bool` **editor_only** @@ -126,7 +146,7 @@ The Light2D's :ref:`Color`. If ``true``, Light2D will only appear when editing the scene. Default value: ``false``. -.. _class_Light2D_enabled: +.. _class_Light2D_property_enabled: - :ref:`bool` **enabled** @@ -138,7 +158,7 @@ If ``true``, Light2D will only appear when editing the scene. Default value: ``f If ``true``, Light2D will emit light. Default value: ``true``. -.. _class_Light2D_energy: +.. _class_Light2D_property_energy: - :ref:`float` **energy** @@ -150,7 +170,7 @@ If ``true``, Light2D will emit light. Default value: ``true``. The Light2D's energy value. The larger the value, the stronger the light. -.. _class_Light2D_mode: +.. _class_Light2D_property_mode: - :ref:`Mode` **mode** @@ -162,7 +182,7 @@ The Light2D's energy value. The larger the value, the stronger the light. The Light2D's mode. See MODE\_\* constants for values. -.. _class_Light2D_offset: +.. _class_Light2D_property_offset: - :ref:`Vector2` **offset** @@ -174,7 +194,7 @@ The Light2D's mode. See MODE\_\* constants for values. The offset of the Light2D's ``texture``. -.. _class_Light2D_range_height: +.. _class_Light2D_property_range_height: - :ref:`float` **range_height** @@ -186,7 +206,7 @@ The offset of the Light2D's ``texture``. The height of the Light2D. Used with 2D normal mapping. -.. _class_Light2D_range_item_cull_mask: +.. _class_Light2D_property_range_item_cull_mask: - :ref:`int` **range_item_cull_mask** @@ -198,7 +218,7 @@ The height of the Light2D. Used with 2D normal mapping. The layer mask. Only objects with a matching mask will be affected by the Light2D. -.. _class_Light2D_range_layer_max: +.. _class_Light2D_property_range_layer_max: - :ref:`int` **range_layer_max** @@ -210,7 +230,7 @@ The layer mask. Only objects with a matching mask will be affected by the Light2 Maximum layer value of objects that are affected by the Light2D. Default value: ``0``. -.. _class_Light2D_range_layer_min: +.. _class_Light2D_property_range_layer_min: - :ref:`int` **range_layer_min** @@ -222,7 +242,7 @@ Maximum layer value of objects that are affected by the Light2D. Default value: Minimum layer value of objects that are affected by the Light2D. Default value: ``0``. -.. _class_Light2D_range_z_max: +.. _class_Light2D_property_range_z_max: - :ref:`int` **range_z_max** @@ -234,7 +254,7 @@ Minimum layer value of objects that are affected by the Light2D. Default value: Maximum ``Z`` value of objects that are affected by the Light2D. Default value: ``1024``. -.. _class_Light2D_range_z_min: +.. _class_Light2D_property_range_z_min: - :ref:`int` **range_z_min** @@ -246,7 +266,7 @@ Maximum ``Z`` value of objects that are affected by the Light2D. Default value: Minimum ``z`` value of objects that are affected by the Light2D. Default value: ``-1024``. -.. _class_Light2D_shadow_buffer_size: +.. _class_Light2D_property_shadow_buffer_size: - :ref:`int` **shadow_buffer_size** @@ -258,7 +278,7 @@ Minimum ``z`` value of objects that are affected by the Light2D. Default value: Shadow buffer size. Default value: ``2048``. -.. _class_Light2D_shadow_color: +.. _class_Light2D_property_shadow_color: - :ref:`Color` **shadow_color** @@ -270,7 +290,7 @@ Shadow buffer size. Default value: ``2048``. :ref:`Color` of shadows cast by the Light2D. -.. _class_Light2D_shadow_enabled: +.. _class_Light2D_property_shadow_enabled: - :ref:`bool` **shadow_enabled** @@ -282,7 +302,7 @@ Shadow buffer size. Default value: ``2048``. If ``true``, the Light2D will cast shadows. Default value: ``false``. -.. _class_Light2D_shadow_filter: +.. _class_Light2D_property_shadow_filter: - :ref:`ShadowFilter` **shadow_filter** @@ -294,7 +314,7 @@ If ``true``, the Light2D will cast shadows. Default value: ``false``. Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. Default value: ``None``. -.. _class_Light2D_shadow_filter_smooth: +.. _class_Light2D_property_shadow_filter_smooth: - :ref:`float` **shadow_filter_smooth** @@ -306,7 +326,7 @@ Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. De Smoothing value for shadows. -.. _class_Light2D_shadow_gradient_length: +.. _class_Light2D_property_shadow_gradient_length: - :ref:`float` **shadow_gradient_length** @@ -318,7 +338,7 @@ Smoothing value for shadows. Smooth shadow gradient length. -.. _class_Light2D_shadow_item_cull_mask: +.. _class_Light2D_property_shadow_item_cull_mask: - :ref:`int` **shadow_item_cull_mask** @@ -330,7 +350,7 @@ Smooth shadow gradient length. The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching shadow mask will cast shadows. -.. _class_Light2D_texture: +.. _class_Light2D_property_texture: - :ref:`Texture` **texture** @@ -342,7 +362,7 @@ The shadow mask. Used with :ref:`LightOccluder2D` to cast :ref:`Texture` used for the Light2D's appearance. -.. _class_Light2D_texture_scale: +.. _class_Light2D_property_texture_scale: - :ref:`float` **texture_scale** diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index b2d75e3c2..8751f0d68 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -19,11 +19,11 @@ Occludes light cast by a Light2D, casting shadows. Properties ---------- -+---------------------------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`light_mask` | -+---------------------------------------------------+-----------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`occluder` | -+---------------------------------------------------+-----------------------------------------------------+ ++---------------------------------------------------+--------------------------------------------------------------+ +| :ref:`int` | :ref:`light_mask` | ++---------------------------------------------------+--------------------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`occluder` | ++---------------------------------------------------+--------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be p Property Descriptions --------------------- -.. _class_LightOccluder2D_light_mask: +.. _class_LightOccluder2D_property_light_mask: - :ref:`int` **light_mask** @@ -45,7 +45,7 @@ Property Descriptions The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). -.. _class_LightOccluder2D_occluder: +.. _class_LightOccluder2D_property_occluder: - :ref:`OccluderPolygon2D` **occluder** diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index f38551dff..bd97347bd 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -19,50 +19,56 @@ A 2D line. Properties ---------- -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`LineCapMode` | :ref:`begin_cap_mode` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`Color` | :ref:`default_color` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`LineCapMode` | :ref:`end_cap_mode` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`Gradient` | :ref:`gradient` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`LineJointMode` | :ref:`joint_mode` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`points` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`round_precision` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`sharp_limit` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`LineTextureMode` | :ref:`texture_mode` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`width` | -+-----------------------------------------------------+------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`LineCapMode` | :ref:`begin_cap_mode` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Color` | :ref:`default_color` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`LineCapMode` | :ref:`end_cap_mode` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`gradient` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`LineJointMode` | :ref:`joint_mode` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`points` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`round_precision` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`sharp_limit` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`LineTextureMode` | :ref:`texture_mode` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`width` | ++-----------------------------------------------------+---------------------------------------------------------------+ Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` position **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` i **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` i, :ref:`Vector2` position **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` position **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` i **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` i, :ref:`Vector2` position **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Line2D_LineJointMode: +.. _class_Line2D_constant_LINE_JOINT_SHARP: + +.. _class_Line2D_constant_LINE_JOINT_BEVEL: + +.. _class_Line2D_constant_LINE_JOINT_ROUND: + enum **LineJointMode**: - **LINE_JOINT_SHARP** = **0** --- The line's joints will be pointy. If ``sharp_limit`` is greater than the rotation of a joint, it becomes a bevel joint instead. @@ -73,6 +79,12 @@ enum **LineJointMode**: .. _enum_Line2D_LineCapMode: +.. _class_Line2D_constant_LINE_CAP_NONE: + +.. _class_Line2D_constant_LINE_CAP_BOX: + +.. _class_Line2D_constant_LINE_CAP_ROUND: + enum **LineCapMode**: - **LINE_CAP_NONE** = **0** --- Don't have a line cap. @@ -83,6 +95,12 @@ enum **LineCapMode**: .. _enum_Line2D_LineTextureMode: +.. _class_Line2D_constant_LINE_TEXTURE_NONE: + +.. _class_Line2D_constant_LINE_TEXTURE_TILE: + +.. _class_Line2D_constant_LINE_TEXTURE_STRETCH: + enum **LineTextureMode**: - **LINE_TEXTURE_NONE** = **0** --- Takes the left pixels of the texture and renders it over the whole line. @@ -99,7 +117,7 @@ A line through several points in 2D space. Property Descriptions --------------------- -.. _class_Line2D_begin_cap_mode: +.. _class_Line2D_property_begin_cap_mode: - :ref:`LineCapMode` **begin_cap_mode** @@ -111,7 +129,7 @@ Property Descriptions Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. -.. _class_Line2D_default_color: +.. _class_Line2D_property_default_color: - :ref:`Color` **default_color** @@ -123,7 +141,7 @@ Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Defa The line's color. Will not be used if a gradient is set. -.. _class_Line2D_end_cap_mode: +.. _class_Line2D_property_end_cap_mode: - :ref:`LineCapMode` **end_cap_mode** @@ -135,7 +153,7 @@ The line's color. Will not be used if a gradient is set. Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. -.. _class_Line2D_gradient: +.. _class_Line2D_property_gradient: - :ref:`Gradient` **gradient** @@ -147,7 +165,7 @@ Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Defau The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. -.. _class_Line2D_joint_mode: +.. _class_Line2D_property_joint_mode: - :ref:`LineJointMode` **joint_mode** @@ -159,7 +177,7 @@ The gradient is drawn through the whole line from start to finish. The default c The style for the points between the start and the end. -.. _class_Line2D_points: +.. _class_Line2D_property_points: - :ref:`PoolVector2Array` **points** @@ -171,7 +189,7 @@ The style for the points between the start and the end. The points that form the lines. The line is drawn between every point set in this array. -.. _class_Line2D_round_precision: +.. _class_Line2D_property_round_precision: - :ref:`int` **round_precision** @@ -183,7 +201,7 @@ The points that form the lines. The line is drawn between every point set in thi The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. -.. _class_Line2D_sharp_limit: +.. _class_Line2D_property_sharp_limit: - :ref:`float` **sharp_limit** @@ -195,7 +213,7 @@ The smoothness of the rounded joints and caps. This is only used if a cap or joi The direction difference in radians between vector points. This value is only used if ``joint mode`` is set to ``LINE_JOINT_SHARP``. -.. _class_Line2D_texture: +.. _class_Line2D_property_texture: - :ref:`Texture` **texture** @@ -207,7 +225,7 @@ The direction difference in radians between vector points. This value is only us The texture used for the line's texture. Uses ``texture_mode`` for drawing style. -.. _class_Line2D_texture_mode: +.. _class_Line2D_property_texture_mode: - :ref:`LineTextureMode` **texture_mode** @@ -219,7 +237,7 @@ The texture used for the line's texture. Uses ``texture_mode`` for drawing style The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. Default value: ``LINE_TEXTURE_NONE``. -.. _class_Line2D_width: +.. _class_Line2D_property_width: - :ref:`float` **width** @@ -234,31 +252,31 @@ The line's width. Method Descriptions ------------------- -.. _class_Line2D_add_point: +.. _class_Line2D_method_add_point: - void **add_point** **(** :ref:`Vector2` position **)** Add a point at the ``position``. Appends the point at the end of the line. -.. _class_Line2D_get_point_count: +.. _class_Line2D_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the Line2D's amount of points. -.. _class_Line2D_get_point_position: +.. _class_Line2D_method_get_point_position: - :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const Returns point ``i``'s position. -.. _class_Line2D_remove_point: +.. _class_Line2D_method_remove_point: - void **remove_point** **(** :ref:`int` i **)** Remove the point at index ``i`` from the line. -.. _class_Line2D_set_point_position: +.. _class_Line2D_method_set_point_position: - void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 444ba13f4..b4b08dd77 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -19,96 +19,96 @@ Control that provides single line string editing. Properties ---------- -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`Align` | :ref:`align` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`caret_blink` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`caret_blink_speed` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`caret_position` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`clear_button_enabled` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`context_menu_enabled` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editable` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`expand_to_text_length` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`FocusMode` | :ref:`focus_mode` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_length` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`placeholder_alpha` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`placeholder_text` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`secret` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`secret_character` | -+------------------------------------------+--------------------------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+------------------------------------------+--------------------------------------------------------------------+ ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`Align` | :ref:`align` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`caret_blink` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`caret_blink_speed` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`int` | :ref:`caret_position` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`clear_button_enabled` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`context_menu_enabled` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editable` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`expand_to_text_length` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`FocusMode` | :ref:`focus_mode` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`int` | :ref:`max_length` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`placeholder_alpha` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`String` | :ref:`placeholder_text` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`secret` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`String` | :ref:`secret_character` | ++------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`String` | :ref:`text` | ++------------------------------------------+-----------------------------------------------------------------------------+ Methods ------- -+------------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_at_cursor` **(** :ref:`String` text **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`menu_option` **(** :ref:`int` option **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from=0, :ref:`int` to=-1 **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_all` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_at_cursor` **(** :ref:`String` text **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`menu_option` **(** :ref:`int` option **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` from=0, :ref:`int` to=-1 **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_all` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`clear` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`clear_button_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`clear_button_color_pressed` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`cursor_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_selected` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`minimum_spaces` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`read_only` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`selection_color` | -+---------------------------------+------------------------------------------------------------------------------+ ++---------------------------------+----------------------------+ +| :ref:`Texture` | clear | ++---------------------------------+----------------------------+ +| :ref:`Color` | clear_button_color | ++---------------------------------+----------------------------+ +| :ref:`Color` | clear_button_color_pressed | ++---------------------------------+----------------------------+ +| :ref:`Color` | cursor_color | ++---------------------------------+----------------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+----------------------------+ +| :ref:`Font` | font | ++---------------------------------+----------------------------+ +| :ref:`Color` | font_color | ++---------------------------------+----------------------------+ +| :ref:`Color` | font_color_selected | ++---------------------------------+----------------------------+ +| :ref:`int` | minimum_spaces | ++---------------------------------+----------------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+----------------------------+ +| :ref:`StyleBox` | read_only | ++---------------------------------+----------------------------+ +| :ref:`Color` | selection_color | ++---------------------------------+----------------------------+ Signals ------- -.. _class_LineEdit_text_changed: +.. _class_LineEdit_signal_text_changed: - **text_changed** **(** :ref:`String` new_text **)** Emitted when the text changes. -.. _class_LineEdit_text_entered: +.. _class_LineEdit_signal_text_entered: - **text_entered** **(** :ref:`String` new_text **)** @@ -119,6 +119,14 @@ Enumerations .. _enum_LineEdit_Align: +.. _class_LineEdit_constant_ALIGN_LEFT: + +.. _class_LineEdit_constant_ALIGN_CENTER: + +.. _class_LineEdit_constant_ALIGN_RIGHT: + +.. _class_LineEdit_constant_ALIGN_FILL: + enum **Align**: - **ALIGN_LEFT** = **0** --- Aligns the text on the left hand side of the ``LineEdit``. @@ -131,6 +139,22 @@ enum **Align**: .. _enum_LineEdit_MenuItems: +.. _class_LineEdit_constant_MENU_CUT: + +.. _class_LineEdit_constant_MENU_COPY: + +.. _class_LineEdit_constant_MENU_PASTE: + +.. _class_LineEdit_constant_MENU_CLEAR: + +.. _class_LineEdit_constant_MENU_SELECT_ALL: + +.. _class_LineEdit_constant_MENU_UNDO: + +.. _class_LineEdit_constant_MENU_REDO: + +.. _class_LineEdit_constant_MENU_MAX: + enum **MenuItems**: - **MENU_CUT** = **0** --- Cuts (copies and clears) the selected text. @@ -157,7 +181,7 @@ LineEdit provides a single line string editor, used for text fields. Property Descriptions --------------------- -.. _class_LineEdit_align: +.. _class_LineEdit_property_align: - :ref:`Align` **align** @@ -169,7 +193,7 @@ Property Descriptions Text alignment as defined in the ALIGN\_\* enum. -.. _class_LineEdit_caret_blink: +.. _class_LineEdit_property_caret_blink: - :ref:`bool` **caret_blink** @@ -181,7 +205,7 @@ Text alignment as defined in the ALIGN\_\* enum. If ``true``, the caret (visual cursor) blinks. -.. _class_LineEdit_caret_blink_speed: +.. _class_LineEdit_property_caret_blink_speed: - :ref:`float` **caret_blink_speed** @@ -193,7 +217,7 @@ If ``true``, the caret (visual cursor) blinks. Duration (in seconds) of a caret's blinking cycle. -.. _class_LineEdit_caret_position: +.. _class_LineEdit_property_caret_position: - :ref:`int` **caret_position** @@ -205,7 +229,7 @@ Duration (in seconds) of a caret's blinking cycle. The cursor's position inside the ``LineEdit``. When set, the text may scroll to accommodate it. -.. _class_LineEdit_clear_button_enabled: +.. _class_LineEdit_property_clear_button_enabled: - :ref:`bool` **clear_button_enabled** @@ -217,7 +241,7 @@ The cursor's position inside the ``LineEdit``. When set, the text may scroll to If ``true``, the ``LineEdit`` will show a clear button if ``text`` is not empty. -.. _class_LineEdit_context_menu_enabled: +.. _class_LineEdit_property_context_menu_enabled: - :ref:`bool` **context_menu_enabled** @@ -229,7 +253,7 @@ If ``true``, the ``LineEdit`` will show a clear button if ``text`` is not empty. If ``true``, the context menu will appear when right clicked. -.. _class_LineEdit_editable: +.. _class_LineEdit_property_editable: - :ref:`bool` **editable** @@ -241,7 +265,7 @@ If ``true``, the context menu will appear when right clicked. If ``false``, existing text cannot be modified and new text cannot be added. -.. _class_LineEdit_expand_to_text_length: +.. _class_LineEdit_property_expand_to_text_length: - :ref:`bool` **expand_to_text_length** @@ -251,9 +275,9 @@ If ``false``, existing text cannot be modified and new text cannot be added. | *Getter* | get_expand_to_text_length() | +----------+----------------------------------+ -If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. +If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. -.. _class_LineEdit_focus_mode: +.. _class_LineEdit_property_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -265,7 +289,7 @@ If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:` Defines how the ``LineEdit`` can grab focus (Keyboard and mouse, only keyboard, or none). See ``enum FocusMode`` in :ref:`Control` for details. -.. _class_LineEdit_max_length: +.. _class_LineEdit_property_max_length: - :ref:`int` **max_length** @@ -277,7 +301,7 @@ Defines how the ``LineEdit`` can grab focus (Keyboard and mouse, only keyboard, Maximum amount of characters that can be entered inside the ``LineEdit``. If ``0``, there is no limit. -.. _class_LineEdit_placeholder_alpha: +.. _class_LineEdit_property_placeholder_alpha: - :ref:`float` **placeholder_alpha** @@ -287,9 +311,9 @@ Maximum amount of characters that can be entered inside the ``LineEdit``. If ``0 | *Getter* | get_placeholder_alpha() | +----------+------------------------------+ -Opacity of the :ref:`placeholder_text`. From ``0`` to ``1``. +Opacity of the :ref:`placeholder_text`. From ``0`` to ``1``. -.. _class_LineEdit_placeholder_text: +.. _class_LineEdit_property_placeholder_text: - :ref:`String` **placeholder_text** @@ -299,9 +323,9 @@ Opacity of the :ref:`placeholder_text`. From `` | *Getter* | get_placeholder() | +----------+------------------------+ -Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s default value (see :ref:`text`). +Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s default value (see :ref:`text`). -.. _class_LineEdit_secret: +.. _class_LineEdit_property_secret: - :ref:`bool` **secret** @@ -311,9 +335,9 @@ Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s defa | *Getter* | is_secret() | +----------+-------------------+ -If ``true``, every character is replaced with the secret character (see :ref:`secret_character`). +If ``true``, every character is replaced with the secret character (see :ref:`secret_character`). -.. _class_LineEdit_secret_character: +.. _class_LineEdit_property_secret_character: - :ref:`String` **secret_character** @@ -325,7 +349,7 @@ If ``true``, every character is replaced with the secret character (see :ref:`se The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character. -.. _class_LineEdit_text: +.. _class_LineEdit_property_text: - :ref:`String` **text** @@ -340,37 +364,37 @@ String value of the ``LineEdit``. Method Descriptions ------------------- -.. _class_LineEdit_append_at_cursor: +.. _class_LineEdit_method_append_at_cursor: - void **append_at_cursor** **(** :ref:`String` text **)** -Adds ``text`` after the cursor. If the resulting value is longer than :ref:`max_length`, nothing happens. +Adds ``text`` after the cursor. If the resulting value is longer than :ref:`max_length`, nothing happens. -.. _class_LineEdit_clear: +.. _class_LineEdit_method_clear: - void **clear** **(** **)** Erases the ``LineEdit`` text. -.. _class_LineEdit_deselect: +.. _class_LineEdit_method_deselect: - void **deselect** **(** **)** Clears the current selection. -.. _class_LineEdit_get_menu: +.. _class_LineEdit_method_get_menu: - :ref:`PopupMenu` **get_menu** **(** **)** const Returns the :ref:`PopupMenu` of this ``LineEdit``. By default, this menu is displayed when right-clicking on the ``LineEdit``. -.. _class_LineEdit_menu_option: +.. _class_LineEdit_method_menu_option: - void **menu_option** **(** :ref:`int` option **)** Executes a given action as defined in the MENU\_\* enum. -.. _class_LineEdit_select: +.. _class_LineEdit_method_select: - void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** @@ -383,7 +407,7 @@ Selects characters inside ``LineEdit`` between ``from`` and ``to``. By default ` select(4) # ome select(2, 5) # lco -.. _class_LineEdit_select_all: +.. _class_LineEdit_method_select_all: - void **select_all** **(** **)** diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 2d9e33459..f842d4d99 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -19,11 +19,11 @@ Line shape for 2D collisions. Properties ---------- -+-------------------------------+-----------------------------------------+ -| :ref:`float` | :ref:`d` | -+-------------------------------+-----------------------------------------+ -| :ref:`Vector2` | :ref:`normal` | -+-------------------------------+-----------------------------------------+ ++-------------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`d` | ++-------------------------------+--------------------------------------------------+ +| :ref:`Vector2` | :ref:`normal` | ++-------------------------------+--------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Line shape for 2D collisions. It works like a 2D plane and will not allow any bo Property Descriptions --------------------- -.. _class_LineShape2D_d: +.. _class_LineShape2D_property_d: - :ref:`float` **d** @@ -45,7 +45,7 @@ Property Descriptions The line's distance from the origin. -.. _class_LineShape2D_normal: +.. _class_LineShape2D_property_normal: - :ref:`Vector2` **normal** diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index fcee6bf75..8436d7c63 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -19,34 +19,40 @@ Simple button used to represent a link to some resource. Properties ---------- -+-----------------------------------------------------+----------------------------------------------+ -| :ref:`String` | :ref:`text` | -+-----------------------------------------------------+----------------------------------------------+ -| :ref:`UnderlineMode` | :ref:`underline` | -+-----------------------------------------------------+----------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------+ +| :ref:`String` | :ref:`text` | ++-----------------------------------------------------+-------------------------------------------------------+ +| :ref:`UnderlineMode` | :ref:`underline` | ++-----------------------------------------------------+-------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+----------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_pressed` | -+---------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`underline_spacing` | -+---------------------------------+----------------------------------------------------------------+ ++---------------------------------+--------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+--------------------+ +| :ref:`Font` | font | ++---------------------------------+--------------------+ +| :ref:`Color` | font_color | ++---------------------------------+--------------------+ +| :ref:`Color` | font_color_hover | ++---------------------------------+--------------------+ +| :ref:`Color` | font_color_pressed | ++---------------------------------+--------------------+ +| :ref:`int` | underline_spacing | ++---------------------------------+--------------------+ Enumerations ------------ .. _enum_LinkButton_UnderlineMode: +.. _class_LinkButton_constant_UNDERLINE_MODE_ALWAYS: + +.. _class_LinkButton_constant_UNDERLINE_MODE_ON_HOVER: + +.. _class_LinkButton_constant_UNDERLINE_MODE_NEVER: + enum **UnderlineMode**: - **UNDERLINE_MODE_ALWAYS** = **0** --- The LinkButton will always show an underline at the bottom of its text @@ -63,7 +69,7 @@ This kind of buttons are primarily used when the interaction with the button cau Property Descriptions --------------------- -.. _class_LinkButton_text: +.. _class_LinkButton_property_text: - :ref:`String` **text** @@ -73,7 +79,7 @@ Property Descriptions | *Getter* | get_text() | +----------+-----------------+ -.. _class_LinkButton_underline: +.. _class_LinkButton_property_underline: - :ref:`UnderlineMode` **underline** diff --git a/classes/class_listener.rst b/classes/class_listener.rst index 4b822d89a..a40c6da75 100644 --- a/classes/class_listener.rst +++ b/classes/class_listener.rst @@ -19,32 +19,32 @@ Brief Description Methods ------- -+------------------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`clear_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 ------------------- -.. _class_Listener_clear_current: +.. _class_Listener_method_clear_current: - void **clear_current** **(** **)** -.. _class_Listener_get_listener_transform: +.. _class_Listener_method_get_listener_transform: - :ref:`Transform` **get_listener_transform** **(** **)** const -.. _class_Listener_is_current: +.. _class_Listener_method_is_current: - :ref:`bool` **is_current** **(** **)** const -.. _class_Listener_make_current: +.. _class_Listener_method_make_current: - void **make_current** **(** **)** diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 91b65e3b0..53a04aff3 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -21,37 +21,61 @@ Main loop is the abstract main loop base class. Methods ------- -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_drop_files` **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_finalize` **(** **)** virtual | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :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 | -+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :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` screen **)** virtual | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_finalize` **(** **)** virtual | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :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 | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :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 **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_MainLoop_constant_NOTIFICATION_WM_MOUSE_ENTER: + +.. _class_MainLoop_constant_NOTIFICATION_WM_MOUSE_EXIT: + +.. _class_MainLoop_constant_NOTIFICATION_WM_FOCUS_IN: + +.. _class_MainLoop_constant_NOTIFICATION_WM_FOCUS_OUT: + +.. _class_MainLoop_constant_NOTIFICATION_WM_QUIT_REQUEST: + +.. _class_MainLoop_constant_NOTIFICATION_WM_GO_BACK_REQUEST: + +.. _class_MainLoop_constant_NOTIFICATION_WM_UNFOCUS_REQUEST: + +.. _class_MainLoop_constant_NOTIFICATION_OS_MEMORY_WARNING: + +.. _class_MainLoop_constant_NOTIFICATION_TRANSLATION_CHANGED: + +.. _class_MainLoop_constant_NOTIFICATION_WM_ABOUT: + +.. _class_MainLoop_constant_NOTIFICATION_CRASH: + +.. _class_MainLoop_constant_NOTIFICATION_OS_IME_UPDATE: + - **NOTIFICATION_WM_MOUSE_ENTER** = **2** - **NOTIFICATION_WM_MOUSE_EXIT** = **3** @@ -84,61 +108,61 @@ Main loop is the abstract main loop base class. All other main loop classes are Method Descriptions ------------------- -.. _class_MainLoop__drop_files: +.. _class_MainLoop_method__drop_files: - void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual -.. _class_MainLoop__finalize: +.. _class_MainLoop_method__finalize: - void **_finalize** **(** **)** virtual Called before the program exits. -.. _class_MainLoop__idle: +.. _class_MainLoop_method__idle: - void **_idle** **(** :ref:`float` delta **)** virtual Called each idle frame with time since last call as an only argument. -.. _class_MainLoop__initialize: +.. _class_MainLoop_method__initialize: - void **_initialize** **(** **)** virtual Called once during initialization. -.. _class_MainLoop__input_event: +.. _class_MainLoop_method__input_event: - void **_input_event** **(** :ref:`InputEvent` event **)** virtual -.. _class_MainLoop__input_text: +.. _class_MainLoop_method__input_text: - void **_input_text** **(** :ref:`String` text **)** virtual -.. _class_MainLoop__iteration: +.. _class_MainLoop_method__iteration: - void **_iteration** **(** :ref:`float` delta **)** virtual -.. _class_MainLoop_finish: +.. _class_MainLoop_method_finish: - void **finish** **(** **)** -.. _class_MainLoop_idle: +.. _class_MainLoop_method_idle: - :ref:`bool` **idle** **(** :ref:`float` delta **)** -.. _class_MainLoop_init: +.. _class_MainLoop_method_init: - void **init** **(** **)** -.. _class_MainLoop_input_event: +.. _class_MainLoop_method_input_event: - void **input_event** **(** :ref:`InputEvent` event **)** -.. _class_MainLoop_input_text: +.. _class_MainLoop_method_input_text: - void **input_text** **(** :ref:`String` text **)** -.. _class_MainLoop_iteration: +.. _class_MainLoop_method_iteration: - :ref:`bool` **iteration** **(** :ref:`float` delta **)** diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 46f18d3c6..c9ce6ddc3 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -19,15 +19,15 @@ Simple margin container. Theme Properties ---------------- -+-----------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`margin_bottom` | -+-----------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`margin_left` | -+-----------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`margin_right` | -+-----------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`margin_top` | -+-----------------------+-----------------------------------------------------------+ ++-----------------------+---------------+ +| :ref:`int` | margin_bottom | ++-----------------------+---------------+ +| :ref:`int` | margin_left | ++-----------------------+---------------+ +| :ref:`int` | margin_right | ++-----------------------+---------------+ +| :ref:`int` | margin_top | ++-----------------------+---------------+ Description ----------- diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 65b657db1..8f5ea3acf 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -19,19 +19,19 @@ Data transformation (marshalling) and encoding helpers. Methods ------- -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -41,37 +41,37 @@ Provides data transformation and encoding utility functions. Method Descriptions ------------------- -.. _class_Marshalls_base64_to_raw: +.. _class_Marshalls_method_base64_to_raw: - :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** Return :ref:`PoolByteArray` of a given base64 encoded String. -.. _class_Marshalls_base64_to_utf8: +.. _class_Marshalls_method_base64_to_utf8: - :ref:`String` **base64_to_utf8** **(** :ref:`String` base64_str **)** Return utf8 String of a given base64 encoded String. -.. _class_Marshalls_base64_to_variant: +.. _class_Marshalls_method_base64_to_variant: - :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str **)** Return :ref:`Variant` of a given base64 encoded String. -.. _class_Marshalls_raw_to_base64: +.. _class_Marshalls_method_raw_to_base64: - :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** Return base64 encoded String of a given :ref:`PoolByteArray`. -.. _class_Marshalls_utf8_to_base64: +.. _class_Marshalls_method_utf8_to_base64: - :ref:`String` **utf8_to_base64** **(** :ref:`String` utf8_str **)** Return base64 encoded String of a given utf8 String. -.. _class_Marshalls_variant_to_base64: +.. _class_Marshalls_method_variant_to_base64: - :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant **)** diff --git a/classes/class_material.rst b/classes/class_material.rst index b239c93d9..67fee2219 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -21,15 +21,19 @@ Abstract base :ref:`Resource` for coloring and shading geometry. Properties ---------- -+---------------------------------+--------------------------------------------------------+ -| :ref:`Material` | :ref:`next_pass` | -+---------------------------------+--------------------------------------------------------+ -| :ref:`int` | :ref:`render_priority` | -+---------------------------------+--------------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------------+ +| :ref:`Material` | :ref:`next_pass` | ++---------------------------------+-----------------------------------------------------------------+ +| :ref:`int` | :ref:`render_priority` | ++---------------------------------+-----------------------------------------------------------------+ Constants --------- +.. _class_Material_constant_RENDER_PRIORITY_MAX: + +.. _class_Material_constant_RENDER_PRIORITY_MIN: + - **RENDER_PRIORITY_MAX** = **127** - **RENDER_PRIORITY_MIN** = **-128** @@ -42,7 +46,7 @@ Material is a base :ref:`Resource` used for coloring and shading Property Descriptions --------------------- -.. _class_Material_next_pass: +.. _class_Material_property_next_pass: - :ref:`Material` **next_pass** @@ -52,7 +56,7 @@ Property Descriptions | *Getter* | get_next_pass() | +----------+----------------------+ -.. _class_Material_render_priority: +.. _class_Material_property_render_priority: - :ref:`int` **render_priority** diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index f040fb273..2ccdb44fc 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -19,50 +19,50 @@ Special button that brings up a :ref:`PopupMenu` when clicked. Properties ---------- -+-------------------------+----------------------------------------------------------+ -| :ref:`bool` | :ref:`switch_on_hover` | -+-------------------------+----------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------+ +| :ref:`bool` | :ref:`switch_on_hover` | ++-------------------------+-------------------------------------------------------------------+ Methods ------- -+------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_shortcuts` **(** :ref:`bool` disabled **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_shortcuts` **(** :ref:`bool` disabled **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`disabled` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_pressed` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`pressed` | -+---------------------------------+------------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`StyleBox` | disabled | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+---------------------+ +| :ref:`Font` | font | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_hover | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_pressed | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | hover | ++---------------------------------+---------------------+ +| :ref:`int` | hseparation | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | pressed | ++---------------------------------+---------------------+ Signals ------- -.. _class_MenuButton_about_to_show: +.. _class_MenuButton_signal_about_to_show: - **about_to_show** **(** **)** @@ -76,7 +76,7 @@ Special button that brings up a :ref:`PopupMenu` when clicked. Property Descriptions --------------------- -.. _class_MenuButton_switch_on_hover: +.. _class_MenuButton_property_switch_on_hover: - :ref:`bool` **switch_on_hover** @@ -91,13 +91,13 @@ If ``true``, when the cursor hovers above another MenuButton within the same par Method Descriptions ------------------- -.. _class_MenuButton_get_popup: +.. _class_MenuButton_method_get_popup: - :ref:`PopupMenu` **get_popup** **(** **)** const Return the :ref:`PopupMenu` contained in this button. -.. _class_MenuButton_set_disable_shortcuts: +.. _class_MenuButton_method_set_disable_shortcuts: - void **set_disable_shortcuts** **(** :ref:`bool` disabled **)** diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 4def16cae..30670bcbb 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -21,38 +21,52 @@ A :ref:`Resource` that contains vertex-array based geometry. Properties ---------- -+-------------------------------+----------------------------------------------------------+ -| :ref:`Vector2` | :ref:`lightmap_size_hint` | -+-------------------------------+----------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`lightmap_size_hint` | ++-------------------------------+-------------------------------------------------------------------+ Methods ------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** 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:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** 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:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Mesh_PrimitiveType: +.. _class_Mesh_constant_PRIMITIVE_POINTS: + +.. _class_Mesh_constant_PRIMITIVE_LINES: + +.. _class_Mesh_constant_PRIMITIVE_LINE_STRIP: + +.. _class_Mesh_constant_PRIMITIVE_LINE_LOOP: + +.. _class_Mesh_constant_PRIMITIVE_TRIANGLES: + +.. _class_Mesh_constant_PRIMITIVE_TRIANGLE_STRIP: + +.. _class_Mesh_constant_PRIMITIVE_TRIANGLE_FAN: + enum **PrimitiveType**: - **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point). @@ -71,6 +85,10 @@ enum **PrimitiveType**: .. _enum_Mesh_BlendShapeMode: +.. _class_Mesh_constant_BLEND_SHAPE_MODE_NORMALIZED: + +.. _class_Mesh_constant_BLEND_SHAPE_MODE_RELATIVE: + enum **BlendShapeMode**: - **BLEND_SHAPE_MODE_NORMALIZED** = **0** @@ -79,6 +97,50 @@ enum **BlendShapeMode**: .. _enum_Mesh_ArrayFormat: +.. _class_Mesh_constant_ARRAY_FORMAT_VERTEX: + +.. _class_Mesh_constant_ARRAY_FORMAT_NORMAL: + +.. _class_Mesh_constant_ARRAY_FORMAT_TANGENT: + +.. _class_Mesh_constant_ARRAY_FORMAT_COLOR: + +.. _class_Mesh_constant_ARRAY_FORMAT_TEX_UV: + +.. _class_Mesh_constant_ARRAY_FORMAT_TEX_UV2: + +.. _class_Mesh_constant_ARRAY_FORMAT_BONES: + +.. _class_Mesh_constant_ARRAY_FORMAT_WEIGHTS: + +.. _class_Mesh_constant_ARRAY_FORMAT_INDEX: + +.. _class_Mesh_constant_ARRAY_COMPRESS_BASE: + +.. _class_Mesh_constant_ARRAY_COMPRESS_VERTEX: + +.. _class_Mesh_constant_ARRAY_COMPRESS_NORMAL: + +.. _class_Mesh_constant_ARRAY_COMPRESS_TANGENT: + +.. _class_Mesh_constant_ARRAY_COMPRESS_COLOR: + +.. _class_Mesh_constant_ARRAY_COMPRESS_TEX_UV: + +.. _class_Mesh_constant_ARRAY_COMPRESS_TEX_UV2: + +.. _class_Mesh_constant_ARRAY_COMPRESS_BONES: + +.. _class_Mesh_constant_ARRAY_COMPRESS_WEIGHTS: + +.. _class_Mesh_constant_ARRAY_COMPRESS_INDEX: + +.. _class_Mesh_constant_ARRAY_FLAG_USE_2D_VERTICES: + +.. _class_Mesh_constant_ARRAY_FLAG_USE_16_BIT_BONES: + +.. _class_Mesh_constant_ARRAY_COMPRESS_DEFAULT: + enum **ArrayFormat**: - **ARRAY_FORMAT_VERTEX** = **1** @@ -127,6 +189,26 @@ enum **ArrayFormat**: .. _enum_Mesh_ArrayType: +.. _class_Mesh_constant_ARRAY_VERTEX: + +.. _class_Mesh_constant_ARRAY_NORMAL: + +.. _class_Mesh_constant_ARRAY_TANGENT: + +.. _class_Mesh_constant_ARRAY_COLOR: + +.. _class_Mesh_constant_ARRAY_TEX_UV: + +.. _class_Mesh_constant_ARRAY_TEX_UV2: + +.. _class_Mesh_constant_ARRAY_BONES: + +.. _class_Mesh_constant_ARRAY_WEIGHTS: + +.. _class_Mesh_constant_ARRAY_INDEX: + +.. _class_Mesh_constant_ARRAY_MAX: + enum **ArrayType**: - **ARRAY_VERTEX** = **0** --- Array of vertices. @@ -157,7 +239,7 @@ Mesh is a type of :ref:`Resource` that contains vertex-array bas Property Descriptions --------------------- -.. _class_Mesh_lightmap_size_hint: +.. _class_Mesh_property_lightmap_size_hint: - :ref:`Vector2` **lightmap_size_hint** @@ -170,55 +252,55 @@ Property Descriptions Method Descriptions ------------------- -.. _class_Mesh_create_convex_shape: +.. _class_Mesh_method_create_convex_shape: - :ref:`Shape` **create_convex_shape** **(** **)** const Calculate a :ref:`ConvexPolygonShape` from the mesh. -.. _class_Mesh_create_outline: +.. _class_Mesh_method_create_outline: - :ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** const Calculate an outline mesh at a defined offset (margin) from the original mesh. Note: Typically returns the vertices in reverse order (e.g. clockwise to anti-clockwise). -.. _class_Mesh_create_trimesh_shape: +.. _class_Mesh_method_create_trimesh_shape: - :ref:`Shape` **create_trimesh_shape** **(** **)** const Calculate a :ref:`ConcavePolygonShape` from the mesh. -.. _class_Mesh_generate_triangle_mesh: +.. _class_Mesh_method_generate_triangle_mesh: - :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const Generate a :ref:`TriangleMesh` from the mesh. -.. _class_Mesh_get_faces: +.. _class_Mesh_method_get_faces: - :ref:`PoolVector3Array` **get_faces** **(** **)** const Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. -.. _class_Mesh_get_surface_count: +.. _class_Mesh_method_get_surface_count: - :ref:`int` **get_surface_count** **(** **)** const Return the amount of surfaces that the ``Mesh`` holds. -.. _class_Mesh_surface_get_arrays: +.. _class_Mesh_method_surface_get_arrays: - :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`). +Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see :ref:`ArrayMesh.add_surface_from_arrays`). -.. _class_Mesh_surface_get_blend_shape_arrays: +.. _class_Mesh_method_surface_get_blend_shape_arrays: - :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** const Returns the blend shape arrays for the requested surface. -.. _class_Mesh_surface_get_material: +.. _class_Mesh_method_surface_get_material: - :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index ea9018cac..17651c8b1 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -19,90 +19,90 @@ Helper tool to access and edit :ref:`Mesh` data. Methods ------- -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edge_count` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :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_face_count` **(** **)** 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:`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_format` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex` **(** :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:`int` | :ref:`get_vertex_count` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :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:`Vector3` | :ref:`get_vertex_normal` **(** :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_uv2` **(** :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 **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edge_count` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :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_face_count` **(** **)** 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:`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_format` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_vertex` **(** :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:`int` | :ref:`get_vertex_count` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :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:`Vector3` | :ref:`get_vertex_normal` **(** :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_uv2` **(** :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 **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- The MeshDataTool provides access to individual vertices in a :ref:`Mesh`. It allows users to read and edit vertex data of meshes. It also creates an array of faces and edges. -To use the MeshDataTool, load a mesh with :ref:`create_from_surface`. When you are finished editing the data commit the data to a mesh with :ref:`commit_to_surface`. +To use the MeshDataTool, load a mesh with :ref:`create_from_surface`. When you are finished editing the data commit the data to a mesh with :ref:`commit_to_surface`. Below is an example of how the MeshDataTool may be used. @@ -120,19 +120,19 @@ Below is an example of how the MeshDataTool may be used. Method Descriptions ------------------- -.. _class_MeshDataTool_clear: +.. _class_MeshDataTool_method_clear: - void **clear** **(** **)** Clears all data currently in MeshDataTool. -.. _class_MeshDataTool_commit_to_surface: +.. _class_MeshDataTool_method_commit_to_surface: - :ref:`Error` **commit_to_surface** **(** :ref:`ArrayMesh` mesh **)** Adds a new surface to specified :ref:`Mesh` with edited data. -.. _class_MeshDataTool_create_from_surface: +.. _class_MeshDataTool_method_create_from_surface: - :ref:`Error` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** @@ -140,25 +140,25 @@ Uses specified surface of given :ref:`Mesh` to populate data for Mes Requires :ref:`Mesh` with primitive type ``PRIMITIVE_TRIANGLES``. -.. _class_MeshDataTool_get_edge_count: +.. _class_MeshDataTool_method_get_edge_count: - :ref:`int` **get_edge_count** **(** **)** const Returns the number of edges in this :ref:`Mesh`. -.. _class_MeshDataTool_get_edge_faces: +.. _class_MeshDataTool_method_get_edge_faces: - :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const Returns array of faces that touch given edge. -.. _class_MeshDataTool_get_edge_meta: +.. _class_MeshDataTool_method_get_edge_meta: - :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const Returns meta information assigned to given edge. -.. _class_MeshDataTool_get_edge_vertex: +.. _class_MeshDataTool_method_get_edge_vertex: - :ref:`int` **get_edge_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const @@ -166,13 +166,13 @@ Returns index of specified vertex connected to given edge. Vertex argument can only be 0 or 1 because edges are comprised of two vertices. -.. _class_MeshDataTool_get_face_count: +.. _class_MeshDataTool_method_get_face_count: - :ref:`int` **get_face_count** **(** **)** const Returns the number of faces in this :ref:`Mesh`. -.. _class_MeshDataTool_get_face_edge: +.. _class_MeshDataTool_method_get_face_edge: - :ref:`int` **get_face_edge** **(** :ref:`int` idx, :ref:`int` edge **)** const @@ -180,19 +180,19 @@ Returns specified edge associated with given face. Edge argument must 2 or less because a face only has three edges. -.. _class_MeshDataTool_get_face_meta: +.. _class_MeshDataTool_method_get_face_meta: - :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const Returns meta data associated with given face. -.. _class_MeshDataTool_get_face_normal: +.. _class_MeshDataTool_method_get_face_normal: - :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** const Calculates and returns face normal of given face. -.. _class_MeshDataTool_get_face_vertex: +.. _class_MeshDataTool_method_get_face_vertex: - :ref:`int` **get_face_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const @@ -200,7 +200,7 @@ Returns specified vertex of given face. Vertex argument must be 2 or less because faces contain three vertices. -.. _class_MeshDataTool_get_format: +.. _class_MeshDataTool_method_get_format: - :ref:`int` **get_format** **(** **)** const @@ -208,151 +208,151 @@ Returns format of :ref:`Mesh`. Format is an integer made up of :ref: For list of format flags see :ref:`ArrayMesh`. -.. _class_MeshDataTool_get_material: +.. _class_MeshDataTool_method_get_material: - :ref:`Material` **get_material** **(** **)** const Returns material assigned to the :ref:`Mesh`. -.. _class_MeshDataTool_get_vertex: +.. _class_MeshDataTool_method_get_vertex: - :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** const Returns the vertex at given index. -.. _class_MeshDataTool_get_vertex_bones: +.. _class_MeshDataTool_method_get_vertex_bones: - :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const Returns the bones of the given vertex. -.. _class_MeshDataTool_get_vertex_color: +.. _class_MeshDataTool_method_get_vertex_color: - :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** const Returns the color of the given vertex. -.. _class_MeshDataTool_get_vertex_count: +.. _class_MeshDataTool_method_get_vertex_count: - :ref:`int` **get_vertex_count** **(** **)** const Returns the total number of vertices in :ref:`Mesh`. -.. _class_MeshDataTool_get_vertex_edges: +.. _class_MeshDataTool_method_get_vertex_edges: - :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const Returns array of edges that share given vertex. -.. _class_MeshDataTool_get_vertex_faces: +.. _class_MeshDataTool_method_get_vertex_faces: - :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const Returns array of faces that share given vertex. -.. _class_MeshDataTool_get_vertex_meta: +.. _class_MeshDataTool_method_get_vertex_meta: - :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const Returns meta data associated with given vertex. -.. _class_MeshDataTool_get_vertex_normal: +.. _class_MeshDataTool_method_get_vertex_normal: - :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** const Returns normal of given vertex. -.. _class_MeshDataTool_get_vertex_tangent: +.. _class_MeshDataTool_method_get_vertex_tangent: - :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** const Returns tangent of given vertex. -.. _class_MeshDataTool_get_vertex_uv: +.. _class_MeshDataTool_method_get_vertex_uv: - :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** const Returns UV of given vertex. -.. _class_MeshDataTool_get_vertex_uv2: +.. _class_MeshDataTool_method_get_vertex_uv2: - :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** const Returns UV2 of given vertex. -.. _class_MeshDataTool_get_vertex_weights: +.. _class_MeshDataTool_method_get_vertex_weights: - :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const Returns bone weights of given vertex. -.. _class_MeshDataTool_set_edge_meta: +.. _class_MeshDataTool_method_set_edge_meta: - void **set_edge_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** Sets the meta data of given edge. -.. _class_MeshDataTool_set_face_meta: +.. _class_MeshDataTool_method_set_face_meta: - void **set_face_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** Sets the meta data of given face. -.. _class_MeshDataTool_set_material: +.. _class_MeshDataTool_method_set_material: - void **set_material** **(** :ref:`Material` material **)** Sets the material to be used by newly constructed :ref:`Mesh`. -.. _class_MeshDataTool_set_vertex: +.. _class_MeshDataTool_method_set_vertex: - void **set_vertex** **(** :ref:`int` idx, :ref:`Vector3` vertex **)** Sets the position of given vertex. -.. _class_MeshDataTool_set_vertex_bones: +.. _class_MeshDataTool_method_set_vertex_bones: - void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** Sets the bones of given vertex. -.. _class_MeshDataTool_set_vertex_color: +.. _class_MeshDataTool_method_set_vertex_color: - void **set_vertex_color** **(** :ref:`int` idx, :ref:`Color` color **)** Sets the color of given vertex. -.. _class_MeshDataTool_set_vertex_meta: +.. _class_MeshDataTool_method_set_vertex_meta: - void **set_vertex_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** Sets the meta data associated with given vertex. -.. _class_MeshDataTool_set_vertex_normal: +.. _class_MeshDataTool_method_set_vertex_normal: - void **set_vertex_normal** **(** :ref:`int` idx, :ref:`Vector3` normal **)** Sets the normal of given vertex. -.. _class_MeshDataTool_set_vertex_tangent: +.. _class_MeshDataTool_method_set_vertex_tangent: - void **set_vertex_tangent** **(** :ref:`int` idx, :ref:`Plane` tangent **)** Sets the tangent of given vertex. -.. _class_MeshDataTool_set_vertex_uv: +.. _class_MeshDataTool_method_set_vertex_uv: - void **set_vertex_uv** **(** :ref:`int` idx, :ref:`Vector2` uv **)** Sets the UV of given vertex. -.. _class_MeshDataTool_set_vertex_uv2: +.. _class_MeshDataTool_method_set_vertex_uv2: - void **set_vertex_uv2** **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** Sets the UV2 of given vertex. -.. _class_MeshDataTool_set_vertex_weights: +.. _class_MeshDataTool_method_set_vertex_weights: - void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 19a5ef907..2ea2a3faf 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -21,28 +21,28 @@ Node that instances meshes into a scenario. Properties ---------- -+---------------------------------+----------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+---------------------------------+----------------------------------------------+ -| :ref:`NodePath` | :ref:`skeleton` | -+---------------------------------+----------------------------------------------+ ++---------------------------------+-------------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++---------------------------------+-------------------------------------------------------+ +| :ref:`NodePath` | :ref:`skeleton` | ++---------------------------------+-------------------------------------------------------+ Methods ------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_convex_collision` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_debug_tangents` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_trimesh_collision` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_material_count` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_convex_collision` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_debug_tangents` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_trimesh_collision` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** const | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_material_count` **(** **)** const | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -52,7 +52,7 @@ MeshInstance is a node that takes a :ref:`Mesh` resource and adds it Property Descriptions --------------------- -.. _class_MeshInstance_mesh: +.. _class_MeshInstance_property_mesh: - :ref:`Mesh` **mesh** @@ -64,7 +64,7 @@ Property Descriptions The :ref:`Mesh` resource for the instance. -.. _class_MeshInstance_skeleton: +.. _class_MeshInstance_property_skeleton: - :ref:`NodePath` **skeleton** @@ -79,35 +79,35 @@ The :ref:`Mesh` resource for the instance. Method Descriptions ------------------- -.. _class_MeshInstance_create_convex_collision: +.. _class_MeshInstance_method_create_convex_collision: - void **create_convex_collision** **(** **)** This helper creates a :ref:`StaticBody` child node with a :ref:`ConvexPolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. -.. _class_MeshInstance_create_debug_tangents: +.. _class_MeshInstance_method_create_debug_tangents: - void **create_debug_tangents** **(** **)** This helper creates a :ref:`MeshInstance` child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. -.. _class_MeshInstance_create_trimesh_collision: +.. _class_MeshInstance_method_create_trimesh_collision: - void **create_trimesh_collision** **(** **)** This helper creates a :ref:`StaticBody` child node with a :ref:`ConcavePolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. -.. _class_MeshInstance_get_surface_material: +.. _class_MeshInstance_method_get_surface_material: - :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. -.. _class_MeshInstance_get_surface_material_count: +.. _class_MeshInstance_method_get_surface_material_count: - :ref:`int` **get_surface_material_count** **(** **)** const -.. _class_MeshInstance_set_surface_material: +.. _class_MeshInstance_method_set_surface_material: - void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 9732d14db..0d117be79 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -19,18 +19,18 @@ Brief Description Properties ---------- -+-------------------------------+----------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+-------------------------------+----------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+-------------------------------+----------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-------------------------------+----------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++-------------------------------+-------------------------------------------------------------+ +| :ref:`Texture` | :ref:`normal_map` | ++-------------------------------+-------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++-------------------------------+-------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_MeshInstance2D_mesh: +.. _class_MeshInstance2D_property_mesh: - :ref:`Mesh` **mesh** @@ -40,7 +40,7 @@ Property Descriptions | *Getter* | get_mesh() | +----------+-----------------+ -.. _class_MeshInstance2D_normal_map: +.. _class_MeshInstance2D_property_normal_map: - :ref:`Texture` **normal_map** @@ -50,7 +50,7 @@ Property Descriptions | *Getter* | get_normal_map() | +----------+-----------------------+ -.. _class_MeshInstance2D_texture: +.. _class_MeshInstance2D_property_texture: - :ref:`Texture` **texture** diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 1b9781c64..754a2caed 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -19,39 +19,39 @@ Library of meshes. Methods ------- -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_item` **(** :ref:`int` id **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_item_mesh` **(** :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:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` id **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_item` **(** :ref:`int` id **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_item_mesh` **(** :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:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` id **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -61,85 +61,85 @@ Library of meshes. Contains a list of :ref:`Mesh` resources, each wi Method Descriptions ------------------- -.. _class_MeshLibrary_clear: +.. _class_MeshLibrary_method_clear: - void **clear** **(** **)** Clear the library. -.. _class_MeshLibrary_create_item: +.. _class_MeshLibrary_method_create_item: - void **create_item** **(** :ref:`int` id **)** Create a new item in the library, supplied an id. -.. _class_MeshLibrary_find_item_by_name: +.. _class_MeshLibrary_method_find_item_by_name: - :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** const -.. _class_MeshLibrary_get_item_list: +.. _class_MeshLibrary_method_get_item_list: - :ref:`PoolIntArray` **get_item_list** **(** **)** const Return the list of items. -.. _class_MeshLibrary_get_item_mesh: +.. _class_MeshLibrary_method_get_item_mesh: - :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** const Return the mesh of the item. -.. _class_MeshLibrary_get_item_name: +.. _class_MeshLibrary_method_get_item_name: - :ref:`String` **get_item_name** **(** :ref:`int` id **)** const Return the name of the item. -.. _class_MeshLibrary_get_item_navmesh: +.. _class_MeshLibrary_method_get_item_navmesh: - :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const -.. _class_MeshLibrary_get_item_preview: +.. _class_MeshLibrary_method_get_item_preview: - :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const -.. _class_MeshLibrary_get_item_shapes: +.. _class_MeshLibrary_method_get_item_shapes: - :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const -.. _class_MeshLibrary_get_last_unused_item_id: +.. _class_MeshLibrary_method_get_last_unused_item_id: - :ref:`int` **get_last_unused_item_id** **(** **)** const Get an unused id for a new item. -.. _class_MeshLibrary_remove_item: +.. _class_MeshLibrary_method_remove_item: - void **remove_item** **(** :ref:`int` id **)** Remove the item. -.. _class_MeshLibrary_set_item_mesh: +.. _class_MeshLibrary_method_set_item_mesh: - void **set_item_mesh** **(** :ref:`int` id, :ref:`Mesh` mesh **)** Set the mesh of the item. -.. _class_MeshLibrary_set_item_name: +.. _class_MeshLibrary_method_set_item_name: - void **set_item_name** **(** :ref:`int` id, :ref:`String` name **)** Set the name of the item. -.. _class_MeshLibrary_set_item_navmesh: +.. _class_MeshLibrary_method_set_item_navmesh: - void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** -.. _class_MeshLibrary_set_item_preview: +.. _class_MeshLibrary_method_set_item_preview: - void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** -.. _class_MeshLibrary_set_item_shapes: +.. _class_MeshLibrary_method_set_item_shapes: - void **set_item_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index f366c364d..45e39cde3 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -19,19 +19,19 @@ Generic mobile VR implementation Properties ---------- -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`display_to_lens` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`display_width` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`iod` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`k1` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`k2` | -+---------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`oversample` | -+---------------------------+-----------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`display_to_lens` | ++---------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`display_width` | ++---------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`iod` | ++---------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`k1` | ++---------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`k2` | ++---------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`oversample` | ++---------------------------+--------------------------------------------------------------------------+ Description ----------- @@ -43,7 +43,7 @@ Note that even though there is no positional tracking the camera will assume the Property Descriptions --------------------- -.. _class_MobileVRInterface_display_to_lens: +.. _class_MobileVRInterface_property_display_to_lens: - :ref:`float` **display_to_lens** @@ -55,7 +55,7 @@ Property Descriptions The distance between the display and the lenses inside of the device in centimeters. -.. _class_MobileVRInterface_display_width: +.. _class_MobileVRInterface_property_display_width: - :ref:`float` **display_width** @@ -67,7 +67,7 @@ The distance between the display and the lenses inside of the device in centimet The width of the display in centimeters. -.. _class_MobileVRInterface_iod: +.. _class_MobileVRInterface_property_iod: - :ref:`float` **iod** @@ -79,7 +79,7 @@ The width of the display in centimeters. The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. -.. _class_MobileVRInterface_k1: +.. _class_MobileVRInterface_property_k1: - :ref:`float` **k1** @@ -91,7 +91,7 @@ The interocular distance, also known as the interpupillary distance. The distanc The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect. -.. _class_MobileVRInterface_k2: +.. _class_MobileVRInterface_property_k2: - :ref:`float` **k2** @@ -103,7 +103,7 @@ The k1 lens factor is one of the two constants that define the strength of the l The k2 lens factor, see k1. -.. _class_MobileVRInterface_oversample: +.. _class_MobileVRInterface_property_oversample: - :ref:`float` **oversample** diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 20b798caa..7337718ee 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -19,42 +19,46 @@ Provides high performance mesh instancing. Properties ---------- -+----------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`ColorFormat` | :ref:`color_format` | -+----------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`CustomDataFormat` | :ref:`custom_data_format` | -+----------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`instance_count` | -+----------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+----------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`TransformFormat` | :ref:`transform_format` | -+----------------------------------------------------------+---------------------------------------------------------------+ ++----------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`ColorFormat` | :ref:`color_format` | ++----------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`CustomDataFormat` | :ref:`custom_data_format` | ++----------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`instance_count` | ++----------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++----------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`TransformFormat` | :ref:`transform_format` | ++----------------------------------------------------------+------------------------------------------------------------------------+ Methods ------- -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_instance_color` **(** :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 | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_custom_data` **(** :ref:`int` instance, :ref:`Color` custom_data **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_transform` **(** :ref:`int` instance, :ref:`Transform` transform **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_instance_color` **(** :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 | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_custom_data` **(** :ref:`int` instance, :ref:`Color` custom_data **)** | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_transform` **(** :ref:`int` instance, :ref:`Transform` transform **)** | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_MultiMesh_TransformFormat: +.. _class_MultiMesh_constant_TRANSFORM_2D: + +.. _class_MultiMesh_constant_TRANSFORM_3D: + enum **TransformFormat**: - **TRANSFORM_2D** = **0** @@ -63,6 +67,12 @@ enum **TransformFormat**: .. _enum_MultiMesh_ColorFormat: +.. _class_MultiMesh_constant_COLOR_NONE: + +.. _class_MultiMesh_constant_COLOR_8BIT: + +.. _class_MultiMesh_constant_COLOR_FLOAT: + enum **ColorFormat**: - **COLOR_NONE** = **0** @@ -73,6 +83,12 @@ enum **ColorFormat**: .. _enum_MultiMesh_CustomDataFormat: +.. _class_MultiMesh_constant_CUSTOM_DATA_NONE: + +.. _class_MultiMesh_constant_CUSTOM_DATA_8BIT: + +.. _class_MultiMesh_constant_CUSTOM_DATA_FLOAT: + enum **CustomDataFormat**: - **CUSTOM_DATA_NONE** = **0** @@ -95,7 +111,7 @@ Since instances may have any behavior, the AABB used for visibility must be prov Property Descriptions --------------------- -.. _class_MultiMesh_color_format: +.. _class_MultiMesh_property_color_format: - :ref:`ColorFormat` **color_format** @@ -105,7 +121,7 @@ Property Descriptions | *Getter* | get_color_format() | +----------+-------------------------+ -.. _class_MultiMesh_custom_data_format: +.. _class_MultiMesh_property_custom_data_format: - :ref:`CustomDataFormat` **custom_data_format** @@ -115,7 +131,7 @@ Property Descriptions | *Getter* | get_custom_data_format() | +----------+-------------------------------+ -.. _class_MultiMesh_instance_count: +.. _class_MultiMesh_property_instance_count: - :ref:`int` **instance_count** @@ -125,7 +141,7 @@ Property Descriptions | *Getter* | get_instance_count() | +----------+---------------------------+ -.. _class_MultiMesh_mesh: +.. _class_MultiMesh_property_mesh: - :ref:`Mesh` **mesh** @@ -135,7 +151,7 @@ Property Descriptions | *Getter* | get_mesh() | +----------+-----------------+ -.. _class_MultiMesh_transform_format: +.. _class_MultiMesh_property_transform_format: - :ref:`TransformFormat` **transform_format** @@ -148,39 +164,39 @@ Property Descriptions Method Descriptions ------------------- -.. _class_MultiMesh_get_aabb: +.. _class_MultiMesh_method_get_aabb: - :ref:`AABB` **get_aabb** **(** **)** const Return the visibility AABB. -.. _class_MultiMesh_get_instance_color: +.. _class_MultiMesh_method_get_instance_color: - :ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** const Get the color of a specific instance. -.. _class_MultiMesh_get_instance_custom_data: +.. _class_MultiMesh_method_get_instance_custom_data: - :ref:`Color` **get_instance_custom_data** **(** :ref:`int` instance **)** const -.. _class_MultiMesh_get_instance_transform: +.. _class_MultiMesh_method_get_instance_transform: - :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const Return the transform of a specific instance. -.. _class_MultiMesh_set_instance_color: +.. _class_MultiMesh_method_set_instance_color: - void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** Set the color of a specific instance. -.. _class_MultiMesh_set_instance_custom_data: +.. _class_MultiMesh_method_set_instance_custom_data: - void **set_instance_custom_data** **(** :ref:`int` instance, :ref:`Color` custom_data **)** -.. _class_MultiMesh_set_instance_transform: +.. _class_MultiMesh_method_set_instance_transform: - void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform` transform **)** diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index 325cc4f31..6e5609a82 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -19,9 +19,9 @@ Node that instances a :ref:`MultiMesh`. Properties ---------- -+-----------------------------------+-----------------------------------------------------+ -| :ref:`MultiMesh` | :ref:`multimesh` | -+-----------------------------------+-----------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------+ +| :ref:`MultiMesh` | :ref:`multimesh` | ++-----------------------------------+--------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ This is useful to optimize the rendering of a high amount of instances of a give Property Descriptions --------------------- -.. _class_MultiMeshInstance_multimesh: +.. _class_MultiMeshInstance_property_multimesh: - :ref:`MultiMesh` **multimesh** diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index eb7e4583b..c94abc613 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -19,88 +19,106 @@ High Level Multiplayer API. Properties ---------- -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`refuse_new_network_connections` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`refuse_new_network_connections` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ Methods ------- -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_server` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`poll` **(** **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`send_bytes` **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_root_node` **(** :ref:`Node` node **)** | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_server` **(** **)** const | ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`poll` **(** **)** | ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`send_bytes` **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** | ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_root_node` **(** :ref:`Node` node **)** | ++-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_MultiplayerAPI_connected_to_server: +.. _class_MultiplayerAPI_signal_connected_to_server: - **connected_to_server** **(** **)** -Emitted whenever this MultiplayerAPI's :ref:`network_peer` successfully connected to a server. Only emitted on clients. +Emitted whenever this MultiplayerAPI's :ref:`network_peer` successfully connected to a server. Only emitted on clients. -.. _class_MultiplayerAPI_connection_failed: +.. _class_MultiplayerAPI_signal_connection_failed: - **connection_failed** **(** **)** -Emitted whenever this MultiplayerAPI's :ref:`network_peer` fails to establish a connection to a server. Only emitted on clients. +Emitted whenever this MultiplayerAPI's :ref:`network_peer` fails to establish a connection to a server. Only emitted on clients. -.. _class_MultiplayerAPI_network_peer_connected: +.. _class_MultiplayerAPI_signal_network_peer_connected: - **network_peer_connected** **(** :ref:`int` id **)** -Emitted whenever this MultiplayerAPI's :ref:`network_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). +Emitted whenever this MultiplayerAPI's :ref:`network_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). -.. _class_MultiplayerAPI_network_peer_disconnected: +.. _class_MultiplayerAPI_signal_network_peer_disconnected: - **network_peer_disconnected** **(** :ref:`int` id **)** -Emitted whenever this MultiplayerAPI's :ref:`network_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. +Emitted whenever this MultiplayerAPI's :ref:`network_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. -.. _class_MultiplayerAPI_network_peer_packet: +.. _class_MultiplayerAPI_signal_network_peer_packet: - **network_peer_packet** **(** :ref:`int` id, :ref:`PoolByteArray` packet **)** -Emitted whenever this MultiplayerAPI's :ref:`network_peer` receive a ``packet`` with custom data (see :ref:`send_bytes`). ID is the peer ID of the peer that sent the packet. +Emitted whenever this MultiplayerAPI's :ref:`network_peer` receive a ``packet`` with custom data (see :ref:`send_bytes`). ID is the peer ID of the peer that sent the packet. -.. _class_MultiplayerAPI_server_disconnected: +.. _class_MultiplayerAPI_signal_server_disconnected: - **server_disconnected** **(** **)** -Emitted whenever this MultiplayerAPI's :ref:`network_peer` disconnects from server. Only emitted on clients. +Emitted whenever this MultiplayerAPI's :ref:`network_peer` disconnects from server. Only emitted on clients. Enumerations ------------ .. _enum_MultiplayerAPI_RPCMode: +.. _class_MultiplayerAPI_constant_RPC_MODE_DISABLED: + +.. _class_MultiplayerAPI_constant_RPC_MODE_REMOTE: + +.. _class_MultiplayerAPI_constant_RPC_MODE_MASTER: + +.. _class_MultiplayerAPI_constant_RPC_MODE_PUPPET: + +.. _class_MultiplayerAPI_constant_RPC_MODE_SLAVE: + +.. _class_MultiplayerAPI_constant_RPC_MODE_REMOTESYNC: + +.. _class_MultiplayerAPI_constant_RPC_MODE_SYNC: + +.. _class_MultiplayerAPI_constant_RPC_MODE_MASTERSYNC: + +.. _class_MultiplayerAPI_constant_RPC_MODE_PUPPETSYNC: + enum **RPCMode**: -- **RPC_MODE_DISABLED** = **0** --- Used with :ref:`Node.rpc_config` or :ref:`Node.rset_config` to disable a method or property for all RPC calls, making it unavailable. Default for all methods. +- **RPC_MODE_DISABLED** = **0** --- Used with :ref:`Node.rpc_config` or :ref:`Node.rset_config` to disable a method or property for all RPC calls, making it unavailable. Default for all methods. -- **RPC_MODE_REMOTE** = **1** --- Used with :ref:`Node.rpc_config` or :ref:`Node.rset_config` to set a method to be called or a property to be changed only on the remote end, not locally. Analogous to the ``remote`` keyword. Calls and property changes are accepted from all remote peers, no matter if they are node's master or puppets. +- **RPC_MODE_REMOTE** = **1** --- Used with :ref:`Node.rpc_config` or :ref:`Node.rset_config` to set a method to be called or a property to be changed only on the remote end, not locally. Analogous to the ``remote`` keyword. Calls and property changes are accepted from all remote peers, no matter if they are node's master or puppets. -- **RPC_MODE_MASTER** = **2** --- Used with :ref:`Node.rpc_config` or :ref:`Node.rset_config` to set a method to be called or a property to be changed only on the network master for this node. Analogous to the ``master`` keyword. Only accepts calls or property changes from the node's network puppets, see :ref:`Node.set_network_master`. +- **RPC_MODE_MASTER** = **2** --- Used with :ref:`Node.rpc_config` or :ref:`Node.rset_config` to set a method to be called or a property to be changed only on the network master for this node. Analogous to the ``master`` keyword. Only accepts calls or property changes from the node's network puppets, see :ref:`Node.set_network_master`. -- **RPC_MODE_PUPPET** = **3** --- Used with :ref:`Node.rpc_config` or :ref:`Node.rset_config` to set a method to be called or a property to be changed only on puppets for this node. Analogous to the ``puppet`` keyword. Only accepts calls or property changes from the node's network master, see :ref:`Node.set_network_master`. +- **RPC_MODE_PUPPET** = **3** --- Used with :ref:`Node.rpc_config` or :ref:`Node.rset_config` to set a method to be called or a property to be changed only on puppets for this node. Analogous to the ``puppet`` keyword. Only accepts calls or property changes from the node's network master, see :ref:`Node.set_network_master`. - **RPC_MODE_SLAVE** = **3** --- Deprecated. Use ``RPC_MODE_PUPPET`` instead. Analogous to the ``slave`` keyword. @@ -119,12 +137,12 @@ This class implements most of the logic behind the high level multiplayer API. By default, :ref:`SceneTree` has a reference to this class that is used to provide multiplayer capabilities (i.e. RPC/RSET) across the whole scene. -It is possible to override the MultiplayerAPI instance used by specific Nodes by setting the :ref:`Node.custom_multiplayer` property, effectively allowing to run both client and server in the same scene. +It is possible to override the MultiplayerAPI instance used by specific Nodes by setting the :ref:`Node.custom_multiplayer` property, effectively allowing to run both client and server in the same scene. Property Descriptions --------------------- -.. _class_MultiplayerAPI_network_peer: +.. _class_MultiplayerAPI_property_network_peer: - :ref:`NetworkedMultiplayerPeer` **network_peer** @@ -134,9 +152,9 @@ Property Descriptions | *Getter* | get_network_peer() | +----------+-------------------------+ -The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with :ref:`is_network_server`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. +The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with :ref:`is_network_server`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. -.. _class_MultiplayerAPI_refuse_new_network_connections: +.. _class_MultiplayerAPI_property_refuse_new_network_connections: - :ref:`bool` **refuse_new_network_connections** @@ -146,30 +164,30 @@ The peer object to handle the RPC system (effectively enabling networking when s | *Getter* | is_refusing_new_network_connections() | +----------+-------------------------------------------+ -If ``true``, the MultiplayerAPI's :ref:`network_peer` refuses new incoming connections. +If ``true``, the MultiplayerAPI's :ref:`network_peer` refuses new incoming connections. Method Descriptions ------------------- -.. _class_MultiplayerAPI_clear: +.. _class_MultiplayerAPI_method_clear: - void **clear** **(** **)** Clears the current MultiplayerAPI network state (you shouldn't call this unless you know what you are doing). -.. _class_MultiplayerAPI_get_network_connected_peers: +.. _class_MultiplayerAPI_method_get_network_connected_peers: - :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const -Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`network_peer`. +Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`network_peer`. -.. _class_MultiplayerAPI_get_network_unique_id: +.. _class_MultiplayerAPI_method_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const -Returns the unique peer ID of this MultiplayerAPI's :ref:`network_peer`. +Returns the unique peer ID of this MultiplayerAPI's :ref:`network_peer`. -.. _class_MultiplayerAPI_get_rpc_sender_id: +.. _class_MultiplayerAPI_method_get_rpc_sender_id: - :ref:`int` **get_rpc_sender_id** **(** **)** const @@ -177,33 +195,33 @@ Returns the sender's peer ID for the RPC currently being executed. NOTE: If not inside an RPC this method will return 0. -.. _class_MultiplayerAPI_has_network_peer: +.. _class_MultiplayerAPI_method_has_network_peer: - :ref:`bool` **has_network_peer** **(** **)** const -Returns ``true`` if there is a :ref:`network_peer` set. +Returns ``true`` if there is a :ref:`network_peer` set. -.. _class_MultiplayerAPI_is_network_server: +.. _class_MultiplayerAPI_method_is_network_server: - :ref:`bool` **is_network_server** **(** **)** const -Returns ``true`` if this MultiplayerAPI's :ref:`network_peer` is in server mode (listening for connections). +Returns ``true`` if this MultiplayerAPI's :ref:`network_peer` is in server mode (listening for connections). -.. _class_MultiplayerAPI_poll: +.. _class_MultiplayerAPI_method_poll: - void **poll** **(** **)** -Method used for polling the MultiplayerAPI. You only need to worry about this if you are using :ref:`Node.custom_multiplayer` override or you set :ref:`SceneTree.multiplayer_poll` to ``false``. By default :ref:`SceneTree` will poll its MultiplayerAPI for you. +Method used for polling the MultiplayerAPI. You only need to worry about this if you are using :ref:`Node.custom_multiplayer` override or you set :ref:`SceneTree.multiplayer_poll` to ``false``. By default :ref:`SceneTree` will poll its MultiplayerAPI for you. NOTE: This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. ``_process``, ``physics``, :ref:`Thread`). -.. _class_MultiplayerAPI_send_bytes: +.. _class_MultiplayerAPI_method_send_bytes: - :ref:`Error` **send_bytes** **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** -Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Default ID is ``0``, i.e. broadcast to all peers. +Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Default ID is ``0``, i.e. broadcast to all peers. -.. _class_MultiplayerAPI_set_root_node: +.. _class_MultiplayerAPI_method_set_root_node: - void **set_root_node** **(** :ref:`Node` node **)** diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index dee1b1bc7..7323872c8 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -19,13 +19,13 @@ A synchronization Mutex. Methods ------- -+----------------------------------------+---------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+----------------------------------------+---------------------------------------------------+ -| :ref:`Error` | :ref:`try_lock` **(** **)** | -+----------------------------------------+---------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+----------------------------------------+---------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++---------------------------------------+----------------------------------------------------------+ +| :ref:`Error` | :ref:`try_lock` **(** **)** | ++---------------------------------------+----------------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++---------------------------------------+----------------------------------------------------------+ Description ----------- @@ -35,19 +35,19 @@ A synchronization Mutex. Element used to synchronize multiple :ref:`Thread` **try_lock** **(** **)** Try locking this ``Mutex``, does not block. Returns ``OK`` on success, ``ERR_BUSY`` otherwise. -.. _class_Mutex_unlock: +.. _class_Mutex_method_unlock: - void **unlock** **(** **)** diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index aec3fc1f6..2fa72fd0d 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -19,35 +19,35 @@ Brief Description Properties ---------- -+-----------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`class_name` | -+-----------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`GDNativeLibrary` | :ref:`library` | -+-----------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`script_class_icon_path` | -+-----------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`script_class_name` | -+-----------------------------------------------+--------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`class_name` | ++-----------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`GDNativeLibrary` | :ref:`library` | ++-----------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`script_class_icon_path` | ++-----------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`script_class_name` | ++-----------------------------------------------+-----------------------------------------------------------------------------------+ 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:`Object` | :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:`Object` | :ref:`new` **(** **)** vararg | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_NativeScript_class_name: +.. _class_NativeScript_property_class_name: - :ref:`String` **class_name** @@ -57,7 +57,7 @@ Property Descriptions | *Getter* | get_class_name() | +----------+-----------------------+ -.. _class_NativeScript_library: +.. _class_NativeScript_property_library: - :ref:`GDNativeLibrary` **library** @@ -67,7 +67,7 @@ Property Descriptions | *Getter* | get_library() | +----------+--------------------+ -.. _class_NativeScript_script_class_icon_path: +.. _class_NativeScript_property_script_class_icon_path: - :ref:`String` **script_class_icon_path** @@ -77,7 +77,7 @@ Property Descriptions | *Getter* | get_script_class_icon_path() | +----------+-----------------------------------+ -.. _class_NativeScript_script_class_name: +.. _class_NativeScript_property_script_class_name: - :ref:`String` **script_class_name** @@ -90,31 +90,31 @@ Property Descriptions Method Descriptions ------------------- -.. _class_NativeScript_get_class_documentation: +.. _class_NativeScript_method_get_class_documentation: - :ref:`String` **get_class_documentation** **(** **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_class_documentation``. -.. _class_NativeScript_get_method_documentation: +.. _class_NativeScript_method_get_method_documentation: - :ref:`String` **get_method_documentation** **(** :ref:`String` method **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_method_documentation``. -.. _class_NativeScript_get_property_documentation: +.. _class_NativeScript_method_get_property_documentation: - :ref:`String` **get_property_documentation** **(** :ref:`String` path **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_property_documentation``. -.. _class_NativeScript_get_signal_documentation: +.. _class_NativeScript_method_get_signal_documentation: - :ref:`String` **get_signal_documentation** **(** :ref:`String` signal_name **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_signal_documentation``. -.. _class_NativeScript_new: +.. _class_NativeScript_method_new: - :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index f97cfaadf..2a20df77d 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -19,40 +19,40 @@ Mesh-based navigation and pathfinding node. Properties ---------- -+-------------------------------+----------------------------------------------+ -| :ref:`Vector3` | :ref:`up_vector` | -+-------------------------------+----------------------------------------------+ ++-------------------------------+-------------------------------------------------------+ +| :ref:`Vector3` | :ref:`up_vector` | ++-------------------------------+-------------------------------------------------------+ Methods ------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navmesh_add` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navmesh_add` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Provides navigation and pathfinding within a collection of :ref:`NavigationMesh`\ es. By default these will be automatically collected from child :ref:`NavigationMeshInstance` nodes, but they can also be added on the fly with :ref:`navmesh_add`. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. +Provides navigation and pathfinding within a collection of :ref:`NavigationMesh`\ es. By default these will be automatically collected from child :ref:`NavigationMeshInstance` nodes, but they can also be added on the fly with :ref:`navmesh_add`. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. Property Descriptions --------------------- -.. _class_Navigation_up_vector: +.. _class_Navigation_property_up_vector: - :ref:`Vector3` **up_vector** @@ -67,49 +67,49 @@ Defines which direction is up. By default this is ``(0, 1, 0)``, which is the wo Method Descriptions ------------------- -.. _class_Navigation_get_closest_point: +.. _class_Navigation_method_get_closest_point: - :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** Returns the navigation point closest to the point given. Points are in local coordinate space. -.. _class_Navigation_get_closest_point_normal: +.. _class_Navigation_method_get_closest_point_normal: - :ref:`Vector3` **get_closest_point_normal** **(** :ref:`Vector3` to_point **)** Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on. -.. _class_Navigation_get_closest_point_owner: +.. _class_Navigation_method_get_closest_point_owner: - :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector3` to_point **)** -Returns the owner of the :ref:`NavigationMesh` which contains the navigation point closest to the point given. This is usually a :ref:`NavigationMeshInstance`. For meshes added via :ref:`navmesh_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). +Returns the owner of the :ref:`NavigationMesh` which contains the navigation point closest to the point given. This is usually a :ref:`NavigationMeshInstance`. For meshes added via :ref:`navmesh_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). -.. _class_Navigation_get_closest_point_to_segment: +.. _class_Navigation_method_get_closest_point_to_segment: - :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** Returns the navigation point closest to the given line segment. When enabling ``use_collision``, only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned. -.. _class_Navigation_get_simple_path: +.. _class_Navigation_method_get_simple_path: - :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the agent properties associated with each :ref:`NavigationMesh` (raidus, height, etc.) are considered in the path calculation, otherwise they are ignored. -.. _class_Navigation_navmesh_add: +.. _class_Navigation_method_navmesh_add: - :ref:`int` **navmesh_add** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** -Adds a :ref:`NavigationMesh`. Returns an ID for use with :ref:`navmesh_remove` or :ref:`navmesh_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. +Adds a :ref:`NavigationMesh`. Returns an ID for use with :ref:`navmesh_remove` or :ref:`navmesh_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. -.. _class_Navigation_navmesh_remove: +.. _class_Navigation_method_navmesh_remove: - void **navmesh_remove** **(** :ref:`int` id **)** Removes the :ref:`NavigationMesh` with the given ID. -.. _class_Navigation_navmesh_set_transform: +.. _class_Navigation_method_navmesh_set_transform: - void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 8803ed5cb..9679edbee 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -19,59 +19,59 @@ Brief Description Methods ------- -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navpoly_add` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navpoly_remove` **(** :ref:`int` id **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navpoly_set_transform` **(** :ref:`int` id, :ref:`Transform2D` xform **)** | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navpoly_add` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navpoly_remove` **(** :ref:`int` id **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navpoly_set_transform` **(** :ref:`int` id, :ref:`Transform2D` xform **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of :ref:`NavigationPolygon` resources. By default these are automatically collected from child :ref:`NavigationPolygonInstance` nodes, but they can also be added on the fly with :ref:`navpoly_add`. +Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of :ref:`NavigationPolygon` resources. By default these are automatically collected from child :ref:`NavigationPolygonInstance` nodes, but they can also be added on the fly with :ref:`navpoly_add`. Method Descriptions ------------------- -.. _class_Navigation2D_get_closest_point: +.. _class_Navigation2D_method_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** Returns the navigation point closest to the point given. Points are in local coordinate space. -.. _class_Navigation2D_get_closest_point_owner: +.. _class_Navigation2D_method_get_closest_point_owner: - :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector2` to_point **)** -Returns the owner of the :ref:`NavigationPolygon` which contains the navigation point closest to the point given. This is usually a :ref:`NavigationPolygonInstance`. For polygons added via :ref:`navpoly_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). +Returns the owner of the :ref:`NavigationPolygon` which contains the navigation point closest to the point given. This is usually a :ref:`NavigationPolygonInstance`. For polygons added via :ref:`navpoly_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). -.. _class_Navigation2D_get_simple_path: +.. _class_Navigation2D_method_get_simple_path: - :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the path is smoothed by merging path segments where possible. -.. _class_Navigation2D_navpoly_add: +.. _class_Navigation2D_method_navpoly_add: - :ref:`int` **navpoly_add** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** -Adds a :ref:`NavigationPolygon`. Returns an ID for use with :ref:`navpoly_remove` or :ref:`navpoly_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. +Adds a :ref:`NavigationPolygon`. Returns an ID for use with :ref:`navpoly_remove` or :ref:`navpoly_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. -.. _class_Navigation2D_navpoly_remove: +.. _class_Navigation2D_method_navpoly_remove: - void **navpoly_remove** **(** :ref:`int` id **)** Removes the :ref:`NavigationPolygon` with the given ID. -.. _class_Navigation2D_navpoly_set_transform: +.. _class_Navigation2D_method_navpoly_set_transform: - void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index dfad99138..011adedca 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -19,64 +19,70 @@ Brief Description Properties ---------- -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`agent/height` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`agent/max_climb` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`agent/max_slope` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`agent/radius` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cell/height` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cell/size` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`detail/sample_distance` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`detail/sample_max_error` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`edge/max_error` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`edge/max_length` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`filter/filter_walkable_low_height_spans` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`filter/ledge_spans` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`filter/low_hanging_obstacles` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`polygon/verts_per_poly` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`region/merge_size` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`region/min_size` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`sample_partition_type/sample_partition_type` | -+---------------------------+----------------------------------------------------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`agent/height` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`agent/max_climb` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`agent/max_slope` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`agent/radius` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cell/height` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cell/size` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`detail/sample_distance` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`detail/sample_max_error` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`edge/max_error` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`edge/max_length` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`filter/filter_walkable_low_height_spans` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`filter/ledge_spans` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`filter/low_hanging_obstacles` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`polygon/verts_per_poly` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`region/merge_size` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`region/min_size` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`sample_partition_type/sample_partition_type` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------+ Methods ------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_NavigationMesh_constant_SAMPLE_PARTITION_WATERSHED: + +.. _class_NavigationMesh_constant_SAMPLE_PARTITION_MONOTONE: + +.. _class_NavigationMesh_constant_SAMPLE_PARTITION_LAYERS: + - **SAMPLE_PARTITION_WATERSHED** = **0** - **SAMPLE_PARTITION_MONOTONE** = **1** @@ -86,7 +92,7 @@ Constants Property Descriptions --------------------- -.. _class_NavigationMesh_agent/height: +.. _class_NavigationMesh_property_agent/height: - :ref:`float` **agent/height** @@ -96,7 +102,7 @@ Property Descriptions | *Getter* | get_agent_height() | +----------+-------------------------+ -.. _class_NavigationMesh_agent/max_climb: +.. _class_NavigationMesh_property_agent/max_climb: - :ref:`float` **agent/max_climb** @@ -106,7 +112,7 @@ Property Descriptions | *Getter* | get_agent_max_climb() | +----------+----------------------------+ -.. _class_NavigationMesh_agent/max_slope: +.. _class_NavigationMesh_property_agent/max_slope: - :ref:`float` **agent/max_slope** @@ -116,7 +122,7 @@ Property Descriptions | *Getter* | get_agent_max_slope() | +----------+----------------------------+ -.. _class_NavigationMesh_agent/radius: +.. _class_NavigationMesh_property_agent/radius: - :ref:`float` **agent/radius** @@ -126,7 +132,7 @@ Property Descriptions | *Getter* | get_agent_radius() | +----------+-------------------------+ -.. _class_NavigationMesh_cell/height: +.. _class_NavigationMesh_property_cell/height: - :ref:`float` **cell/height** @@ -136,7 +142,7 @@ Property Descriptions | *Getter* | get_cell_height() | +----------+------------------------+ -.. _class_NavigationMesh_cell/size: +.. _class_NavigationMesh_property_cell/size: - :ref:`float` **cell/size** @@ -146,7 +152,7 @@ Property Descriptions | *Getter* | get_cell_size() | +----------+----------------------+ -.. _class_NavigationMesh_detail/sample_distance: +.. _class_NavigationMesh_property_detail/sample_distance: - :ref:`float` **detail/sample_distance** @@ -156,7 +162,7 @@ Property Descriptions | *Getter* | get_detail_sample_distance() | +----------+-----------------------------------+ -.. _class_NavigationMesh_detail/sample_max_error: +.. _class_NavigationMesh_property_detail/sample_max_error: - :ref:`float` **detail/sample_max_error** @@ -166,7 +172,7 @@ Property Descriptions | *Getter* | get_detail_sample_max_error() | +----------+------------------------------------+ -.. _class_NavigationMesh_edge/max_error: +.. _class_NavigationMesh_property_edge/max_error: - :ref:`float` **edge/max_error** @@ -176,7 +182,7 @@ Property Descriptions | *Getter* | get_edge_max_error() | +----------+---------------------------+ -.. _class_NavigationMesh_edge/max_length: +.. _class_NavigationMesh_property_edge/max_length: - :ref:`float` **edge/max_length** @@ -186,7 +192,7 @@ Property Descriptions | *Getter* | get_edge_max_length() | +----------+----------------------------+ -.. _class_NavigationMesh_filter/filter_walkable_low_height_spans: +.. _class_NavigationMesh_property_filter/filter_walkable_low_height_spans: - :ref:`bool` **filter/filter_walkable_low_height_spans** @@ -196,7 +202,7 @@ Property Descriptions | *Getter* | get_filter_walkable_low_height_spans() | +----------+---------------------------------------------+ -.. _class_NavigationMesh_filter/ledge_spans: +.. _class_NavigationMesh_property_filter/ledge_spans: - :ref:`bool` **filter/ledge_spans** @@ -206,7 +212,7 @@ Property Descriptions | *Getter* | get_filter_ledge_spans() | +----------+-------------------------------+ -.. _class_NavigationMesh_filter/low_hanging_obstacles: +.. _class_NavigationMesh_property_filter/low_hanging_obstacles: - :ref:`bool` **filter/low_hanging_obstacles** @@ -216,7 +222,7 @@ Property Descriptions | *Getter* | get_filter_low_hanging_obstacles() | +----------+-----------------------------------------+ -.. _class_NavigationMesh_polygon/verts_per_poly: +.. _class_NavigationMesh_property_polygon/verts_per_poly: - :ref:`float` **polygon/verts_per_poly** @@ -226,7 +232,7 @@ Property Descriptions | *Getter* | get_verts_per_poly() | +----------+---------------------------+ -.. _class_NavigationMesh_region/merge_size: +.. _class_NavigationMesh_property_region/merge_size: - :ref:`float` **region/merge_size** @@ -236,7 +242,7 @@ Property Descriptions | *Getter* | get_region_merge_size() | +----------+------------------------------+ -.. _class_NavigationMesh_region/min_size: +.. _class_NavigationMesh_property_region/min_size: - :ref:`float` **region/min_size** @@ -246,7 +252,7 @@ Property Descriptions | *Getter* | get_region_min_size() | +----------+----------------------------+ -.. _class_NavigationMesh_sample_partition_type/sample_partition_type: +.. _class_NavigationMesh_property_sample_partition_type/sample_partition_type: - :ref:`int` **sample_partition_type/sample_partition_type** @@ -259,31 +265,31 @@ Property Descriptions Method Descriptions ------------------- -.. _class_NavigationMesh_add_polygon: +.. _class_NavigationMesh_method_add_polygon: - void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** -.. _class_NavigationMesh_clear_polygons: +.. _class_NavigationMesh_method_clear_polygons: - void **clear_polygons** **(** **)** -.. _class_NavigationMesh_create_from_mesh: +.. _class_NavigationMesh_method_create_from_mesh: - void **create_from_mesh** **(** :ref:`Mesh` mesh **)** -.. _class_NavigationMesh_get_polygon: +.. _class_NavigationMesh_method_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** -.. _class_NavigationMesh_get_polygon_count: +.. _class_NavigationMesh_method_get_polygon_count: - :ref:`int` **get_polygon_count** **(** **)** const -.. _class_NavigationMesh_get_vertices: +.. _class_NavigationMesh_method_get_vertices: - :ref:`PoolVector3Array` **get_vertices** **(** **)** const -.. _class_NavigationMesh_set_vertices: +.. _class_NavigationMesh_method_set_vertices: - void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index a77e7349d..128f8e41b 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -19,16 +19,16 @@ Brief Description Properties ---------- -+---------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+---------------------------------------------+------------------------------------------------------+ -| :ref:`NavigationMesh` | :ref:`navmesh` | -+---------------------------------------------+------------------------------------------------------+ ++---------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`enabled` | ++---------------------------------------------+---------------------------------------------------------------+ +| :ref:`NavigationMesh` | :ref:`navmesh` | ++---------------------------------------------+---------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_NavigationMeshInstance_enabled: +.. _class_NavigationMeshInstance_property_enabled: - :ref:`bool` **enabled** @@ -38,7 +38,7 @@ Property Descriptions | *Getter* | is_enabled() | +----------+--------------------+ -.. _class_NavigationMeshInstance_navmesh: +.. _class_NavigationMeshInstance_property_navmesh: - :ref:`NavigationMesh` **navmesh** diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 308e298c5..4d2b4f642 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -19,42 +19,42 @@ A node that has methods to draw outlines or use indices of vertices to create na Methods ------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline` **(** :ref:`PoolVector2Array` outline **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline_at_index` **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_outlines` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_outline_count` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_polygons_from_outlines` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_outline` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_outline` **(** :ref:`PoolVector2Array` outline **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_outline_at_index` **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_outlines` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_outline_count` **(** **)** const | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_polygons_from_outlines` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_outline` **(** :ref:`int` idx **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -There are two ways to create polygons. Either by using the :ref:`add_outline` method or using the :ref:`add_polygon` method. +There are two ways to create polygons. Either by using the :ref:`add_outline` method or using the :ref:`add_polygon` method. -Using :ref:`add_outline`: +Using :ref:`add_outline`: `` @@ -70,7 +70,7 @@ $NavigationPolygonInstance.navpoly = polygon `` -Using :ref:`add_polygon` and indices of the vertices array. +Using :ref:`add_polygon` and indices of the vertices array. `` @@ -91,87 +91,87 @@ $NavigationPolygonInstance.navpoly = polygon Method Descriptions ------------------- -.. _class_NavigationPolygon_add_outline: +.. _class_NavigationPolygon_method_add_outline: - void **add_outline** **(** :ref:`PoolVector2Array` outline **)** -Appends a :ref:`PoolVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. +Appends a :ref:`PoolVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. -.. _class_NavigationPolygon_add_outline_at_index: +.. _class_NavigationPolygon_method_add_outline_at_index: - void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** -Adds a :ref:`PoolVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. +Adds a :ref:`PoolVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. -.. _class_NavigationPolygon_add_polygon: +.. _class_NavigationPolygon_method_add_polygon: - void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** -Adds a polygon using the indices of the vertices you get when calling :ref:`get_vertices`. +Adds a polygon using the indices of the vertices you get when calling :ref:`get_vertices`. -.. _class_NavigationPolygon_clear_outlines: +.. _class_NavigationPolygon_method_clear_outlines: - void **clear_outlines** **(** **)** Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them. -.. _class_NavigationPolygon_clear_polygons: +.. _class_NavigationPolygon_method_clear_polygons: - void **clear_polygons** **(** **)** Clears the array of polygons, but it doesn't clear the array of outlines and vertices. -.. _class_NavigationPolygon_get_outline: +.. _class_NavigationPolygon_method_get_outline: - :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. -.. _class_NavigationPolygon_get_outline_count: +.. _class_NavigationPolygon_method_get_outline_count: - :ref:`int` **get_outline_count** **(** **)** const Returns the number of outlines that were created in the editor or by script. -.. _class_NavigationPolygon_get_polygon: +.. _class_NavigationPolygon_method_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** Returns a :ref:`PoolIntArray` containing the indices of the vertices of a created polygon. -.. _class_NavigationPolygon_get_polygon_count: +.. _class_NavigationPolygon_method_get_polygon_count: - :ref:`int` **get_polygon_count** **(** **)** const Returns the count of all polygons. -.. _class_NavigationPolygon_get_vertices: +.. _class_NavigationPolygon_method_get_vertices: - :ref:`PoolVector2Array` **get_vertices** **(** **)** const Returns a :ref:`PoolVector2Array` containing all the vertices being used to create the polygons. -.. _class_NavigationPolygon_make_polygons_from_outlines: +.. _class_NavigationPolygon_method_make_polygons_from_outlines: - void **make_polygons_from_outlines** **(** **)** Creates polygons from the outlines added in the editor or by script. -.. _class_NavigationPolygon_remove_outline: +.. _class_NavigationPolygon_method_remove_outline: - void **remove_outline** **(** :ref:`int` idx **)** -Removes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. +Removes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. -.. _class_NavigationPolygon_set_outline: +.. _class_NavigationPolygon_method_set_outline: - void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** -Changes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. +Changes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. -.. _class_NavigationPolygon_set_vertices: +.. _class_NavigationPolygon_method_set_vertices: - void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** -Sets the vertices that can be then indexed to create polygons with the :ref:`add_polygon` method. +Sets the vertices that can be then indexed to create polygons with the :ref:`add_polygon` method. diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index 85122bd61..e48e03cb5 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -19,16 +19,16 @@ Brief Description Properties ---------- -+---------------------------------------------------+---------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+---------------------------------------------------+---------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`navpoly` | -+---------------------------------------------------+---------------------------------------------------------+ ++---------------------------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`enabled` | ++---------------------------------------------------+------------------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`navpoly` | ++---------------------------------------------------+------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_NavigationPolygonInstance_enabled: +.. _class_NavigationPolygonInstance_property_enabled: - :ref:`bool` **enabled** @@ -38,7 +38,7 @@ Property Descriptions | *Getter* | is_enabled() | +----------+--------------------+ -.. _class_NavigationPolygonInstance_navpoly: +.. _class_NavigationPolygonInstance_property_navpoly: - :ref:`NavigationPolygon` **navpoly** diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index cc50a0e05..4cb1d93c0 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -19,44 +19,54 @@ PacketPeer implementation using the ENet library. Properties ---------- -+-----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`always_ordered` | -+-----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`channel_count` | -+-----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`CompressionMode` | :ref:`compression_mode` | -+-----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transfer_channel` | -+-----------------------------------------------------------------------+--------------------------------------------------------------------------+ ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`always_ordered` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`channel_count` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`CompressionMode` | :ref:`compression_mode` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transfer_channel` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ Methods ------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close_connection` **(** :ref:`int` wait_usec=100 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_client` **(** :ref:`String` address, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` client_port=0 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_peer` **(** :ref:`int` id, :ref:`bool` now=false **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_packet_channel` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_channel` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close_connection` **(** :ref:`int` wait_usec=100 **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`create_client` **(** :ref:`String` address, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` client_port=0 **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_peer` **(** :ref:`int` id, :ref:`bool` now=false **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_packet_channel` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_channel` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_NetworkedMultiplayerENet_CompressionMode: +.. _class_NetworkedMultiplayerENet_constant_COMPRESS_NONE: + +.. _class_NetworkedMultiplayerENet_constant_COMPRESS_RANGE_CODER: + +.. _class_NetworkedMultiplayerENet_constant_COMPRESS_FASTLZ: + +.. _class_NetworkedMultiplayerENet_constant_COMPRESS_ZLIB: + +.. _class_NetworkedMultiplayerENet_constant_COMPRESS_ZSTD: + enum **CompressionMode**: - **COMPRESS_NONE** = **0** --- No compression. @@ -72,7 +82,7 @@ enum **CompressionMode**: Description ----------- -A PacketPeer implementation that should be passed to :ref:`SceneTree.set_network_peer` after being initialized as either a client or server. Events can then be handled by connecting to :ref:`SceneTree` signals. +A PacketPeer implementation that should be passed to :ref:`SceneTree.set_network_peer` after being initialized as either a client or server. Events can then be handled by connecting to :ref:`SceneTree` signals. Tutorials --------- @@ -84,7 +94,7 @@ Tutorials Property Descriptions --------------------- -.. _class_NetworkedMultiplayerENet_always_ordered: +.. _class_NetworkedMultiplayerENet_property_always_ordered: - :ref:`bool` **always_ordered** @@ -96,7 +106,7 @@ Property Descriptions Always use ``TRANSFER_MODE_ORDERED`` in place of ``TRANSFER_MODE_UNRELIABLE``. This is the only way to use ordering with the RPC system. -.. _class_NetworkedMultiplayerENet_channel_count: +.. _class_NetworkedMultiplayerENet_property_channel_count: - :ref:`int` **channel_count** @@ -108,7 +118,7 @@ Always use ``TRANSFER_MODE_ORDERED`` in place of ``TRANSFER_MODE_UNRELIABLE``. T The number of channels to be used by ENet. Default: ``3``. Channels are used to separate different kinds of data. In realiable or ordered mode, for example, the packet delivery order is ensured on a per channel basis. -.. _class_NetworkedMultiplayerENet_compression_mode: +.. _class_NetworkedMultiplayerENet_property_compression_mode: - :ref:`CompressionMode` **compression_mode** @@ -120,7 +130,7 @@ The number of channels to be used by ENet. Default: ``3``. Channels are used to The compression method used for network packets. Default is no compression. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. -.. _class_NetworkedMultiplayerENet_transfer_channel: +.. _class_NetworkedMultiplayerENet_property_transfer_channel: - :ref:`int` **transfer_channel** @@ -130,60 +140,60 @@ The compression method used for network packets. Default is no compression. Thes | *Getter* | get_transfer_channel() | +----------+-----------------------------+ -Set the default channel to be used to transfer data. By default this value is ``-1`` which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel ``0`` is reserved, and cannot be used. Setting this member to any value between ``0`` and :ref:`channel_count` (excluded) will force ENet to use that channel for sending data. +Set the default channel to be used to transfer data. By default this value is ``-1`` which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel ``0`` is reserved, and cannot be used. Setting this member to any value between ``0`` and :ref:`channel_count` (excluded) will force ENet to use that channel for sending data. Method Descriptions ------------------- -.. _class_NetworkedMultiplayerENet_close_connection: +.. _class_NetworkedMultiplayerENet_method_close_connection: - void **close_connection** **(** :ref:`int` wait_usec=100 **)** Closes the connection. Ignored if no connection is currently established. If this is a server it tries to notify all clients before forcibly disconnecting them. If this is a client it simply closes the connection to the server. -.. _class_NetworkedMultiplayerENet_create_client: +.. _class_NetworkedMultiplayerENet_method_create_client: - :ref:`Error` **create_client** **(** :ref:`String` address, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` client_port=0 **)** -Create client that connects to a server at ``address`` using specified ``port``. The given address needs to be either a fully qualified domain nome (e.g. ``www.example.com``) or an IP address in IPv4 or IPv6 format (e.g. ``192.168.1.1``). The ``port`` is the port the server is listening on. The ``in_bandwidth`` and ``out_bandwidth`` parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns ``OK`` if a client was created, ``ERR_ALREADY_IN_USE`` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection` first) or ``ERR_CANT_CREATE`` if the client could not be created. If ``client_port`` is specified, the client will also listen to the given port, this is useful in some NAT traversal technique. +Create client that connects to a server at ``address`` using specified ``port``. The given address needs to be either a fully qualified domain nome (e.g. ``www.example.com``) or an IP address in IPv4 or IPv6 format (e.g. ``192.168.1.1``). The ``port`` is the port the server is listening on. The ``in_bandwidth`` and ``out_bandwidth`` parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns ``OK`` if a client was created, ``ERR_ALREADY_IN_USE`` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection` first) or ``ERR_CANT_CREATE`` if the client could not be created. If ``client_port`` is specified, the client will also listen to the given port, this is useful in some NAT traversal technique. -.. _class_NetworkedMultiplayerENet_create_server: +.. _class_NetworkedMultiplayerENet_method_create_server: - :ref:`Error` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** -Create server that listens to connections via ``port``. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use :ref:`set_bind_ip`. The default IP is the wildcard ``*``, which listens on all available interfaces. ``max_clients`` is the maximum number of clients that are allowed at once, any number up to 4096 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see :ref:`create_client`. Returns ``OK`` if a server was created, ``ERR_ALREADY_IN_USE`` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection` first) or ``ERR_CANT_CREATE`` if the server could not be created. +Create server that listens to connections via ``port``. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use :ref:`set_bind_ip`. The default IP is the wildcard ``*``, which listens on all available interfaces. ``max_clients`` is the maximum number of clients that are allowed at once, any number up to 4096 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see :ref:`create_client`. Returns ``OK`` if a server was created, ``ERR_ALREADY_IN_USE`` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection` first) or ``ERR_CANT_CREATE`` if the server could not be created. -.. _class_NetworkedMultiplayerENet_disconnect_peer: +.. _class_NetworkedMultiplayerENet_method_disconnect_peer: - void **disconnect_peer** **(** :ref:`int` id, :ref:`bool` now=false **)** Disconnect the given peer. If "now" is set to true, the connection will be closed immediately without flushing queued messages. -.. _class_NetworkedMultiplayerENet_get_last_packet_channel: +.. _class_NetworkedMultiplayerENet_method_get_last_packet_channel: - :ref:`int` **get_last_packet_channel** **(** **)** const -Returns the channel of the last packet fetched via :ref:`PacketPeer.get_packet` +Returns the channel of the last packet fetched via :ref:`PacketPeer.get_packet` -.. _class_NetworkedMultiplayerENet_get_packet_channel: +.. _class_NetworkedMultiplayerENet_method_get_packet_channel: - :ref:`int` **get_packet_channel** **(** **)** const -Returns the channel of the next packet that will be retrieved via :ref:`PacketPeer.get_packet` +Returns the channel of the next packet that will be retrieved via :ref:`PacketPeer.get_packet` -.. _class_NetworkedMultiplayerENet_get_peer_address: +.. _class_NetworkedMultiplayerENet_method_get_peer_address: - :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const Returns the IP address of the given peer. -.. _class_NetworkedMultiplayerENet_get_peer_port: +.. _class_NetworkedMultiplayerENet_method_get_peer_port: - :ref:`int` **get_peer_port** **(** :ref:`int` id **)** const Returns the remote port of the given peer. -.. _class_NetworkedMultiplayerENet_set_bind_ip: +.. _class_NetworkedMultiplayerENet_method_set_bind_ip: - void **set_bind_ip** **(** :ref:`String` ip **)** diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 25fbacca1..05da454a9 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -21,55 +21,55 @@ A high-level network interface to simplify multiplayer interactions. Properties ---------- -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`refuse_new_connections` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`TransferMode` | :ref:`transfer_mode` | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`refuse_new_connections` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`TransferMode` | :ref:`transfer_mode` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ Methods ------- -+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`ConnectionStatus` | :ref:`get_connection_status` **(** **)** const | -+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_peer` **(** **)** const | -+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unique_id` **(** **)** const | -+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`poll` **(** **)** | -+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target_peer` **(** :ref:`int` id **)** | -+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`ConnectionStatus` | :ref:`get_connection_status` **(** **)** const | ++-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_peer` **(** **)** const | ++-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unique_id` **(** **)** const | ++-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`poll` **(** **)** | ++-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target_peer` **(** :ref:`int` id **)** | ++-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_NetworkedMultiplayerPeer_connection_failed: +.. _class_NetworkedMultiplayerPeer_signal_connection_failed: - **connection_failed** **(** **)** Emitted when a connection attempt fails. -.. _class_NetworkedMultiplayerPeer_connection_succeeded: +.. _class_NetworkedMultiplayerPeer_signal_connection_succeeded: - **connection_succeeded** **(** **)** Emitted when a connection attempt succeeds. -.. _class_NetworkedMultiplayerPeer_peer_connected: +.. _class_NetworkedMultiplayerPeer_signal_peer_connected: - **peer_connected** **(** :ref:`int` id **)** Emitted by the server when a client connects. -.. _class_NetworkedMultiplayerPeer_peer_disconnected: +.. _class_NetworkedMultiplayerPeer_signal_peer_disconnected: - **peer_disconnected** **(** :ref:`int` id **)** Emitted by the server when a client disconnects. -.. _class_NetworkedMultiplayerPeer_server_disconnected: +.. _class_NetworkedMultiplayerPeer_signal_server_disconnected: - **server_disconnected** **(** **)** @@ -80,6 +80,12 @@ Enumerations .. _enum_NetworkedMultiplayerPeer_TransferMode: +.. _class_NetworkedMultiplayerPeer_constant_TRANSFER_MODE_UNRELIABLE: + +.. _class_NetworkedMultiplayerPeer_constant_TRANSFER_MODE_UNRELIABLE_ORDERED: + +.. _class_NetworkedMultiplayerPeer_constant_TRANSFER_MODE_RELIABLE: + enum **TransferMode**: - **TRANSFER_MODE_UNRELIABLE** = **0** --- Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than ``TRANSFER_MODE_UNRELIABLE_ORDERED``. Use for non-critical data, and always consider whether the order matters. @@ -90,6 +96,12 @@ enum **TransferMode**: .. _enum_NetworkedMultiplayerPeer_ConnectionStatus: +.. _class_NetworkedMultiplayerPeer_constant_CONNECTION_DISCONNECTED: + +.. _class_NetworkedMultiplayerPeer_constant_CONNECTION_CONNECTING: + +.. _class_NetworkedMultiplayerPeer_constant_CONNECTION_CONNECTED: + enum **ConnectionStatus**: - **CONNECTION_DISCONNECTED** = **0** --- The ongoing connection disconnected. @@ -101,6 +113,10 @@ enum **ConnectionStatus**: Constants --------- +.. _class_NetworkedMultiplayerPeer_constant_TARGET_PEER_BROADCAST: + +.. _class_NetworkedMultiplayerPeer_constant_TARGET_PEER_SERVER: + - **TARGET_PEER_BROADCAST** = **0** --- Packets are sent to the server and then redistributed to other peers. - **TARGET_PEER_SERVER** = **1** --- Packets are sent to the server alone. @@ -118,7 +134,7 @@ Tutorials Property Descriptions --------------------- -.. _class_NetworkedMultiplayerPeer_refuse_new_connections: +.. _class_NetworkedMultiplayerPeer_property_refuse_new_connections: - :ref:`bool` **refuse_new_connections** @@ -130,7 +146,7 @@ Property Descriptions If ``true``, this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. -.. _class_NetworkedMultiplayerPeer_transfer_mode: +.. _class_NetworkedMultiplayerPeer_property_transfer_mode: - :ref:`TransferMode` **transfer_mode** @@ -140,36 +156,36 @@ If ``true``, this ``NetworkedMultiplayerPeer`` refuses new connections. Default | *Getter* | get_transfer_mode() | +----------+--------------------------+ -The manner in which to send packets to the ``target_peer``. See :ref:`TransferMode`. +The manner in which to send packets to the ``target_peer``. See :ref:`TransferMode`. Method Descriptions ------------------- -.. _class_NetworkedMultiplayerPeer_get_connection_status: +.. _class_NetworkedMultiplayerPeer_method_get_connection_status: - :ref:`ConnectionStatus` **get_connection_status** **(** **)** const -Returns the current state of the connection. See :ref:`ConnectionStatus`. +Returns the current state of the connection. See :ref:`ConnectionStatus`. -.. _class_NetworkedMultiplayerPeer_get_packet_peer: +.. _class_NetworkedMultiplayerPeer_method_get_packet_peer: - :ref:`int` **get_packet_peer** **(** **)** const Returns the ID of the ``NetworkedMultiplayerPeer`` who sent the most recent packet. -.. _class_NetworkedMultiplayerPeer_get_unique_id: +.. _class_NetworkedMultiplayerPeer_method_get_unique_id: - :ref:`int` **get_unique_id** **(** **)** const Returns the ID of this ``NetworkedMultiplayerPeer``. -.. _class_NetworkedMultiplayerPeer_poll: +.. _class_NetworkedMultiplayerPeer_method_poll: - void **poll** **(** **)** Waits up to 1 second to receive a new network event. -.. _class_NetworkedMultiplayerPeer_set_target_peer: +.. _class_NetworkedMultiplayerPeer_method_set_target_peer: - void **set_target_peer** **(** :ref:`int` id **)** diff --git a/classes/class_nil.rst b/classes/class_nil.rst index 9ee55d775..dbd006d76 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -17,164 +17,114 @@ Brief Description Methods ------- -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolColorArray` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolVector3Array` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolVector2Array` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolStringArray` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolRealArray` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolIntArray` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolByteArray` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Array` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Object` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`RID` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`NodePath` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Color` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Transform` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Basis` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`AABB` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Quat` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Plane` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Transform2D` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector3` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Rect2` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector2` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`String` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`float` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`int` from **)** | -+-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`bool` from **)** | -+-------+--------------------------------------------------------------------------------------------+ ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolColorArray` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolVector3Array` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolVector2Array` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolStringArray` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolRealArray` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolIntArray` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`PoolByteArray` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Array` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Object` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`RID` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`NodePath` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Color` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Transform` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Basis` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`AABB` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Quat` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Plane` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Transform2D` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Vector3` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Rect2` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`Vector2` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`String` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`float` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`int` from **)** | ++------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`Nil` **(** :ref:`bool` from **)** | ++------+---------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_Nil_Nil: +.. _class_Nil_method_Nil: - void **Nil** **(** :ref:`PoolColorArray` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`PoolVector3Array` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`PoolVector2Array` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`PoolStringArray` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`PoolRealArray` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`PoolIntArray` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`PoolByteArray` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Array` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Dictionary` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Object` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`RID` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`NodePath` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Color` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Transform` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Basis` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`AABB` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Quat` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Plane` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Transform2D` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Vector3` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Rect2` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Vector2` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`String` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`float` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`int` from **)** -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`bool` from **)** diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index a576b5688..88ccefa0a 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -19,30 +19,30 @@ Scalable texture-based frame that tiles the texture's centers and sides, but kee Properties ---------- -+------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`AxisStretchMode` | :ref:`axis_stretch_horizontal` | -+------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`AxisStretchMode` | :ref:`axis_stretch_vertical` | -+------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_center` | -+------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`patch_margin_bottom` | -+------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`patch_margin_left` | -+------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`patch_margin_right` | -+------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`patch_margin_top` | -+------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | -+------------------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+------------------------------------------------------------+-----------------------------------------------------------------------------+ ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`AxisStretchMode` | :ref:`axis_stretch_horizontal` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`AxisStretchMode` | :ref:`axis_stretch_vertical` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`draw_center` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`patch_margin_bottom` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`patch_margin_left` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`patch_margin_right` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`patch_margin_top` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`region_rect` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------+ Signals ------- -.. _class_NinePatchRect_texture_changed: +.. _class_NinePatchRect_signal_texture_changed: - **texture_changed** **(** **)** @@ -53,6 +53,12 @@ Enumerations .. _enum_NinePatchRect_AxisStretchMode: +.. _class_NinePatchRect_constant_AXIS_STRETCH_MODE_STRETCH: + +.. _class_NinePatchRect_constant_AXIS_STRETCH_MODE_TILE: + +.. _class_NinePatchRect_constant_AXIS_STRETCH_MODE_TILE_FIT: + enum **AxisStretchMode**: - **AXIS_STRETCH_MODE_STRETCH** = **0** --- Doesn't do anything at the time of writing. Default value for ``axis_stretch_horizontal`` and ``axis_stretch_vertical``. @@ -69,7 +75,7 @@ Better known as 9-slice panels, NinePatchRect produces clean panels of any size, Property Descriptions --------------------- -.. _class_NinePatchRect_axis_stretch_horizontal: +.. _class_NinePatchRect_property_axis_stretch_horizontal: - :ref:`AxisStretchMode` **axis_stretch_horizontal** @@ -81,7 +87,7 @@ Property Descriptions Doesn't do anything at the time of writing. -.. _class_NinePatchRect_axis_stretch_vertical: +.. _class_NinePatchRect_property_axis_stretch_vertical: - :ref:`AxisStretchMode` **axis_stretch_vertical** @@ -93,7 +99,7 @@ Doesn't do anything at the time of writing. Doesn't do anything at the time of writing. -.. _class_NinePatchRect_draw_center: +.. _class_NinePatchRect_property_draw_center: - :ref:`bool` **draw_center** @@ -105,7 +111,7 @@ Doesn't do anything at the time of writing. If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Default value: ``true`` -.. _class_NinePatchRect_patch_margin_bottom: +.. _class_NinePatchRect_property_patch_margin_bottom: - :ref:`int` **patch_margin_bottom** @@ -117,7 +123,7 @@ If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Def The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. -.. _class_NinePatchRect_patch_margin_left: +.. _class_NinePatchRect_property_patch_margin_left: - :ref:`int` **patch_margin_left** @@ -129,7 +135,7 @@ The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's botto The height of the 9-slice's left column. -.. _class_NinePatchRect_patch_margin_right: +.. _class_NinePatchRect_property_patch_margin_right: - :ref:`int` **patch_margin_right** @@ -141,7 +147,7 @@ The height of the 9-slice's left column. The height of the 9-slice's right column. -.. _class_NinePatchRect_patch_margin_top: +.. _class_NinePatchRect_property_patch_margin_top: - :ref:`int` **patch_margin_top** @@ -153,7 +159,7 @@ The height of the 9-slice's right column. The height of the 9-slice's top row. -.. _class_NinePatchRect_region_rect: +.. _class_NinePatchRect_property_region_rect: - :ref:`Rect2` **region_rect** @@ -165,7 +171,7 @@ The height of the 9-slice's top row. Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. -.. _class_NinePatchRect_texture: +.. _class_NinePatchRect_property_texture: - :ref:`Texture` **texture** diff --git a/classes/class_node.rst b/classes/class_node.rst index 1fc86c095..841da12cd 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -21,217 +21,217 @@ Base class for all *scene* objects. Properties ---------- -+---------------------------------------------+----------------------------------------------------------+ -| :ref:`MultiplayerAPI` | :ref:`custom_multiplayer` | -+---------------------------------------------+----------------------------------------------------------+ -| :ref:`String` | :ref:`filename` | -+---------------------------------------------+----------------------------------------------------------+ -| :ref:`MultiplayerAPI` | :ref:`multiplayer` | -+---------------------------------------------+----------------------------------------------------------+ -| :ref:`String` | :ref:`name` | -+---------------------------------------------+----------------------------------------------------------+ -| :ref:`Node` | :ref:`owner` | -+---------------------------------------------+----------------------------------------------------------+ -| :ref:`PauseMode` | :ref:`pause_mode` | -+---------------------------------------------+----------------------------------------------------------+ ++---------------------------------------------+-------------------------------------------------------------------+ +| :ref:`MultiplayerAPI` | :ref:`custom_multiplayer` | ++---------------------------------------------+-------------------------------------------------------------------+ +| :ref:`String` | :ref:`filename` | ++---------------------------------------------+-------------------------------------------------------------------+ +| :ref:`MultiplayerAPI` | :ref:`multiplayer` | ++---------------------------------------------+-------------------------------------------------------------------+ +| :ref:`String` | :ref:`name` | ++---------------------------------------------+-------------------------------------------------------------------+ +| :ref:`Node` | :ref:`owner` | ++---------------------------------------------+-------------------------------------------------------------------+ +| :ref:`PauseMode` | :ref:`pause_mode` | ++---------------------------------------------+-------------------------------------------------------------------+ Methods ------- -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_enter_tree` **(** **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_exit_tree` **(** **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_configuration_warning` **(** **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_physics_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_ready` **(** **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child_below_node` **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_process` **(** **)** 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_parent` **(** :ref:`String` mask **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_child_count` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_children` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_master` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_parent` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :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_displayed_folded` **(** **)** 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_inside_tree` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_master` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_physics_processing` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stray_nodes` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree_pretty` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_free` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`raise` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_and_skip` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Node` node **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_ready` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_unreliable` **(** :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 **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`RPCMode` mode **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_process` **(** :ref:`bool` enable **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process` **(** :ref:`bool` enable **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_priority` **(** :ref:`int` priority **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_enter_tree` **(** **)** virtual | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_exit_tree` **(** **)** virtual | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_configuration_warning` **(** **)** virtual | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_physics_process` **(** :ref:`float` delta **)** virtual | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_ready` **(** **)** virtual | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child_below_node` **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_process` **(** **)** 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_parent` **(** :ref:`String` mask **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_child_count` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_children` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_groups` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_master` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_parent` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :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_displayed_folded` **(** **)** 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_inside_tree` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_master` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_physics_processing` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stray_nodes` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree_pretty` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_free` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`raise` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_and_skip` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Node` node **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_ready` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_unreliable` **(** :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 **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`RPCMode` mode **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_process` **(** :ref:`bool` enable **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_process_internal` **(** :ref:`bool` enable **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process` **(** :ref:`bool` enable **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_priority` **(** :ref:`int` priority **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Node_ready: +.. _class_Node_signal_ready: - **ready** **(** **)** Emitted when the node is ready. -.. _class_Node_renamed: +.. _class_Node_signal_renamed: - **renamed** **(** **)** Emitted when the node is renamed. -.. _class_Node_tree_entered: +.. _class_Node_signal_tree_entered: - **tree_entered** **(** **)** Emitted when the node enters the tree. -.. _class_Node_tree_exited: +.. _class_Node_signal_tree_exited: - **tree_exited** **(** **)** Emitted after the node exits the tree and is no longer active. -.. _class_Node_tree_exiting: +.. _class_Node_signal_tree_exiting: - **tree_exiting** **(** **)** @@ -242,6 +242,12 @@ Enumerations .. _enum_Node_PauseMode: +.. _class_Node_constant_PAUSE_MODE_INHERIT: + +.. _class_Node_constant_PAUSE_MODE_STOP: + +.. _class_Node_constant_PAUSE_MODE_PROCESS: + enum **PauseMode**: - **PAUSE_MODE_INHERIT** = **0** --- Inherits pause mode from the node's parent. For the root node, it is equivalent to PAUSE_MODE_STOP. Default. @@ -252,6 +258,14 @@ enum **PauseMode**: .. _enum_Node_DuplicateFlags: +.. _class_Node_constant_DUPLICATE_SIGNALS: + +.. _class_Node_constant_DUPLICATE_GROUPS: + +.. _class_Node_constant_DUPLICATE_SCRIPTS: + +.. _class_Node_constant_DUPLICATE_USE_INSTANCING: + enum **DuplicateFlags**: - **DUPLICATE_SIGNALS** = **1** --- Duplicate the node's signals. @@ -265,21 +279,55 @@ enum **DuplicateFlags**: Constants --------- +.. _class_Node_constant_NOTIFICATION_ENTER_TREE: + +.. _class_Node_constant_NOTIFICATION_EXIT_TREE: + +.. _class_Node_constant_NOTIFICATION_MOVED_IN_PARENT: + +.. _class_Node_constant_NOTIFICATION_READY: + +.. _class_Node_constant_NOTIFICATION_PAUSED: + +.. _class_Node_constant_NOTIFICATION_UNPAUSED: + +.. _class_Node_constant_NOTIFICATION_PHYSICS_PROCESS: + +.. _class_Node_constant_NOTIFICATION_PROCESS: + +.. _class_Node_constant_NOTIFICATION_PARENTED: + +.. _class_Node_constant_NOTIFICATION_UNPARENTED: + +.. _class_Node_constant_NOTIFICATION_INSTANCED: + +.. _class_Node_constant_NOTIFICATION_DRAG_BEGIN: + +.. _class_Node_constant_NOTIFICATION_DRAG_END: + +.. _class_Node_constant_NOTIFICATION_PATH_CHANGED: + +.. _class_Node_constant_NOTIFICATION_TRANSLATION_CHANGED: + +.. _class_Node_constant_NOTIFICATION_INTERNAL_PROCESS: + +.. _class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS: + - **NOTIFICATION_ENTER_TREE** = **10** --- Notification received when the node enters a :ref:`SceneTree`. - **NOTIFICATION_EXIT_TREE** = **11** --- Notification received when the node is about to exit a :ref:`SceneTree`. - **NOTIFICATION_MOVED_IN_PARENT** = **12** --- Notification received when the node is moved in the parent. -- **NOTIFICATION_READY** = **13** --- Notification received when the node is ready. See :ref:`_ready`. +- **NOTIFICATION_READY** = **13** --- Notification received when the node is ready. See :ref:`_ready`. - **NOTIFICATION_PAUSED** = **14** --- Notification received when the node is paused. - **NOTIFICATION_UNPAUSED** = **15** --- Notification received when the node is unpaused. -- **NOTIFICATION_PHYSICS_PROCESS** = **16** --- Notification received every frame when the physics process flag is set (see :ref:`set_physics_process`). +- **NOTIFICATION_PHYSICS_PROCESS** = **16** --- Notification received every frame when the physics process flag is set (see :ref:`set_physics_process`). -- **NOTIFICATION_PROCESS** = **17** --- Notification received every frame when the process flag is set (see :ref:`set_process`). +- **NOTIFICATION_PROCESS** = **17** --- Notification received every frame when the process flag is set (see :ref:`set_process`). - **NOTIFICATION_PARENTED** = **18** --- Notification received when a node is set as a child of another node. Note that this doesn't mean that a node entered the Scene Tree. @@ -293,11 +341,11 @@ Constants - **NOTIFICATION_PATH_CHANGED** = **23** --- Notification received when the node's :ref:`NodePath` changed. -- **NOTIFICATION_TRANSLATION_CHANGED** = **24** --- Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like :ref:`Object.tr`. +- **NOTIFICATION_TRANSLATION_CHANGED** = **24** --- Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like :ref:`Object.tr`. -- **NOTIFICATION_INTERNAL_PROCESS** = **25** --- Notification received every frame when the internal process flag is set (see :ref:`set_process_internal`). +- **NOTIFICATION_INTERNAL_PROCESS** = **25** --- Notification received every frame when the internal process flag is set (see :ref:`set_process_internal`). -- **NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = **26** --- Notification received every frame when the internal physics process flag is set (see :ref:`set_physics_process_internal`). +- **NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = **26** --- Notification received every frame when the internal physics process flag is set (see :ref:`set_physics_process_internal`). Description ----------- @@ -306,23 +354,23 @@ Nodes are Godot's building blocks. They can be assigned as the child of another A tree of nodes is called a *scene*. Scenes can be saved to the disk and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of Godot projects. -**Scene tree:** The :ref:`SceneTree` contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its :ref:`_enter_tree` callback is triggered. Child nodes are always added *after* their parent node, i.e. the :ref:`_enter_tree` callback of a parent node will be triggered before its child's. +**Scene tree:** The :ref:`SceneTree` contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its :ref:`_enter_tree` callback is triggered. Child nodes are always added *after* their parent node, i.e. the :ref:`_enter_tree` callback of a parent node will be triggered before its child's. -Once all nodes have been added in the scene tree, they receive the NOTIFICATION_READY notification and their respective :ref:`_ready` callbacks are triggered. For groups of nodes, the :ref:`_ready` callback is called in reverse order, starting with the children and moving up to the parent nodes. +Once all nodes have been added in the scene tree, they receive the NOTIFICATION_READY notification and their respective :ref:`_ready` callbacks are triggered. For groups of nodes, the :ref:`_ready` callback is called in reverse order, starting with the children and moving up to the parent nodes. -This means that when adding a node to the scene tree, the following order will be used for the callbacks: :ref:`_enter_tree` of the parent, :ref:`_enter_tree` of the children, :ref:`_ready` of the children and finally :ref:`_ready` of the parent (recursively for the entire scene tree). +This means that when adding a node to the scene tree, the following order will be used for the callbacks: :ref:`_enter_tree` of the parent, :ref:`_enter_tree` of the children, :ref:`_ready` of the children and finally :ref:`_ready` of the parent (recursively for the entire scene tree). -**Processing:** Nodes can override the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback :ref:`_process`, toggled with :ref:`set_process`) happens as fast as possible and is dependent on the frame rate, so the processing time *delta* is passed as an argument. Physics processing (callback :ref:`_physics_process`, toggled with :ref:`set_physics_process`) happens a fixed number of times per second (60 by default) and is useful for code related to the physics engine. +**Processing:** Nodes can override the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback :ref:`_process`, toggled with :ref:`set_process`) happens as fast as possible and is dependent on the frame rate, so the processing time *delta* is passed as an argument. Physics processing (callback :ref:`_physics_process`, toggled with :ref:`set_physics_process`) happens a fixed number of times per second (60 by default) and is useful for code related to the physics engine. -Nodes can also process input events. When present, the :ref:`_input` function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the :ref:`_unhandled_input` function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI :ref:`Control` nodes), ensuring that the node only receives the events that were meant for it. +Nodes can also process input events. When present, the :ref:`_input` function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the :ref:`_unhandled_input` function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI :ref:`Control` nodes), ensuring that the node only receives the events that were meant for it. -To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with the :ref:`owner` property. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. +To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with the :ref:`owner` property. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. -Finally, when a node is freed with :ref:`Object.free` or :ref:`queue_free`, it will also free all its children. +Finally, when a node is freed with :ref:`Object.free` or :ref:`queue_free`, it will also free all its children. -**Groups:** Nodes can be added to as many groups as you want to be easy to manage, you could create groups like "enemies" or "collectables" for example, depending on your game. See :ref:`add_to_group`, :ref:`is_in_group` and :ref:`remove_from_group`. You can then retrieve all nodes in these groups, iterate them and even call methods on groups via the methods on :ref:`SceneTree`. +**Groups:** Nodes can be added to as many groups as you want to be easy to manage, you could create groups like "enemies" or "collectables" for example, depending on your game. See :ref:`add_to_group`, :ref:`is_in_group` and :ref:`remove_from_group`. You can then retrieve all nodes in these groups, iterate them and even call methods on groups via the methods on :ref:`SceneTree`. -**Networking with nodes:** After connecting to a server (or making one, see :ref:`NetworkedMultiplayerENet`) it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling :ref:`rpc` with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections). To identify which node receives the RPC call Godot will use its :ref:`NodePath` (make sure node names are the same on all peers). Also take a look at the high-level networking tutorial and corresponding demos. +**Networking with nodes:** After connecting to a server (or making one, see :ref:`NetworkedMultiplayerENet`) it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling :ref:`rpc` with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections). To identify which node receives the RPC call Godot will use its :ref:`NodePath` (make sure node names are the same on all peers). Also take a look at the high-level networking tutorial and corresponding demos. Tutorials --------- @@ -332,7 +380,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Node_custom_multiplayer: +.. _class_Node_property_custom_multiplayer: - :ref:`MultiplayerAPI` **custom_multiplayer** @@ -344,7 +392,7 @@ Property Descriptions The override to the default :ref:`MultiplayerAPI`. Set to null to use the default SceneTree one. -.. _class_Node_filename: +.. _class_Node_property_filename: - :ref:`String` **filename** @@ -356,7 +404,7 @@ The override to the default :ref:`MultiplayerAPI`. Set to When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. -.. _class_Node_multiplayer: +.. _class_Node_property_multiplayer: - :ref:`MultiplayerAPI` **multiplayer** @@ -364,9 +412,9 @@ When a scene is instanced from a file, its topmost node contains the filename fr | *Getter* | get_multiplayer() | +----------+-------------------+ -The :ref:`MultiplayerAPI` instance associated with this node. Either the :ref:`custom_multiplayer`, or the default SceneTree one (if inside tree). +The :ref:`MultiplayerAPI` instance associated with this node. Either the :ref:`custom_multiplayer`, or the default SceneTree one (if inside tree). -.. _class_Node_name: +.. _class_Node_property_name: - :ref:`String` **name** @@ -378,7 +426,7 @@ The :ref:`MultiplayerAPI` instance associated with this no The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed -.. _class_Node_owner: +.. _class_Node_property_owner: - :ref:`Node` **owner** @@ -390,7 +438,7 @@ The name of the node. This name is unique among the siblings (other child nodes The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using :ref:`PackedScene`) all the nodes it owns will be saved with it. This allows for the creation of complex :ref:`SceneTree`\ s, with instancing and subinstancing. -.. _class_Node_pause_mode: +.. _class_Node_property_pause_mode: - :ref:`PauseMode` **pause_mode** @@ -405,93 +453,93 @@ Pause mode. How the node will behave if the :ref:`SceneTree` is Method Descriptions ------------------- -.. _class_Node__enter_tree: +.. _class_Node_method__enter_tree: - 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. +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. -Corresponds to the NOTIFICATION_ENTER_TREE notification in :ref:`Object._notification`. +Corresponds to the NOTIFICATION_ENTER_TREE notification in :ref:`Object._notification`. -.. _class_Node__exit_tree: +.. _class_Node_method__exit_tree: - void **_exit_tree** **(** **)** virtual -Called when the node is about to leave the :ref:`SceneTree` (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. +Called when the node is about to leave the :ref:`SceneTree` (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. -Corresponds to the NOTIFICATION_EXIT_TREE notification in :ref:`Object._notification` and signal :ref:`tree_exiting`. To get notified when the node has already left the active tree, connect to the :ref:`tree_exited` +Corresponds to the NOTIFICATION_EXIT_TREE notification in :ref:`Object._notification` and signal :ref:`tree_exiting`. To get notified when the node has already left the active tree, connect to the :ref:`tree_exited` -.. _class_Node__get_configuration_warning: +.. _class_Node_method__get_configuration_warning: - :ref:`String` **_get_configuration_warning** **(** **)** virtual -.. _class_Node__input: +.. _class_Node_method__input: - 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. -It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_input`. +It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_input`. -To consume the input event and stop it propagating further to other nodes, :ref:`SceneTree.set_input_as_handled` can be called. +To consume the input event and stop it propagating further to other nodes, :ref:`SceneTree.set_input_as_handled` can be called. -For gameplay input, :ref:`_unhandled_input` and :ref:`_unhandled_key_input` are usually a better fit as they allow the GUI to intercept the events first. +For gameplay input, :ref:`_unhandled_input` and :ref:`_unhandled_key_input` are usually a better fit as they allow the GUI to intercept the events first. -.. _class_Node__physics_process: +.. _class_Node_method__physics_process: - 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. -It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_physics_process`. +It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_physics_process`. -Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in :ref:`Object._notification`. +Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in :ref:`Object._notification`. -.. _class_Node__process: +.. _class_Node_method__process: - 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. -It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process`. +It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process`. -Corresponds to the NOTIFICATION_PROCESS notification in :ref:`Object._notification`. +Corresponds to the NOTIFICATION_PROCESS notification in :ref:`Object._notification`. -.. _class_Node__ready: +.. _class_Node_method__ready: - void **_ready** **(** **)** virtual -Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their :ref:`_ready` callbacks get triggered first, and the parent node will receive the ready notification afterwards. +Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their :ref:`_ready` callbacks get triggered first, and the parent node will receive the ready notification afterwards. -Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification`. See also the ``onready`` keyword for variables. +Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification`. See also the ``onready`` keyword for variables. -Usually used for initialization. For even earlier initialization, :ref:`Object._init` may be used. Also see :ref:`_enter_tree`. +Usually used for initialization. For even earlier initialization, :ref:`Object._init` may be used. Also see :ref:`_enter_tree`. -.. _class_Node__unhandled_input: +.. _class_Node_method__unhandled_input: - 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. +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. -It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_unhandled_input`. +It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_unhandled_input`. -To consume the input event and stop it propagating further to other nodes, :ref:`SceneTree.set_input_as_handled` can be called. +To consume the input event and stop it propagating further to other nodes, :ref:`SceneTree.set_input_as_handled` can be called. -For gameplay input, this and :ref:`_unhandled_key_input` are usually a better fit than :ref:`_input` as they allow the GUI to intercept the events first. +For gameplay input, this and :ref:`_unhandled_key_input` are usually a better fit than :ref:`_input` as they allow the GUI to intercept the events first. -.. _class_Node__unhandled_key_input: +.. _class_Node_method__unhandled_key_input: - 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. +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. -It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_unhandled_key_input`. +It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_unhandled_key_input`. -To consume the input event and stop it propagating further to other nodes, :ref:`SceneTree.set_input_as_handled` can be called. +To consume the input event and stop it propagating further to other nodes, :ref:`SceneTree.set_input_as_handled` can be called. -For gameplay input, this and :ref:`_unhandled_input` are usually a better fit than :ref:`_input` as they allow the GUI to intercept the events first. +For gameplay input, this and :ref:`_unhandled_input` are usually a better fit than :ref:`_input` as they allow the GUI to intercept the events first. -.. _class_Node_add_child: +.. _class_Node_method_add_child: - void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** @@ -499,7 +547,7 @@ Adds a child node. Nodes can have any number of children, but every child must h Setting "legible_unique_name" ``true`` creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. -.. _class_Node_add_child_below_node: +.. _class_Node_method_add_child_below_node: - void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** @@ -507,19 +555,19 @@ Adds a child node. The child is placed below the given node in the list of child Setting "legible_unique_name" ``true`` creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. -.. _class_Node_add_to_group: +.. _class_Node_method_add_to_group: - void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** -Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see :ref:`is_inside_tree`). See notes in the description, and the group methods in :ref:`SceneTree`. +Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see :ref:`is_inside_tree`). See notes in the description, and the group methods in :ref:`SceneTree`. -.. _class_Node_can_process: +.. _class_Node_method_can_process: - :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. +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. -.. _class_Node_duplicate: +.. _class_Node_method_duplicate: - :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const @@ -527,65 +575,65 @@ Duplicates the node, returning a new node. You can fine-tune the behavior using the ``flags`` (see :ref:`DuplicateFlags`). -.. _class_Node_find_node: +.. _class_Node_method_find_node: - :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 '.'). Note that it does not match against the full path, just against individual node names. +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 '.'). Note that it does not match against the full path, just against individual node names. If ``owned`` is ``true``, this method only finds nodes whose owner is this node. This is especially important for scenes instantiated through script, because those scenes don't have an owner. -.. _class_Node_find_parent: +.. _class_Node_method_find_parent: - :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 that it does not match against the full path, just against individual node names. +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 that it does not match against the full path, just against individual node names. -.. _class_Node_get_child: +.. _class_Node_method_get_child: - :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. +Returns a child node by its index (see :ref:`get_child_count`). This method is often used for iterating all children of a node. -To access a child node via its name, use :ref:`get_node`. +To access a child node via its name, use :ref:`get_node`. -.. _class_Node_get_child_count: +.. _class_Node_method_get_child_count: - :ref:`int` **get_child_count** **(** **)** const Returns the number of child nodes. -.. _class_Node_get_children: +.. _class_Node_method_get_children: - :ref:`Array` **get_children** **(** **)** const Returns an array of references to node's children. -.. _class_Node_get_groups: +.. _class_Node_method_get_groups: - :ref:`Array` **get_groups** **(** **)** const Returns an array listing the groups that the node is a member of. -.. _class_Node_get_index: +.. _class_Node_method_get_index: - :ref:`int` **get_index** **(** **)** const Returns the node's index, i.e. its position among the siblings of its parent. -.. _class_Node_get_network_master: +.. _class_Node_method_get_network_master: - :ref:`int` **get_network_master** **(** **)** const -Returns the peer ID of the network master for this node. See :ref:`set_network_master`. +Returns the peer ID of the network master for this node. See :ref:`set_network_master`. -.. _class_Node_get_node: +.. _class_Node_method_get_node: - :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 attempts to access it will result in an "Attempt to call on a null instance." error. -**Note:** Fetching absolute paths only works when the node is inside the scene tree (see :ref:`is_inside_tree`). +**Note:** Fetching absolute paths only works when the node is inside the scene tree (see :ref:`is_inside_tree`). **Example:** Assume your current node is Character and the following tree: @@ -609,169 +657,169 @@ Possible paths are: get_node("../Swamp/Alligator") get_node("/root/MyGame") -.. _class_Node_get_node_and_resource: +.. _class_Node_method_get_node_and_resource: - :ref:`Array` **get_node_and_resource** **(** :ref:`NodePath` path **)** -.. _class_Node_get_parent: +.. _class_Node_method_get_parent: - :ref:`Node` **get_parent** **(** **)** const Returns the parent node of the current node, or an empty ``Node`` if the node lacks a parent. -.. _class_Node_get_path: +.. _class_Node_method_get_path: - :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`). +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`). -.. _class_Node_get_path_to: +.. _class_Node_method_get_path_to: - :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. -.. _class_Node_get_physics_process_delta_time: +.. _class_Node_method_get_physics_process_delta_time: - :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 in :ref:`OS`. +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 in :ref:`OS`. -.. _class_Node_get_position_in_parent: +.. _class_Node_method_get_position_in_parent: - :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``. -.. _class_Node_get_process_delta_time: +.. _class_Node_method_get_process_delta_time: - :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. -.. _class_Node_get_scene_instance_load_placeholder: +.. _class_Node_method_get_scene_instance_load_placeholder: - :ref:`bool` **get_scene_instance_load_placeholder** **(** **)** const Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlaceholder`. -.. _class_Node_get_tree: +.. _class_Node_method_get_tree: - :ref:`SceneTree` **get_tree** **(** **)** const Returns the :ref:`SceneTree` that contains this node. -.. _class_Node_get_viewport: +.. _class_Node_method_get_viewport: - :ref:`Viewport` **get_viewport** **(** **)** const Returns the node's :ref:`Viewport`. -.. _class_Node_has_node: +.. _class_Node_method_has_node: - :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** const Returns ``true`` if the node that the :ref:`NodePath` points to exists. -.. _class_Node_has_node_and_resource: +.. _class_Node_method_has_node_and_resource: - :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const -.. _class_Node_is_a_parent_of: +.. _class_Node_method_is_a_parent_of: - :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. -.. _class_Node_is_displayed_folded: +.. _class_Node_method_is_displayed_folded: - :ref:`bool` **is_displayed_folded** **(** **)** const Returns ``true`` if the node is folded (collapsed) in the Scene dock. -.. _class_Node_is_greater_than: +.. _class_Node_method_is_greater_than: - :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. -.. _class_Node_is_in_group: +.. _class_Node_method_is_in_group: - :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`. -.. _class_Node_is_inside_tree: +.. _class_Node_method_is_inside_tree: - :ref:`bool` **is_inside_tree** **(** **)** const Returns ``true`` if this node is currently inside a :ref:`SceneTree`. -.. _class_Node_is_network_master: +.. _class_Node_method_is_network_master: - :ref:`bool` **is_network_master** **(** **)** const Returns ``true`` if the local system is the master of this node. -.. _class_Node_is_physics_processing: +.. _class_Node_method_is_physics_processing: - :ref:`bool` **is_physics_processing** **(** **)** const -Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process`). +Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process`). -.. _class_Node_is_physics_processing_internal: +.. _class_Node_method_is_physics_processing_internal: - :ref:`bool` **is_physics_processing_internal** **(** **)** const -Returns ``true`` if internal physics processing is enabled (see :ref:`set_physics_process_internal`). +Returns ``true`` if internal physics processing is enabled (see :ref:`set_physics_process_internal`). -.. _class_Node_is_processing: +.. _class_Node_method_is_processing: - :ref:`bool` **is_processing** **(** **)** const -Returns ``true`` if processing is enabled (see :ref:`set_process`). +Returns ``true`` if processing is enabled (see :ref:`set_process`). -.. _class_Node_is_processing_input: +.. _class_Node_method_is_processing_input: - :ref:`bool` **is_processing_input** **(** **)** const -Returns ``true`` if the node is processing input (see :ref:`set_process_input`). +Returns ``true`` if the node is processing input (see :ref:`set_process_input`). -.. _class_Node_is_processing_internal: +.. _class_Node_method_is_processing_internal: - :ref:`bool` **is_processing_internal** **(** **)** const -Returns ``true`` if internal processing is enabled (see :ref:`set_process_internal`). +Returns ``true`` if internal processing is enabled (see :ref:`set_process_internal`). -.. _class_Node_is_processing_unhandled_input: +.. _class_Node_method_is_processing_unhandled_input: - :ref:`bool` **is_processing_unhandled_input** **(** **)** const -Returns ``true`` if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). +Returns ``true`` if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). -.. _class_Node_is_processing_unhandled_key_input: +.. _class_Node_method_is_processing_unhandled_key_input: - :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`). +Returns ``true`` if the node is processing unhandled key input (see :ref:`set_process_unhandled_key_input`). -.. _class_Node_move_child: +.. _class_Node_method_move_child: - void **move_child** **(** :ref:`Node` child_node, :ref:`int` to_position **)** Moves a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. -.. _class_Node_print_stray_nodes: +.. _class_Node_method_print_stray_nodes: - void **print_stray_nodes** **(** **)** Prints all stray nodes (nodes outside the :ref:`SceneTree`). Used for debugging. Works only in debug builds. -.. _class_Node_print_tree: +.. _class_Node_method_print_tree: - void **print_tree** **(** **)** -Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the :ref:`get_node` function. Example output: +Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the :ref:`get_node` function. Example output: :: @@ -782,11 +830,11 @@ Prints the tree to stdout. Used mainly for debugging purposes. This version disp TheGame/SplashScreen TheGame/SplashScreen/Camera2D -.. _class_Node_print_tree_pretty: +.. _class_Node_method_print_tree_pretty: - void **print_tree_pretty** **(** **)** -Similar to :ref:`print_tree`, this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees. Example output: +Similar to :ref:`print_tree`, this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees. Example output: :: @@ -797,179 +845,179 @@ Similar to :ref:`print_tree`, this prints the tree to std â”–-SplashScreen â”–â•´Camera2D -.. _class_Node_propagate_call: +.. _class_Node_method_propagate_call: - void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** Calls the given method (if present) with the arguments given in ``args`` on this node and recursively on all its children. If the parent_first argument is ``true`` then the method will be called on the current node first, then on all children. If it is ``false`` then the children will be called first. -.. _class_Node_propagate_notification: +.. _class_Node_method_propagate_notification: - void **propagate_notification** **(** :ref:`int` what **)** Notifies the current node and all its children recursively by calling notification() on all of them. -.. _class_Node_queue_free: +.. _class_Node_method_queue_free: - void **queue_free** **(** **)** -Queues a node for deletion at the end of the current frame. When deleted, all of its child nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to :ref:`Object.free`. Use :ref:`Object.is_queued_for_deletion` to check whether a node will be deleted at the end of the frame. +Queues a node for deletion at the end of the current frame. When deleted, all of its child nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to :ref:`Object.free`. Use :ref:`Object.is_queued_for_deletion` to check whether a node will be deleted at the end of the frame. -.. _class_Node_raise: +.. _class_Node_method_raise: - void **raise** **(** **)** Moves this node to the top of the array of nodes of the parent node. This is often useful in GUIs (:ref:`Control` nodes), because their order of drawing depends on their order in the tree. -.. _class_Node_remove_and_skip: +.. _class_Node_method_remove_and_skip: - void **remove_and_skip** **(** **)** Removes a node and sets all its children as children of the parent node (if it exists). All event subscriptions that pass by the removed node will be unsubscribed. -.. _class_Node_remove_child: +.. _class_Node_method_remove_child: - void **remove_child** **(** :ref:`Node` node **)** Removes a child node. The node is NOT deleted and must be deleted manually. -.. _class_Node_remove_from_group: +.. _class_Node_method_remove_from_group: - void **remove_from_group** **(** :ref:`String` group **)** Removes a node from a group. See notes in the description, and the group methods in :ref:`SceneTree`. -.. _class_Node_replace_by: +.. _class_Node_method_replace_by: - void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost. -.. _class_Node_request_ready: +.. _class_Node_method_request_ready: - void **request_ready** **(** **)** Requests that ``_ready`` be called again. -.. _class_Node_rpc: +.. _class_Node_method_rpc: - :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. Also see :ref:`rset` and :ref:`rset_config` for properties. Returns an empty :ref:`Variant`. Note that you can only safely use RPCs on clients after you received the ``connected_to_server`` signal from the :ref:`SceneTree`. You also need to keep track of the connection state, either by the :ref:`SceneTree` signals like ``server_disconnected`` or by checking ``SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED``. +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. Also see :ref:`rset` and :ref:`rset_config` for properties. Returns an empty :ref:`Variant`. Note that you can only safely use RPCs on clients after you received the ``connected_to_server`` signal from the :ref:`SceneTree`. You also need to keep track of the connection state, either by the :ref:`SceneTree` signals like ``server_disconnected`` or by checking ``SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED``. -.. _class_Node_rpc_config: +.. _class_Node_method_rpc_config: - void **rpc_config** **(** :ref:`String` method, :ref:`RPCMode` mode **)** -Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, methods are not exposed to networking (and RPCs). Also see :ref:`rset` and :ref:`rset_config` for properties. +Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, methods are not exposed to networking (and RPCs). Also see :ref:`rset` and :ref:`rset_config` for properties. -.. _class_Node_rpc_id: +.. _class_Node_method_rpc_id: - :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`. +Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. -.. _class_Node_rpc_unreliable: +.. _class_Node_method_rpc_unreliable: - :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method **)** vararg -Sends a :ref:`rpc` using an unreliable protocol. Returns an empty :ref:`Variant`. +Sends a :ref:`rpc` using an unreliable protocol. Returns an empty :ref:`Variant`. -.. _class_Node_rpc_unreliable_id: +.. _class_Node_method_rpc_unreliable_id: - :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`. +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`. -.. _class_Node_rset: +.. _class_Node_method_rset: - void **rset** **(** :ref:`String` property, :ref:`Variant` value **)** -Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see :ref:`rset_config`. Also see :ref:`rpc` for RPCs for methods, most information applies to this method as well. +Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see :ref:`rset_config`. Also see :ref:`rpc` for RPCs for methods, most information applies to this method as well. -.. _class_Node_rset_config: +.. _class_Node_method_rset_config: - void **rset_config** **(** :ref:`String` property, :ref:`RPCMode` mode **)** -Changes the RPC mode for the given ``property`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, properties are not exposed to networking (and RPCs). Also see :ref:`rpc` and :ref:`rpc_config` for methods. +Changes the RPC mode for the given ``property`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, properties are not exposed to networking (and RPCs). Also see :ref:`rpc` and :ref:`rpc_config` for methods. -.. _class_Node_rset_id: +.. _class_Node_method_rset_id: - void **rset_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** -Remotely changes the property's value on a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). +Remotely changes the property's value on a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). -.. _class_Node_rset_unreliable: +.. _class_Node_method_rset_unreliable: - void **rset_unreliable** **(** :ref:`String` property, :ref:`Variant` value **)** Remotely changes the property's value on other peers (and locally) using an unreliable protocol. -.. _class_Node_rset_unreliable_id: +.. _class_Node_method_rset_unreliable_id: - void **rset_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** -Remotely changes property's value on a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). +Remotely changes property's value on a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). -.. _class_Node_set_display_folded: +.. _class_Node_method_set_display_folded: - void **set_display_folded** **(** :ref:`bool` fold **)** Sets the folded state of the node in the Scene dock. -.. _class_Node_set_network_master: +.. _class_Node_method_set_network_master: - void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=true **)** Sets the node's network master to the peer with the given peer ID. The network master is the peer that has authority over the node on the network. Useful in conjunction with the ``master`` and ``puppet`` keywords. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). If ``recursive``, the given peer is recursively set as the master for all children of this node. -.. _class_Node_set_physics_process: +.. _class_Node_method_set_physics_process: - void **set_physics_process** **(** :ref:`bool` enable **)** -Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, see :ref:`OS` to change) interval (and the :ref:`_physics_process` callback will be called if exists). Enabled automatically if :ref:`_physics_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. +Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, see :ref:`OS` to change) interval (and the :ref:`_physics_process` callback will be called if exists). Enabled automatically if :ref:`_physics_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. -.. _class_Node_set_physics_process_internal: +.. _class_Node_method_set_physics_process_internal: - void **set_physics_process_internal** **(** :ref:`bool` enable **)** -Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process`). Only useful for advanced uses to manipulate built-in nodes behaviour. +Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process`). Only useful for advanced uses to manipulate built-in nodes behaviour. -.. _class_Node_set_process: +.. _class_Node_method_set_process: - void **set_process** **(** :ref:`bool` enable **)** -Enables or disables processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the :ref:`_process` callback will be called if exists). Enabled automatically if :ref:`_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. +Enables or disables processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the :ref:`_process` callback will be called if exists). Enabled automatically if :ref:`_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. -.. _class_Node_set_process_input: +.. _class_Node_method_set_process_input: - void **set_process_input** **(** :ref:`bool` enable **)** -Enables or disables input processing. This is not required for GUI controls! Enabled automatically if :ref:`_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. +Enables or disables input processing. This is not required for GUI controls! Enabled automatically if :ref:`_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. -.. _class_Node_set_process_internal: +.. _class_Node_method_set_process_internal: - void **set_process_internal** **(** :ref:`bool` enable **)** -Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process`). Only useful for advanced uses to manipulate built-in nodes behaviour. +Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process`). Only useful for advanced uses to manipulate built-in nodes behaviour. -.. _class_Node_set_process_priority: +.. _class_Node_method_set_process_priority: - void **set_process_priority** **(** :ref:`int` priority **)** -.. _class_Node_set_process_unhandled_input: +.. _class_Node_method_set_process_unhandled_input: - void **set_process_unhandled_input** **(** :ref:`bool` enable **)** -Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a :ref:`Control`). Enabled automatically if :ref:`_unhandled_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. +Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a :ref:`Control`). Enabled automatically if :ref:`_unhandled_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. -.. _class_Node_set_process_unhandled_key_input: +.. _class_Node_method_set_process_unhandled_key_input: - void **set_process_unhandled_key_input** **(** :ref:`bool` enable **)** -Enables unhandled key input processing. Enabled automatically if :ref:`_unhandled_key_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. +Enables unhandled key input processing. Enabled automatically if :ref:`_unhandled_key_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. -.. _class_Node_set_scene_instance_load_placeholder: +.. _class_Node_method_set_scene_instance_load_placeholder: - void **set_scene_instance_load_placeholder** **(** :ref:`bool` load_placeholder **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 879ad75fa..59a542c34 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -21,58 +21,58 @@ A 2D game object, parent of all 2D related nodes. Has a position, rotation, scal Properties ---------- -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`global_position` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`global_rotation` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`global_rotation_degrees` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`global_scale` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`global_transform` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation_degrees` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scale` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`z_as_relative` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`int` | :ref:`z_index` | -+---------------------------------------+----------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`global_position` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`global_rotation` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`global_rotation_degrees` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`global_scale` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`global_transform` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rotation` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rotation_degrees` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`scale` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`transform` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`z_as_relative` | ++---------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`z_index` | ++---------------------------------------+-------------------------------------------------------------------------------+ 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 **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -87,7 +87,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Node2D_global_position: +.. _class_Node2D_property_global_position: - :ref:`Vector2` **global_position** @@ -99,7 +99,7 @@ Property Descriptions Global position. -.. _class_Node2D_global_rotation: +.. _class_Node2D_property_global_rotation: - :ref:`float` **global_rotation** @@ -111,7 +111,7 @@ Global position. Global rotation in radians. -.. _class_Node2D_global_rotation_degrees: +.. _class_Node2D_property_global_rotation_degrees: - :ref:`float` **global_rotation_degrees** @@ -123,7 +123,7 @@ Global rotation in radians. Global rotation in degrees. -.. _class_Node2D_global_scale: +.. _class_Node2D_property_global_scale: - :ref:`Vector2` **global_scale** @@ -135,7 +135,7 @@ Global rotation in degrees. Global scale. -.. _class_Node2D_global_transform: +.. _class_Node2D_property_global_transform: - :ref:`Transform2D` **global_transform** @@ -147,7 +147,7 @@ Global scale. Global :ref:`Transform2D`. -.. _class_Node2D_position: +.. _class_Node2D_property_position: - :ref:`Vector2` **position** @@ -159,7 +159,7 @@ Global :ref:`Transform2D`. Position, relative to the node's parent. -.. _class_Node2D_rotation: +.. _class_Node2D_property_rotation: - :ref:`float` **rotation** @@ -171,7 +171,7 @@ Position, relative to the node's parent. Rotation in radians, relative to the node's parent. -.. _class_Node2D_rotation_degrees: +.. _class_Node2D_property_rotation_degrees: - :ref:`float` **rotation_degrees** @@ -183,7 +183,7 @@ Rotation in radians, relative to the node's parent. Rotation in degrees, relative to the node's parent. -.. _class_Node2D_scale: +.. _class_Node2D_property_scale: - :ref:`Vector2` **scale** @@ -195,7 +195,7 @@ Rotation in degrees, relative to the node's parent. The node's scale. Unscaled value: ``(1, 1)`` -.. _class_Node2D_transform: +.. _class_Node2D_property_transform: - :ref:`Transform2D` **transform** @@ -207,7 +207,7 @@ The node's scale. Unscaled value: ``(1, 1)`` Local :ref:`Transform2D`. -.. _class_Node2D_z_as_relative: +.. _class_Node2D_property_z_as_relative: - :ref:`bool` **z_as_relative** @@ -219,7 +219,7 @@ Local :ref:`Transform2D`. If ``true``, the node's Z-index is relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. -.. _class_Node2D_z_index: +.. _class_Node2D_property_z_index: - :ref:`int` **z_index** @@ -234,67 +234,67 @@ Z-index. Controls the order in which the nodes render. A node with a higher Z-in Method Descriptions ------------------- -.. _class_Node2D_apply_scale: +.. _class_Node2D_method_apply_scale: - void **apply_scale** **(** :ref:`Vector2` ratio **)** Multiplies the current scale by the 'ratio' vector. -.. _class_Node2D_get_angle_to: +.. _class_Node2D_method_get_angle_to: - :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const Returns the angle between the node and the 'point' in radians. -.. _class_Node2D_get_relative_transform_to_parent: +.. _class_Node2D_method_get_relative_transform_to_parent: - :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const Returns the :ref:`Transform2D` relative to this node's parent. -.. _class_Node2D_global_translate: +.. _class_Node2D_method_global_translate: - void **global_translate** **(** :ref:`Vector2` offset **)** Adds the 'offset' vector to the node's global position. -.. _class_Node2D_look_at: +.. _class_Node2D_method_look_at: - void **look_at** **(** :ref:`Vector2` point **)** Rotates the node so it points towards the 'point'. -.. _class_Node2D_move_local_x: +.. _class_Node2D_method_move_local_x: - void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** -Applies a local translation on the node's X axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is false, normalizes the movement. +Applies a local translation on the node's X axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is false, normalizes the movement. -.. _class_Node2D_move_local_y: +.. _class_Node2D_method_move_local_y: - void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** -Applies a local translation on the node's Y axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is false, normalizes the movement. +Applies a local translation on the node's Y axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is false, normalizes the movement. -.. _class_Node2D_rotate: +.. _class_Node2D_method_rotate: - void **rotate** **(** :ref:`float` radians **)** Applies a rotation to the node, in radians, starting from its current rotation. -.. _class_Node2D_to_global: +.. _class_Node2D_method_to_global: - :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const Converts a local point's coordinates to global coordinates. -.. _class_Node2D_to_local: +.. _class_Node2D_method_to_local: - :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** const Converts a global point's coordinates to local coordinates. -.. _class_Node2D_translate: +.. _class_Node2D_method_translate: - void **translate** **(** :ref:`Vector2` offset **)** diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index c98408e73..0f06fa75b 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -17,83 +17,83 @@ Pre-parsed scene tree path. Methods ------- -+----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | -+----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_as_property_path` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_concatenated_subnames` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** :ref:`int` idx **)** | -+----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_name_count` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_subname` **(** :ref:`int` idx **)** | -+----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subname_count` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_absolute` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_as_property_path` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_concatenated_subnames` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** :ref:`int` idx **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_name_count` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_subname` **(** :ref:`int` idx **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subname_count` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_absolute` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------+ Description ----------- -A pre-parsed relative or absolute path in a scene tree, for use with :ref:`Node.get_node` and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, ``"Path2D/PathFollow2D/Sprite:texture:size"`` would refer to the size property of the texture resource on the node named "Sprite" which is a child of the other named nodes in the path. Note that if you want to get a resource, you must end the path with a colon, otherwise the last element will be used as a property name. +A pre-parsed relative or absolute path in a scene tree, for use with :ref:`Node.get_node` and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, ``"Path2D/PathFollow2D/Sprite:texture:size"`` would refer to the size property of the texture resource on the node named "Sprite" which is a child of the other named nodes in the path. Note that if you want to get a resource, you must end the path with a colon, otherwise the last element will be used as a property name. -You will usually just pass a string to :ref:`Node.get_node` and it will be automatically converted, but you may occasionally want to parse a path ahead of time with ``NodePath`` or the literal syntax ``@"path"``. Exporting a ``NodePath`` variable will give you a node selection widget in the properties panel of the editor, which can often be useful. +You will usually just pass a string to :ref:`Node.get_node` and it will be automatically converted, but you may occasionally want to parse a path ahead of time with ``NodePath`` or the literal syntax ``@"path"``. Exporting a ``NodePath`` variable will give you a node selection widget in the properties panel of the editor, which can often be useful. A ``NodePath`` is made up of a list of node names, a list of "subnode" (resource) names, and the name of a property in the final node or resource. Method Descriptions ------------------- -.. _class_NodePath_NodePath: +.. _class_NodePath_method_NodePath: - :ref:`NodePath` **NodePath** **(** :ref:`String` from **)** Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, ``"."`` and ``".."`` indicate the current node and its parent. -.. _class_NodePath_get_as_property_path: +.. _class_NodePath_method_get_as_property_path: - :ref:`NodePath` **get_as_property_path** **(** **)** -.. _class_NodePath_get_concatenated_subnames: +.. _class_NodePath_method_get_concatenated_subnames: - :ref:`String` **get_concatenated_subnames** **(** **)** -.. _class_NodePath_get_name: +.. _class_NodePath_method_get_name: - :ref:`String` **get_name** **(** :ref:`int` idx **)** -Get the node name indicated by ``idx`` (0 to :ref:`get_name_count`) +Get the node name indicated by ``idx`` (0 to :ref:`get_name_count`) -.. _class_NodePath_get_name_count: +.. _class_NodePath_method_get_name_count: - :ref:`int` **get_name_count** **(** **)** Get the number of node names which make up the path. -.. _class_NodePath_get_subname: +.. _class_NodePath_method_get_subname: - :ref:`String` **get_subname** **(** :ref:`int` idx **)** -Get the resource name indicated by ``idx`` (0 to :ref:`get_subname_count`) +Get the resource name indicated by ``idx`` (0 to :ref:`get_subname_count`) -.. _class_NodePath_get_subname_count: +.. _class_NodePath_method_get_subname_count: - :ref:`int` **get_subname_count** **(** **)** Get the number of resource names in the path. -.. _class_NodePath_is_absolute: +.. _class_NodePath_method_is_absolute: - :ref:`bool` **is_absolute** **(** **)** Return true if the node path is absolute (not relative). -.. _class_NodePath_is_empty: +.. _class_NodePath_method_is_empty: - :ref:`bool` **is_empty** **(** **)** diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index d3c5e3727..798dd4fdf 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -19,17 +19,17 @@ Brief Description Properties ---------- -+-------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`as_normalmap` | -+-------------------------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`height` | -+-------------------------------------------------+------------------------------------------------------+ -| :ref:`OpenSimplexNoise` | :ref:`noise` | -+-------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`seamless` | -+-------------------------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`width` | -+-------------------------------------------------+------------------------------------------------------+ ++-------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`as_normalmap` | ++-------------------------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`height` | ++-------------------------------------------------+---------------------------------------------------------------+ +| :ref:`OpenSimplexNoise` | :ref:`noise` | ++-------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`seamless` | ++-------------------------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`width` | ++-------------------------------------------------+---------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ NoiseTexture can also generate normalmap textures. Property Descriptions --------------------- -.. _class_NoiseTexture_as_normalmap: +.. _class_NoiseTexture_property_as_normalmap: - :ref:`bool` **as_normalmap** @@ -53,7 +53,7 @@ Property Descriptions If true, the resulting texture contains a normal map created from the original noise interpreted as a bump map. -.. _class_NoiseTexture_height: +.. _class_NoiseTexture_property_height: - :ref:`int` **height** @@ -65,7 +65,7 @@ If true, the resulting texture contains a normal map created from the original n Height of the generated texture. -.. _class_NoiseTexture_noise: +.. _class_NoiseTexture_property_noise: - :ref:`OpenSimplexNoise` **noise** @@ -77,7 +77,7 @@ Height of the generated texture. The :ref:`OpenSimplexNoise` instance used to generate the noise. -.. _class_NoiseTexture_seamless: +.. _class_NoiseTexture_property_seamless: - :ref:`bool` **seamless** @@ -89,7 +89,7 @@ The :ref:`OpenSimplexNoise` instance used to generate th Whether the texture can be tiled without visible seams or not. Seamless textures take longer to generate. -.. _class_NoiseTexture_width: +.. _class_NoiseTexture_property_width: - :ref:`int` **width** diff --git a/classes/class_object.rst b/classes/class_object.rst index baea9ebf9..46507a77c 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -19,98 +19,98 @@ Base class for all non built-in types. Methods ------- -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_get` **(** :ref:`String` property **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_init` **(** **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :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:`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 **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_id` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Reference` | :ref:`get_script` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`property_list_changed_notify` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_deferred` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_indexed` **(** :ref:`NodePath` property, :ref:`Variant` value **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script` **(** :ref:`Reference` script **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_get` **(** :ref:`String` property **)** virtual | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** virtual | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :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:`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 **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_instance_id` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_method_list` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_property_list` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Reference` | :ref:`get_script` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`property_list_changed_notify` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_deferred` **(** :ref:`String` property, :ref:`Variant` value **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_indexed` **(** :ref:`NodePath` property, :ref:`Variant` value **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script` **(** :ref:`Reference` script **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Object_script_changed: +.. _class_Object_signal_script_changed: - **script_changed** **(** **)** @@ -121,6 +121,14 @@ Enumerations .. _enum_Object_ConnectFlags: +.. _class_Object_constant_CONNECT_DEFERRED: + +.. _class_Object_constant_CONNECT_PERSIST: + +.. _class_Object_constant_CONNECT_ONESHOT: + +.. _class_Object_constant_CONNECT_REFERENCE_COUNTED: + enum **ConnectFlags**: - **CONNECT_DEFERRED** = **1** --- Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time. @@ -134,6 +142,10 @@ enum **ConnectFlags**: Constants --------- +.. _class_Object_constant_NOTIFICATION_POSTINITIALIZE: + +.. _class_Object_constant_NOTIFICATION_PREDELETE: + - **NOTIFICATION_POSTINITIALIZE** = **0** --- Called right when the object is initialized. Not available in script. - **NOTIFICATION_PREDELETE** = **1** --- Called before the object is about to be deleted. @@ -145,114 +157,114 @@ Base class for all non built-in types. Everything which is not a built-in type s Objects can be constructed from scripting languages, using ``Object.new()`` in GDScript, ``new Object`` in C#, or the "Construct Object" node in VisualScript. -Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the :ref:`free` function from the script or delete from C++). +Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the :ref:`free` function from the script or delete from C++). Some derivatives add memory management, such as :ref:`Reference` (which keeps a reference count and deletes itself automatically when no longer referenced) and :ref:`Node`, which deletes the children tree when deleted. -Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in :ref:`_get_property_list` and handled in :ref:`_get` and :ref:`_set`. However, scripting languages and C++ have simpler means to export them. +Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in :ref:`_get_property_list` and handled in :ref:`_get` and :ref:`_set`. However, scripting languages and C++ have simpler means to export them. -Objects also receive notifications (:ref:`_notification`). Notifications are a simple way to notify the object about simple events, so they can all be handled together. +Objects also receive notifications (:ref:`_notification`). Notifications are a simple way to notify the object about simple events, so they can all be handled together. Method Descriptions ------------------- -.. _class_Object__get: +.. _class_Object_method__get: - :ref:`Variant` **_get** **(** :ref:`String` property **)** virtual Returns the given property. Returns ``null`` if the ``property`` does not exist. -.. _class_Object__get_property_list: +.. _class_Object_method__get_property_list: - :ref:`Array` **_get_property_list** **(** **)** virtual Returns the object's property list as an :ref:`Array` of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE\_\* enum in :ref:`@GlobalScope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@GlobalScope`). -.. _class_Object__init: +.. _class_Object_method__init: - void **_init** **(** **)** virtual The virtual method called upon initialization. -.. _class_Object__notification: +.. _class_Object_method__notification: - void **_notification** **(** :ref:`int` what **)** virtual Notify the object internally using an ID. -.. _class_Object__set: +.. _class_Object_method__set: - :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual Sets a property. Returns ``true`` if the ``property`` exists. -.. _class_Object_add_user_signal: +.. _class_Object_method_add_user_signal: - void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** Adds a user-defined ``signal``. Arguments are optional, but can be added as an :ref:`Array` of dictionaries, each containing "name" and "type" (from :ref:`@GlobalScope` TYPE\_\*). -.. _class_Object_call: +.. _class_Object_method_call: - :ref:`Variant` **call** **(** :ref:`String` method **)** vararg Calls the ``method`` on the object and returns a result. Pass parameters as a comma separated list. -.. _class_Object_call_deferred: +.. _class_Object_method_call_deferred: - :ref:`Variant` **call_deferred** **(** :ref:`String` method **)** vararg Calls the ``method`` on the object during idle time and returns a result. Pass parameters as a comma separated list. -.. _class_Object_callv: +.. _class_Object_method_callv: - :ref:`Variant` **callv** **(** :ref:`String` method, :ref:`Array` arg_array **)** Calls the ``method`` on the object and returns a result. Pass parameters as an :ref:`Array`. -.. _class_Object_can_translate_messages: +.. _class_Object_method_can_translate_messages: - :ref:`bool` **can_translate_messages** **(** **)** const Returns ``true`` if the object can translate strings. -.. _class_Object_connect: +.. _class_Object_method_connect: - :ref:`Error` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** -Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call. Use ``flags`` to set deferred or one shot connections. See ``CONNECT_*`` constants. A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected. To avoid this, first use :ref:`is_connected` to check for existing connections. +Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call. Use ``flags`` to set deferred or one shot connections. See ``CONNECT_*`` constants. A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected. To avoid this, first use :ref:`is_connected` to check for existing connections. -.. _class_Object_disconnect: +.. _class_Object_method_disconnect: - void **disconnect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** Disconnects a ``signal`` from a ``method`` on the given ``target``. -.. _class_Object_emit_signal: +.. _class_Object_method_emit_signal: - :ref:`Variant` **emit_signal** **(** :ref:`String` signal **)** vararg Emits the given ``signal``. -.. _class_Object_free: +.. _class_Object_method_free: - void **free** **(** **)** Deletes the object from memory. -.. _class_Object_get: +.. _class_Object_method_get: - :ref:`Variant` **get** **(** :ref:`String` property **)** const Returns a :ref:`Variant` for a ``property``. -.. _class_Object_get_class: +.. _class_Object_method_get_class: - :ref:`String` **get_class** **(** **)** const Returns the object's class as a :ref:`String`. -.. _class_Object_get_incoming_connections: +.. _class_Object_method_get_incoming_connections: - :ref:`Array` **get_incoming_connections** **(** **)** const @@ -266,7 +278,7 @@ Inside each :ref:`Dictionary` there are 3 fields: - "method_name" is a name of method to which signal is connected. -.. _class_Object_get_indexed: +.. _class_Object_method_get_indexed: - :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** const @@ -274,147 +286,147 @@ Get indexed object property by String. Property indices get accessed with colon separation, for example: ``position:x`` -.. _class_Object_get_instance_id: +.. _class_Object_method_get_instance_id: - :ref:`int` **get_instance_id** **(** **)** const Returns the object's unique instance ID. -.. _class_Object_get_meta: +.. _class_Object_method_get_meta: - :ref:`Variant` **get_meta** **(** :ref:`String` name **)** const Returns the object's metadata for the given ``name``. -.. _class_Object_get_meta_list: +.. _class_Object_method_get_meta_list: - :ref:`PoolStringArray` **get_meta_list** **(** **)** const Returns the object's metadata as a :ref:`PoolStringArray`. -.. _class_Object_get_method_list: +.. _class_Object_method_get_method_list: - :ref:`Array` **get_method_list** **(** **)** const Returns the object's methods and their signatures as an :ref:`Array`. -.. _class_Object_get_property_list: +.. _class_Object_method_get_property_list: - :ref:`Array` **get_property_list** **(** **)** const Returns the list of properties as an :ref:`Array` of dictionaries. Dictionaries contain: name:String, type:int (see TYPE\_\* enum in :ref:`@GlobalScope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@GlobalScope`). -.. _class_Object_get_script: +.. _class_Object_method_get_script: - :ref:`Reference` **get_script** **(** **)** const Returns the object's :ref:`Script` or ``null`` if one doesn't exist. -.. _class_Object_get_signal_connection_list: +.. _class_Object_method_get_signal_connection_list: - :ref:`Array` **get_signal_connection_list** **(** :ref:`String` signal **)** const Returns an :ref:`Array` of connections for the given ``signal``. -.. _class_Object_get_signal_list: +.. _class_Object_method_get_signal_list: - :ref:`Array` **get_signal_list** **(** **)** const Returns the list of signals as an :ref:`Array` of dictionaries. -.. _class_Object_has_meta: +.. _class_Object_method_has_meta: - :ref:`bool` **has_meta** **(** :ref:`String` name **)** const Returns ``true`` if a metadata is found with the given ``name``. -.. _class_Object_has_method: +.. _class_Object_method_has_method: - :ref:`bool` **has_method** **(** :ref:`String` method **)** const Returns ``true`` if the object contains the given ``method``. -.. _class_Object_has_user_signal: +.. _class_Object_method_has_user_signal: - :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** const Returns ``true`` if the given user-defined ``signal`` exists. -.. _class_Object_is_blocking_signals: +.. _class_Object_method_is_blocking_signals: - :ref:`bool` **is_blocking_signals** **(** **)** const Returns ``true`` if signal emission blocking is enabled. -.. _class_Object_is_class: +.. _class_Object_method_is_class: - :ref:`bool` **is_class** **(** :ref:`String` type **)** const Returns ``true`` if the object inherits from the given ``type``. -.. _class_Object_is_connected: +.. _class_Object_method_is_connected: - :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``. -.. _class_Object_is_queued_for_deletion: +.. _class_Object_method_is_queued_for_deletion: - :ref:`bool` **is_queued_for_deletion** **(** **)** const Returns ``true`` if the ``queue_free`` method was called for the object. -.. _class_Object_notification: +.. _class_Object_method_notification: - void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** Notify the object of something. -.. _class_Object_property_list_changed_notify: +.. _class_Object_method_property_list_changed_notify: - void **property_list_changed_notify** **(** **)** -.. _class_Object_set: +.. _class_Object_method_set: - void **set** **(** :ref:`String` property, :ref:`Variant` value **)** Set property into the object. -.. _class_Object_set_block_signals: +.. _class_Object_method_set_block_signals: - void **set_block_signals** **(** :ref:`bool` enable **)** If set to true, signal emission is blocked. -.. _class_Object_set_deferred: +.. _class_Object_method_set_deferred: - void **set_deferred** **(** :ref:`String` property, :ref:`Variant` value **)** -.. _class_Object_set_indexed: +.. _class_Object_method_set_indexed: - void **set_indexed** **(** :ref:`NodePath` property, :ref:`Variant` value **)** -.. _class_Object_set_message_translation: +.. _class_Object_method_set_message_translation: - void **set_message_translation** **(** :ref:`bool` enable **)** -Define whether the object can translate strings (with calls to :ref:`tr`). Default is true. +Define whether the object can translate strings (with calls to :ref:`tr`). Default is true. -.. _class_Object_set_meta: +.. _class_Object_method_set_meta: - void **set_meta** **(** :ref:`String` name, :ref:`Variant` value **)** Set a metadata into the object. Metadata is serialized. Metadata can be *anything*. -.. _class_Object_set_script: +.. _class_Object_method_set_script: - void **set_script** **(** :ref:`Reference` script **)** Set a script into the object, scripts extend the object functionality. -.. _class_Object_tr: +.. _class_Object_method_tr: - :ref:`String` **tr** **(** :ref:`String` message **)** const -Translate a message. Only works if message translation is enabled (which it is by default). See :ref:`set_message_translation`. +Translate a message. Only works if message translation is enabled (which it is by default). See :ref:`set_message_translation`. diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 1e89a57e5..6181d28a6 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -19,26 +19,32 @@ Defines a 2D polygon for LightOccluder2D. Properties ---------- -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`closed` | -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`CullMode` | :ref:`cull_mode` | -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+--------------------------------------------------+-----------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`bool` | :ref:`closed` | ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`CullMode` | :ref:`cull_mode` | ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | ++--------------------------------------------------+--------------------------------------------------------------+ Enumerations ------------ .. _enum_OccluderPolygon2D_CullMode: +.. _class_OccluderPolygon2D_constant_CULL_DISABLED: + +.. _class_OccluderPolygon2D_constant_CULL_CLOCKWISE: + +.. _class_OccluderPolygon2D_constant_CULL_COUNTER_CLOCKWISE: + enum **CullMode**: -- **CULL_DISABLED** = **0** --- Culling mode for the occlusion. Disabled means no culling. See :ref:`cull_mode`. +- **CULL_DISABLED** = **0** --- Culling mode for the occlusion. Disabled means no culling. See :ref:`cull_mode`. -- **CULL_CLOCKWISE** = **1** --- Culling mode for the occlusion. Sets the culling to be in clockwise direction. See :ref:`cull_mode`. +- **CULL_CLOCKWISE** = **1** --- Culling mode for the occlusion. Sets the culling to be in clockwise direction. See :ref:`cull_mode`. -- **CULL_COUNTER_CLOCKWISE** = **2** --- Culling mode for the occlusion. Sets the culling to be in counter clockwise direction. See :ref:`cull_mode`. +- **CULL_COUNTER_CLOCKWISE** = **2** --- Culling mode for the occlusion. Sets the culling to be in counter clockwise direction. See :ref:`cull_mode`. Description ----------- @@ -48,7 +54,7 @@ Editor facility that helps you draw a 2D polygon used as resource for :ref:`Ligh Property Descriptions --------------------- -.. _class_OccluderPolygon2D_closed: +.. _class_OccluderPolygon2D_property_closed: - :ref:`bool` **closed** @@ -60,7 +66,7 @@ Property Descriptions If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value ``true``. -.. _class_OccluderPolygon2D_cull_mode: +.. _class_OccluderPolygon2D_property_cull_mode: - :ref:`CullMode` **cull_mode** @@ -72,7 +78,7 @@ If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light c Set the direction of the occlusion culling when not ``CULL_DISABLED``. Default value ``DISABLED``. -.. _class_OccluderPolygon2D_polygon: +.. _class_OccluderPolygon2D_property_polygon: - :ref:`PoolVector2Array` **polygon** diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 427d29261..2ab5e6b36 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -19,21 +19,25 @@ Omnidirectional light, such as a light bulb or a candle. Properties ---------- -+--------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`omni_attenuation` | -+--------------------------------------------------+---------------------------------------------------------------+ -| :ref:`float` | :ref:`omni_range` | -+--------------------------------------------------+---------------------------------------------------------------+ -| :ref:`ShadowDetail` | :ref:`omni_shadow_detail` | -+--------------------------------------------------+---------------------------------------------------------------+ -| :ref:`ShadowMode` | :ref:`omni_shadow_mode` | -+--------------------------------------------------+---------------------------------------------------------------+ ++--------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`omni_attenuation` | ++--------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`omni_range` | ++--------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`ShadowDetail` | :ref:`omni_shadow_detail` | ++--------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`ShadowMode` | :ref:`omni_shadow_mode` | ++--------------------------------------------------+------------------------------------------------------------------------+ Enumerations ------------ .. _enum_OmniLight_ShadowMode: +.. _class_OmniLight_constant_SHADOW_DUAL_PARABOLOID: + +.. _class_OmniLight_constant_SHADOW_CUBE: + enum **ShadowMode**: - **SHADOW_DUAL_PARABOLOID** = **0** @@ -42,6 +46,10 @@ enum **ShadowMode**: .. _enum_OmniLight_ShadowDetail: +.. _class_OmniLight_constant_SHADOW_DETAIL_VERTICAL: + +.. _class_OmniLight_constant_SHADOW_DETAIL_HORIZONTAL: + enum **ShadowDetail**: - **SHADOW_DETAIL_VERTICAL** = **0** @@ -61,7 +69,7 @@ Tutorials Property Descriptions --------------------- -.. _class_OmniLight_omni_attenuation: +.. _class_OmniLight_property_omni_attenuation: - :ref:`float` **omni_attenuation** @@ -73,7 +81,7 @@ Property Descriptions The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. -.. _class_OmniLight_omni_range: +.. _class_OmniLight_property_omni_range: - :ref:`float` **omni_range** @@ -85,7 +93,7 @@ The light's attenuation (drop-off) curve. A number of presets are available in t Maximum distance the light affects. -.. _class_OmniLight_omni_shadow_detail: +.. _class_OmniLight_property_omni_shadow_detail: - :ref:`ShadowDetail` **omni_shadow_detail** @@ -95,9 +103,9 @@ Maximum distance the light affects. | *Getter* | get_shadow_detail() | +----------+--------------------------+ -See :ref:`ShadowDetail`. +See :ref:`ShadowDetail`. -.. _class_OmniLight_omni_shadow_mode: +.. _class_OmniLight_property_omni_shadow_mode: - :ref:`ShadowMode` **omni_shadow_mode** @@ -107,5 +115,5 @@ See :ref:`ShadowDetail`. | *Getter* | get_shadow_mode() | +----------+------------------------+ -See :ref:`ShadowMode`. +See :ref:`ShadowMode`. diff --git a/classes/class_opensimplexnoise.rst b/classes/class_opensimplexnoise.rst index eebb8d87e..39ecb0afd 100644 --- a/classes/class_opensimplexnoise.rst +++ b/classes/class_opensimplexnoise.rst @@ -19,36 +19,36 @@ Noise generator based on Open Simplex. Properties ---------- -+---------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`lacunarity` | -+---------------------------+--------------------------------------------------------+ -| :ref:`int` | :ref:`octaves` | -+---------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`period` | -+---------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`persistence` | -+---------------------------+--------------------------------------------------------+ -| :ref:`int` | :ref:`seed` | -+---------------------------+--------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`lacunarity` | ++---------------------------+-----------------------------------------------------------------+ +| :ref:`int` | :ref:`octaves` | ++---------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`period` | ++---------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`persistence` | ++---------------------------+-----------------------------------------------------------------+ +| :ref:`int` | :ref:`seed` | ++---------------------------+-----------------------------------------------------------------+ Methods ------- -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_image` **(** :ref:`int` width, :ref:`int` height **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_noise_2d` **(** :ref:`float` x, :ref:`float` y **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_noise_2dv` **(** :ref:`Vector2` pos **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_noise_3d` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_noise_3dv` **(** :ref:`Vector3` pos **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_noise_4d` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_seamless_image` **(** :ref:`int` size **)** | -+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_image` **(** :ref:`int` width, :ref:`int` height **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_noise_2d` **(** :ref:`float` x, :ref:`float` y **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_noise_2dv` **(** :ref:`Vector2` pos **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_noise_3d` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_noise_3dv` **(** :ref:`Vector3` pos **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_noise_4d` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_seamless_image` **(** :ref:`int` size **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -74,7 +74,7 @@ This resource allows you to configure and sample a fractal noise space. Here is Property Descriptions --------------------- -.. _class_OpenSimplexNoise_lacunarity: +.. _class_OpenSimplexNoise_property_lacunarity: - :ref:`float` **lacunarity** @@ -84,9 +84,9 @@ Property Descriptions | *Getter* | get_lacunarity() | +----------+-----------------------+ -Difference in period between :ref:`octaves`. +Difference in period between :ref:`octaves`. -.. _class_OpenSimplexNoise_octaves: +.. _class_OpenSimplexNoise_property_octaves: - :ref:`int` **octaves** @@ -98,7 +98,7 @@ Difference in period between :ref:`octaves`. Number of OpenSimplex noise layers that are sampled to get the fractal noise. -.. _class_OpenSimplexNoise_period: +.. _class_OpenSimplexNoise_property_period: - :ref:`float` **period** @@ -110,7 +110,7 @@ Number of OpenSimplex noise layers that are sampled to get the fractal noise. Period of the base octave. A lower period results in a higher-frequency noise (more value changes across the same distance). -.. _class_OpenSimplexNoise_persistence: +.. _class_OpenSimplexNoise_property_persistence: - :ref:`float` **persistence** @@ -122,7 +122,7 @@ Period of the base octave. A lower period results in a higher-frequency noise (m Contribution factor of the different octaves. A ``persistence`` value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one. -.. _class_OpenSimplexNoise_seed: +.. _class_OpenSimplexNoise_property_seed: - :ref:`int` **seed** @@ -137,43 +137,43 @@ Seed used to generate random values, different seeds will generate different noi Method Descriptions ------------------- -.. _class_OpenSimplexNoise_get_image: +.. _class_OpenSimplexNoise_method_get_image: - :ref:`Image` **get_image** **(** :ref:`int` width, :ref:`int` height **)** Generate a noise image with the requested ``width`` and ``height``, based on the current noise parameters. -.. _class_OpenSimplexNoise_get_noise_2d: +.. _class_OpenSimplexNoise_method_get_noise_2d: - :ref:`float` **get_noise_2d** **(** :ref:`float` x, :ref:`float` y **)** Returns the 2D noise value ``[-1,1]`` at the given position. -.. _class_OpenSimplexNoise_get_noise_2dv: +.. _class_OpenSimplexNoise_method_get_noise_2dv: - :ref:`float` **get_noise_2dv** **(** :ref:`Vector2` pos **)** Returns the 2D noise value ``[-1,1]`` at the given position. -.. _class_OpenSimplexNoise_get_noise_3d: +.. _class_OpenSimplexNoise_method_get_noise_3d: - :ref:`float` **get_noise_3d** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** Returns the 3D noise value ``[-1,1]`` at the given position. -.. _class_OpenSimplexNoise_get_noise_3dv: +.. _class_OpenSimplexNoise_method_get_noise_3dv: - :ref:`float` **get_noise_3dv** **(** :ref:`Vector3` pos **)** Returns the 3D noise value ``[-1,1]`` at the given position. -.. _class_OpenSimplexNoise_get_noise_4d: +.. _class_OpenSimplexNoise_method_get_noise_4d: - :ref:`float` **get_noise_4d** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** Returns the 4D noise value ``[-1,1]`` at the given position. -.. _class_OpenSimplexNoise_get_seamless_image: +.. _class_OpenSimplexNoise_method_get_seamless_image: - :ref:`Image` **get_seamless_image** **(** :ref:`int` size **)** diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 3e1b7ebb3..91fc0cad5 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -19,96 +19,96 @@ Button control that provides selectable options when pressed. Properties ---------- -+-----------------------+----------------------------------------------+ -| :ref:`int` | :ref:`selected` | -+-----------------------+----------------------------------------------+ ++-----------------------+-------------------------------------------------------+ +| :ref:`int` | :ref:`selected` | ++-----------------------+-------------------------------------------------------+ Methods ------- -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_id` **(** :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:`PopupMenu` | :ref:`get_popup` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected_id` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` idx **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` texture **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_separator` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_id` **(** :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:`PopupMenu` | :ref:`get_popup` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selected_id` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` idx **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` texture **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`arrow` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`arrow_margin` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`disabled` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_pressed` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`pressed` | -+---------------------------------+--------------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`Texture` | arrow | ++---------------------------------+---------------------+ +| :ref:`int` | arrow_margin | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | disabled | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+---------------------+ +| :ref:`Font` | font | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_hover | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_pressed | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | hover | ++---------------------------------+---------------------+ +| :ref:`int` | hseparation | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | pressed | ++---------------------------------+---------------------+ Signals ------- -.. _class_OptionButton_item_focused: +.. _class_OptionButton_signal_item_focused: - **item_focused** **(** :ref:`int` ID **)** This signal is emitted when user navigated to an item using ``ui_up`` or ``ui_down`` action. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). -.. _class_OptionButton_item_selected: +.. _class_OptionButton_signal_item_selected: - **item_selected** **(** :ref:`int` ID **)** @@ -122,7 +122,7 @@ OptionButton is a type button that provides a selectable list of items when pres Property Descriptions --------------------- -.. _class_OptionButton_selected: +.. _class_OptionButton_property_selected: - :ref:`int` **selected** @@ -133,107 +133,107 @@ Property Descriptions Method Descriptions ------------------- -.. _class_OptionButton_add_icon_item: +.. _class_OptionButton_method_add_icon_item: - void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. -.. _class_OptionButton_add_item: +.. _class_OptionButton_method_add_item: - void **add_item** **(** :ref:`String` label, :ref:`int` id=-1 **)** Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. -.. _class_OptionButton_add_separator: +.. _class_OptionButton_method_add_separator: - void **add_separator** **(** **)** Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. -.. _class_OptionButton_clear: +.. _class_OptionButton_method_clear: - void **clear** **(** **)** Clear all the items in the ``OptionButton``. -.. _class_OptionButton_get_item_count: +.. _class_OptionButton_method_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Return the amount of items in the OptionButton. -.. _class_OptionButton_get_item_icon: +.. _class_OptionButton_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". -.. _class_OptionButton_get_item_id: +.. _class_OptionButton_method_get_item_id: - :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const Return the ID of the item at index "idx". -.. _class_OptionButton_get_item_metadata: +.. _class_OptionButton_method_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const -.. _class_OptionButton_get_item_text: +.. _class_OptionButton_method_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text of the item at index "idx". -.. _class_OptionButton_get_popup: +.. _class_OptionButton_method_get_popup: - :ref:`PopupMenu` **get_popup** **(** **)** const Return the :ref:`PopupMenu` contained in this button. -.. _class_OptionButton_get_selected_id: +.. _class_OptionButton_method_get_selected_id: - :ref:`int` **get_selected_id** **(** **)** const -.. _class_OptionButton_get_selected_metadata: +.. _class_OptionButton_method_get_selected_metadata: - :ref:`Variant` **get_selected_metadata** **(** **)** const -.. _class_OptionButton_is_item_disabled: +.. _class_OptionButton_method_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const -.. _class_OptionButton_remove_item: +.. _class_OptionButton_method_remove_item: - void **remove_item** **(** :ref:`int` idx **)** -.. _class_OptionButton_select: +.. _class_OptionButton_method_select: - void **select** **(** :ref:`int` idx **)** Select an item by index and make it the current item. -.. _class_OptionButton_set_item_disabled: +.. _class_OptionButton_method_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** -.. _class_OptionButton_set_item_icon: +.. _class_OptionButton_method_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` texture **)** Set the icon of an item at index "idx". -.. _class_OptionButton_set_item_id: +.. _class_OptionButton_method_set_item_id: - void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** Set the ID of an item at index "idx". -.. _class_OptionButton_set_item_metadata: +.. _class_OptionButton_method_set_item_metadata: - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** -.. _class_OptionButton_set_item_text: +.. _class_OptionButton_method_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** diff --git a/classes/class_orientedpathfollow.rst b/classes/class_orientedpathfollow.rst index 3a9b4ff46..6899046ea 100644 --- a/classes/class_orientedpathfollow.rst +++ b/classes/class_orientedpathfollow.rst @@ -19,19 +19,19 @@ Oriented point sampler for a :ref:`Path`. Properties ---------- -+---------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`cubic_interp` | -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`h_offset` | -+---------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`loop` | -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`offset` | -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`unit_offset` | -+---------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`v_offset` | -+---------------------------+------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cubic_interp` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`h_offset` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`loop` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`offset` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`unit_offset` | ++---------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`v_offset` | ++---------------------------+---------------------------------------------------------------------+ Description ----------- @@ -43,7 +43,7 @@ Make sure to check if the curve of this node's parent :ref:`Path` ha Property Descriptions --------------------- -.. _class_OrientedPathFollow_cubic_interp: +.. _class_OrientedPathFollow_property_cubic_interp: - :ref:`bool` **cubic_interp** @@ -59,7 +59,7 @@ The points along the :ref:`Curve3D` of the :ref:`Path There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. -.. _class_OrientedPathFollow_h_offset: +.. _class_OrientedPathFollow_property_h_offset: - :ref:`float` **h_offset** @@ -71,7 +71,7 @@ There are two answers to this problem: Either increase the number of cached poin The node's offset along the curve. -.. _class_OrientedPathFollow_loop: +.. _class_OrientedPathFollow_property_loop: - :ref:`bool` **loop** @@ -83,7 +83,7 @@ The node's offset along the curve. If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. -.. _class_OrientedPathFollow_offset: +.. _class_OrientedPathFollow_property_offset: - :ref:`float` **offset** @@ -95,7 +95,7 @@ If ``true``, any offset outside the path's length will wrap around, instead of s The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. -.. _class_OrientedPathFollow_unit_offset: +.. _class_OrientedPathFollow_property_unit_offset: - :ref:`float` **unit_offset** @@ -107,7 +107,7 @@ The distance from the first vertex, measured in 3D units along the path. This se The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. -.. _class_OrientedPathFollow_v_offset: +.. _class_OrientedPathFollow_property_v_offset: - :ref:`float` **v_offset** diff --git a/classes/class_os.rst b/classes/class_os.rst index 576663efb..3e8ab4064 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -19,226 +19,240 @@ Operating System functions. Properties ---------- -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`clipboard` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`current_screen` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`exit_code` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`keep_screen_on` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`low_processor_usage_mode` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| _OS.ScreenOrientation | :ref:`screen_orientation` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`vsync_enabled` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_borderless` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_fullscreen` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_maximized` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_minimized` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_per_pixel_transparency_enabled` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`window_position` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_resizable` | -+-------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`window_size` | -+-------------------------------+----------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`clipboard` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`current_screen` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`exit_code` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`keep_screen_on` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`low_processor_usage_mode` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| _OS.ScreenOrientation | :ref:`screen_orientation` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`vsync_enabled` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_borderless` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_fullscreen` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_maximized` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_minimized` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_per_pixel_transparency_enabled` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`window_position` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_resizable` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`window_size` | ++-------------------------------+-------------------------------------------------------------------------------------------------------+ Methods ------- -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_draw` **(** **)** 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_usec` **(** :ref:`int` usec **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_audio_driver_count` **(** **)** 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:`Dictionary` | :ref:`get_date` **(** :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:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_executable_path` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_ime_selection` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_ime_text` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_model_name` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_power_percent_left` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_power_seconds_left` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PowerState` | :ref:`get_power_state` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_id` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_processor_count` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_count` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_position` **(** :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_static_memory_peak_usage` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** 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_secs` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_usec` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_unique_id` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_video_driver_count` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`int` driver **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide_virtual_keyboard` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debug_build` **(** **)** 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_stdout_verbose` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** const | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`kill` **(** :ref:`int` pid **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_window_to_foreground` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_pause` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_stop` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_unpause` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_midi_inputs` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_textures_by_size` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_attention` **(** **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ime_active` **(** :ref:`bool` active **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_always_on_top` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_title` **(** :ref:`String` title **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_draw` **(** **)** 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_usec` **(** :ref:`int` usec **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_audio_driver_count` **(** **)** 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:`Dictionary` | :ref:`get_date` **(** :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:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_executable_path` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_ime_selection` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_ime_text` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_model_name` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_percent_left` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_power_seconds_left` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PowerState` | :ref:`get_power_state` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_id` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_processor_count` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_count` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_position` **(** :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_static_memory_peak_usage` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** 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_secs` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks_usec` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_unique_id` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_video_driver_count` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`int` driver **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide_virtual_keyboard` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debug_build` **(** **)** 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_stdout_verbose` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** const | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`kill` **(** :ref:`int` pid **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_window_to_foreground` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_pause` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_stop` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_unpause` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`open_midi_inputs` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_textures_by_size` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_attention` **(** **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ime_active` **(** :ref:`bool` active **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_always_on_top` **(** :ref:`bool` enabled **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_title` **(** :ref:`String` title **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | ++-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_OS_Weekday: +.. _class_OS_constant_DAY_SUNDAY: + +.. _class_OS_constant_DAY_MONDAY: + +.. _class_OS_constant_DAY_TUESDAY: + +.. _class_OS_constant_DAY_WEDNESDAY: + +.. _class_OS_constant_DAY_THURSDAY: + +.. _class_OS_constant_DAY_FRIDAY: + +.. _class_OS_constant_DAY_SATURDAY: + enum **Weekday**: - **DAY_SUNDAY** = **0** --- Sunday. @@ -257,6 +271,30 @@ enum **Weekday**: .. _enum_OS_Month: +.. _class_OS_constant_MONTH_JANUARY: + +.. _class_OS_constant_MONTH_FEBRUARY: + +.. _class_OS_constant_MONTH_MARCH: + +.. _class_OS_constant_MONTH_APRIL: + +.. _class_OS_constant_MONTH_MAY: + +.. _class_OS_constant_MONTH_JUNE: + +.. _class_OS_constant_MONTH_JULY: + +.. _class_OS_constant_MONTH_AUGUST: + +.. _class_OS_constant_MONTH_SEPTEMBER: + +.. _class_OS_constant_MONTH_OCTOBER: + +.. _class_OS_constant_MONTH_NOVEMBER: + +.. _class_OS_constant_MONTH_DECEMBER: + enum **Month**: - **MONTH_JANUARY** = **1** --- January. @@ -285,6 +323,20 @@ enum **Month**: .. _enum_OS_ScreenOrientation: +.. _class_OS_constant_SCREEN_ORIENTATION_LANDSCAPE: + +.. _class_OS_constant_SCREEN_ORIENTATION_PORTRAIT: + +.. _class_OS_constant_SCREEN_ORIENTATION_REVERSE_LANDSCAPE: + +.. _class_OS_constant_SCREEN_ORIENTATION_REVERSE_PORTRAIT: + +.. _class_OS_constant_SCREEN_ORIENTATION_SENSOR_LANDSCAPE: + +.. _class_OS_constant_SCREEN_ORIENTATION_SENSOR_PORTRAIT: + +.. _class_OS_constant_SCREEN_ORIENTATION_SENSOR: + enum **ScreenOrientation**: - **SCREEN_ORIENTATION_LANDSCAPE** = **0** --- Landscape screen orientation. @@ -303,6 +355,22 @@ enum **ScreenOrientation**: .. _enum_OS_SystemDir: +.. _class_OS_constant_SYSTEM_DIR_DESKTOP: + +.. _class_OS_constant_SYSTEM_DIR_DCIM: + +.. _class_OS_constant_SYSTEM_DIR_DOCUMENTS: + +.. _class_OS_constant_SYSTEM_DIR_DOWNLOADS: + +.. _class_OS_constant_SYSTEM_DIR_MOVIES: + +.. _class_OS_constant_SYSTEM_DIR_MUSIC: + +.. _class_OS_constant_SYSTEM_DIR_PICTURES: + +.. _class_OS_constant_SYSTEM_DIR_RINGTONES: + enum **SystemDir**: - **SYSTEM_DIR_DESKTOP** = **0** --- Desktop directory path. @@ -323,6 +391,16 @@ enum **SystemDir**: .. _enum_OS_PowerState: +.. _class_OS_constant_POWERSTATE_UNKNOWN: + +.. _class_OS_constant_POWERSTATE_ON_BATTERY: + +.. _class_OS_constant_POWERSTATE_NO_BATTERY: + +.. _class_OS_constant_POWERSTATE_CHARGING: + +.. _class_OS_constant_POWERSTATE_CHARGED: + enum **PowerState**: - **POWERSTATE_UNKNOWN** = **0** --- Unknown powerstate. @@ -343,7 +421,7 @@ Operating System functions. OS Wraps the most common functionality to communicat Property Descriptions --------------------- -.. _class_OS_clipboard: +.. _class_OS_property_clipboard: - :ref:`String` **clipboard** @@ -355,7 +433,7 @@ Property Descriptions The clipboard from the host OS. Might be unavailable on some platforms. -.. _class_OS_current_screen: +.. _class_OS_property_current_screen: - :ref:`int` **current_screen** @@ -367,7 +445,7 @@ The clipboard from the host OS. Might be unavailable on some platforms. The current screen index (starting from 0). -.. _class_OS_exit_code: +.. _class_OS_property_exit_code: - :ref:`int` **exit_code** @@ -379,7 +457,7 @@ The current screen index (starting from 0). The exit code passed to the OS when the main loop exits. -.. _class_OS_keep_screen_on: +.. _class_OS_property_keep_screen_on: - :ref:`bool` **keep_screen_on** @@ -391,7 +469,7 @@ The exit code passed to the OS when the main loop exits. If ``true``, the engine tries to keep the screen on while the game is running. Useful on mobile. -.. _class_OS_low_processor_usage_mode: +.. _class_OS_property_low_processor_usage_mode: - :ref:`bool` **low_processor_usage_mode** @@ -403,7 +481,7 @@ If ``true``, the engine tries to keep the screen on while the game is running. U If ``true``, the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. -.. _class_OS_screen_orientation: +.. _class_OS_property_screen_orientation: - _OS.ScreenOrientation **screen_orientation** @@ -415,7 +493,7 @@ If ``true``, the engine optimizes for low processor usage by only refreshing the The current screen orientation. -.. _class_OS_vsync_enabled: +.. _class_OS_property_vsync_enabled: - :ref:`bool` **vsync_enabled** @@ -427,7 +505,7 @@ The current screen orientation. If ``true``, vertical synchronization (Vsync) is enabled. -.. _class_OS_window_borderless: +.. _class_OS_property_window_borderless: - :ref:`bool` **window_borderless** @@ -439,7 +517,7 @@ If ``true``, vertical synchronization (Vsync) is enabled. If ``true``, removes the window frame. -.. _class_OS_window_fullscreen: +.. _class_OS_property_window_fullscreen: - :ref:`bool` **window_fullscreen** @@ -451,7 +529,7 @@ If ``true``, removes the window frame. If ``true``, the window is fullscreen. -.. _class_OS_window_maximized: +.. _class_OS_property_window_maximized: - :ref:`bool` **window_maximized** @@ -463,7 +541,7 @@ If ``true``, the window is fullscreen. If ``true``, the window is maximized. -.. _class_OS_window_minimized: +.. _class_OS_property_window_minimized: - :ref:`bool` **window_minimized** @@ -475,7 +553,7 @@ If ``true``, the window is maximized. If ``true``, the window is minimized. -.. _class_OS_window_per_pixel_transparency_enabled: +.. _class_OS_property_window_per_pixel_transparency_enabled: - :ref:`bool` **window_per_pixel_transparency_enabled** @@ -485,7 +563,7 @@ If ``true``, the window is minimized. | *Getter* | get_window_per_pixel_transparency_enabled() | +----------+--------------------------------------------------+ -.. _class_OS_window_position: +.. _class_OS_property_window_position: - :ref:`Vector2` **window_position** @@ -497,7 +575,7 @@ If ``true``, the window is minimized. The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. -.. _class_OS_window_resizable: +.. _class_OS_property_window_resizable: - :ref:`bool` **window_resizable** @@ -509,7 +587,7 @@ The window position relative to the screen, the origin is the top left corner, + If ``true``, the window is resizable by the user. -.. _class_OS_window_size: +.. _class_OS_property_window_size: - :ref:`Vector2` **window_size** @@ -524,47 +602,47 @@ The size of the window (without counting window manager decorations). Method Descriptions ------------------- -.. _class_OS_alert: +.. _class_OS_method_alert: - void **alert** **(** :ref:`String` text, :ref:`String` title="Alert!" **)** Displays a modal dialog box utilizing the host OS. -.. _class_OS_can_draw: +.. _class_OS_method_can_draw: - :ref:`bool` **can_draw** **(** **)** const Returns ``true`` if the host OS allows drawing. -.. _class_OS_can_use_threads: +.. _class_OS_method_can_use_threads: - :ref:`bool` **can_use_threads** **(** **)** const Returns ``true`` if the current host platform is using multiple threads. -.. _class_OS_center_window: +.. _class_OS_method_center_window: - void **center_window** **(** **)** Centers the window on the screen if in windowed mode. -.. _class_OS_close_midi_inputs: +.. _class_OS_method_close_midi_inputs: - void **close_midi_inputs** **(** **)** -.. _class_OS_delay_msec: +.. _class_OS_method_delay_msec: - void **delay_msec** **(** :ref:`int` msec **)** const Delay execution of the current thread by given milliseconds. -.. _class_OS_delay_usec: +.. _class_OS_method_delay_usec: - void **delay_usec** **(** :ref:`int` usec **)** const Delay execution of the current thread by given microseconds. -.. _class_OS_dump_memory_to_file: +.. _class_OS_method_dump_memory_to_file: - void **dump_memory_to_file** **(** :ref:`String` file **)** @@ -572,7 +650,7 @@ Dumps the memory allocation ringlist to a file (only works in debug). Entry format per line: "Address - Size - Description". -.. _class_OS_dump_resources_to_file: +.. _class_OS_method_dump_resources_to_file: - void **dump_resources_to_file** **(** :ref:`String` file **)** @@ -582,7 +660,7 @@ Entry format per line: "Resource Type : Resource Location". At the end of the file is a statistic of all used Resource Types. -.. _class_OS_execute: +.. _class_OS_method_execute: - :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** @@ -596,7 +674,7 @@ When ``blocking`` is enabled, the Godot thread will pause its execution while wa When ``blocking`` is disabled, the Godot thread will continue while the new process runs. It is not possible to retrieve the shell output in non-blocking mode, so ``output`` will be empty. -The return value also depends on the blocking mode. When blocking, the method will return -2 (no process ID information is available in blocking mode). When non-blocking, the method returns a process ID, which you can use to monitor the process (and potentially terminate it with :ref:`kill`). If the process forking (non-blocking) or opening (blocking) fails, the method will return -1. +The return value also depends on the blocking mode. When blocking, the method will return -2 (no process ID information is available in blocking mode). When non-blocking, the method returns a process ID, which you can use to monitor the process (and potentially terminate it with :ref:`kill`). If the process forking (non-blocking) or opening (blocking) fails, the method will return -1. Example of blocking mode and retrieving the shell output: @@ -617,85 +695,85 @@ If you wish to access a shell built-in or perform a composite command, a platfor OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) -.. _class_OS_find_scancode_from_string: +.. _class_OS_method_find_scancode_from_string: - :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** const Returns the scancode of the given string (e.g. "Escape") -.. _class_OS_get_audio_driver_count: +.. _class_OS_method_get_audio_driver_count: - :ref:`int` **get_audio_driver_count** **(** **)** const Returns the total number of available audio drivers. -.. _class_OS_get_audio_driver_name: +.. _class_OS_method_get_audio_driver_name: - :ref:`String` **get_audio_driver_name** **(** :ref:`int` driver **)** const Returns the audio driver name for the given index. -.. _class_OS_get_cmdline_args: +.. _class_OS_method_get_cmdline_args: - :ref:`PoolStringArray` **get_cmdline_args** **(** **)** Returns the command line arguments passed to the engine. -.. _class_OS_get_connected_midi_inputs: +.. _class_OS_method_get_connected_midi_inputs: - :ref:`PoolStringArray` **get_connected_midi_inputs** **(** **)** -.. _class_OS_get_date: +.. _class_OS_method_get_date: - :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). -.. _class_OS_get_datetime: +.. _class_OS_method_get_datetime: - :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. -.. _class_OS_get_datetime_from_unix_time: +.. _class_OS_method_get_datetime_from_unix_time: - :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** const Get a dictionary of time values when given epoch time. -Dictionary Time values will be a union of values from :ref:`get_time` and :ref:`get_date` dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch). +Dictionary Time values will be a union of values from :ref:`get_time` and :ref:`get_date` dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch). -.. _class_OS_get_dynamic_memory_usage: +.. _class_OS_method_get_dynamic_memory_usage: - :ref:`int` **get_dynamic_memory_usage** **(** **)** const Returns the total amount of dynamic memory used (only works in debug). -.. _class_OS_get_environment: +.. _class_OS_method_get_environment: - :ref:`String` **get_environment** **(** :ref:`String` environment **)** const Returns an environment variable. -.. _class_OS_get_executable_path: +.. _class_OS_method_get_executable_path: - :ref:`String` **get_executable_path** **(** **)** const Returns the path to the current engine executable. -.. _class_OS_get_ime_selection: +.. _class_OS_method_get_ime_selection: - :ref:`Vector2` **get_ime_selection** **(** **)** const Returns IME selection range. -.. _class_OS_get_ime_text: +.. _class_OS_method_get_ime_text: - :ref:`String` **get_ime_text** **(** **)** const Returns IME intermediate text. -.. _class_OS_get_latin_keyboard_variant: +.. _class_OS_method_get_latin_keyboard_variant: - :ref:`String` **get_latin_keyboard_variant** **(** **)** const @@ -703,73 +781,73 @@ Returns the current latin keyboard variant as a String. Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO", "COLEMAK" or "ERROR". -.. _class_OS_get_locale: +.. _class_OS_method_get_locale: - :ref:`String` **get_locale** **(** **)** const Returns the host OS locale. -.. _class_OS_get_model_name: +.. _class_OS_method_get_model_name: - :ref:`String` **get_model_name** **(** **)** const Returns the model name of the current device. -.. _class_OS_get_name: +.. _class_OS_method_get_name: - :ref:`String` **get_name** **(** **)** const Returns the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11". -.. _class_OS_get_power_percent_left: +.. _class_OS_method_get_power_percent_left: - :ref:`int` **get_power_percent_left** **(** **)** Returns the amount of battery left in the device as a percentage. -.. _class_OS_get_power_seconds_left: +.. _class_OS_method_get_power_seconds_left: - :ref:`int` **get_power_seconds_left** **(** **)** Returns the time in seconds before the device runs out of battery. -.. _class_OS_get_power_state: +.. _class_OS_method_get_power_state: - :ref:`PowerState` **get_power_state** **(** **)** Returns the current state of the device regarding battery and power. See ``POWERSTATE_*`` constants. -.. _class_OS_get_process_id: +.. _class_OS_method_get_process_id: - :ref:`int` **get_process_id** **(** **)** const Returns the game process ID -.. _class_OS_get_processor_count: +.. _class_OS_method_get_processor_count: - :ref:`int` **get_processor_count** **(** **)** const Returns the number of cores available in the host machine. -.. _class_OS_get_real_window_size: +.. _class_OS_method_get_real_window_size: - :ref:`Vector2` **get_real_window_size** **(** **)** const Returns the window size including decorations like window borders. -.. _class_OS_get_scancode_string: +.. _class_OS_method_get_scancode_string: - :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** const Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape"). -.. _class_OS_get_screen_count: +.. _class_OS_method_get_screen_count: - :ref:`int` **get_screen_count** **(** **)** const Returns the number of displays attached to the host machine. -.. _class_OS_get_screen_dpi: +.. _class_OS_method_get_screen_dpi: - :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=-1 **)** const @@ -789,77 +867,77 @@ xxhdpi - 480 dpi xxxhdpi - 640 dpi -.. _class_OS_get_screen_position: +.. _class_OS_method_get_screen_position: - :ref:`Vector2` **get_screen_position** **(** :ref:`int` screen=-1 **)** const Returns the position of the specified screen by index. If no screen index is provided, the current screen will be used. -.. _class_OS_get_screen_size: +.. _class_OS_method_get_screen_size: - :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** const Returns the dimensions in pixels of the specified screen. -.. _class_OS_get_splash_tick_msec: +.. _class_OS_method_get_splash_tick_msec: - :ref:`int` **get_splash_tick_msec** **(** **)** const -.. _class_OS_get_static_memory_peak_usage: +.. _class_OS_method_get_static_memory_peak_usage: - :ref:`int` **get_static_memory_peak_usage** **(** **)** const Returns the max amount of static memory used (only works in debug). -.. _class_OS_get_static_memory_usage: +.. _class_OS_method_get_static_memory_usage: - :ref:`int` **get_static_memory_usage** **(** **)** const Returns the amount of static memory being used by the program in bytes. -.. _class_OS_get_system_dir: +.. _class_OS_method_get_system_dir: - :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`. -.. _class_OS_get_system_time_msecs: +.. _class_OS_method_get_system_time_msecs: - :ref:`int` **get_system_time_msecs** **(** **)** const Returns the epoch time of the operating system in milliseconds. -.. _class_OS_get_system_time_secs: +.. _class_OS_method_get_system_time_secs: - :ref:`int` **get_system_time_secs** **(** **)** const Returns the epoch time of the operating system in seconds. -.. _class_OS_get_ticks_msec: +.. _class_OS_method_get_ticks_msec: - :ref:`int` **get_ticks_msec** **(** **)** const Returns the amount of time passed in milliseconds since the engine started. -.. _class_OS_get_ticks_usec: +.. _class_OS_method_get_ticks_usec: - :ref:`int` **get_ticks_usec** **(** **)** const Returns the amount of time passed in microseconds since the engine started. -.. _class_OS_get_time: +.. _class_OS_method_get_time: - :ref:`Dictionary` **get_time** **(** :ref:`bool` utc=false **)** const Returns current time as a dictionary of keys: hour, minute, second. -.. _class_OS_get_time_zone_info: +.. _class_OS_method_get_time_zone_info: - :ref:`Dictionary` **get_time_zone_info** **(** **)** const Returns the current time zone as a dictionary with the keys: bias and name. -.. _class_OS_get_unique_id: +.. _class_OS_method_get_unique_id: - :ref:`String` **get_unique_id** **(** **)** const @@ -867,13 +945,13 @@ Returns a string that is unique to the device. Returns empty string on HTML5 and UWP which are not supported yet. -.. _class_OS_get_unix_time: +.. _class_OS_method_get_unix_time: - :ref:`int` **get_unix_time** **(** **)** const Returns the current unix epoch timestamp. -.. _class_OS_get_unix_time_from_datetime: +.. _class_OS_method_get_unix_time_from_datetime: - :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** const @@ -881,9 +959,9 @@ Get an epoch time value from a dictionary of time values. ``datetime`` must be populated with the following keys: year, month, day, hour, minute, second. -You can pass the output from :ref:`get_datetime_from_unix_time` directly into this function. Daylight savings time (dst), if present, is ignored. +You can pass the output from :ref:`get_datetime_from_unix_time` directly into this function. Daylight savings time (dst), if present, is ignored. -.. _class_OS_get_user_data_dir: +.. _class_OS_method_get_user_data_dir: - :ref:`String` **get_user_data_dir** **(** **)** const @@ -897,55 +975,55 @@ On Windows, this is ``%APPDATA%/Godot/app_userdata/[project_name]``, or ``%APPDA If the project name is empty, ``user://`` falls back to ``res://``. -.. _class_OS_get_video_driver_count: +.. _class_OS_method_get_video_driver_count: - :ref:`int` **get_video_driver_count** **(** **)** const -.. _class_OS_get_video_driver_name: +.. _class_OS_method_get_video_driver_name: - :ref:`String` **get_video_driver_name** **(** :ref:`int` driver **)** const -.. _class_OS_get_virtual_keyboard_height: +.. _class_OS_method_get_virtual_keyboard_height: - :ref:`int` **get_virtual_keyboard_height** **(** **)** Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or it is currently hidden. -.. _class_OS_get_window_safe_area: +.. _class_OS_method_get_window_safe_area: - :ref:`Rect2` **get_window_safe_area** **(** **)** const -.. _class_OS_has_environment: +.. _class_OS_method_has_environment: - :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const Returns ``true`` if an environment variable exists. -.. _class_OS_has_feature: +.. _class_OS_method_has_feature: - :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. See feature tags documentation. -.. _class_OS_has_touchscreen_ui_hint: +.. _class_OS_method_has_touchscreen_ui_hint: - :ref:`bool` **has_touchscreen_ui_hint** **(** **)** const Returns ``true`` if the device has a touchscreen or emulates one. -.. _class_OS_has_virtual_keyboard: +.. _class_OS_method_has_virtual_keyboard: - :ref:`bool` **has_virtual_keyboard** **(** **)** const Returns ``true`` if the platform has a virtual keyboard, ``false`` otherwise. -.. _class_OS_hide_virtual_keyboard: +.. _class_OS_method_hide_virtual_keyboard: - void **hide_virtual_keyboard** **(** **)** Hides the virtual keyboard if it is shown, does nothing otherwise. -.. _class_OS_is_debug_build: +.. _class_OS_method_is_debug_build: - :ref:`bool` **is_debug_build** **(** **)** const @@ -955,63 +1033,63 @@ Returns ``true`` when running in the editor. Returns ``false`` if the build is a release build. -.. _class_OS_is_ok_left_and_cancel_right: +.. _class_OS_method_is_ok_left_and_cancel_right: - :ref:`bool` **is_ok_left_and_cancel_right** **(** **)** const Returns ``true`` if the "Okay" button should appear on the left and "Cancel" on the right. -.. _class_OS_is_scancode_unicode: +.. _class_OS_method_is_scancode_unicode: - :ref:`bool` **is_scancode_unicode** **(** :ref:`int` code **)** const Returns ``true`` if the input code has a unicode character. -.. _class_OS_is_stdout_verbose: +.. _class_OS_method_is_stdout_verbose: - :ref:`bool` **is_stdout_verbose** **(** **)** const Returns ``true`` if the engine was executed with -v (verbose stdout). -.. _class_OS_is_userfs_persistent: +.. _class_OS_method_is_userfs_persistent: - :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. -.. _class_OS_is_window_always_on_top: +.. _class_OS_method_is_window_always_on_top: - :ref:`bool` **is_window_always_on_top** **(** **)** const Returns ``true`` if the window should always be on top of other windows. -.. _class_OS_kill: +.. _class_OS_method_kill: - :ref:`Error` **kill** **(** :ref:`int` pid **)** -Kill (terminate) the process identified by the given process ID (``pid``), e.g. the one returned by :ref:`execute` in non-blocking mode. +Kill (terminate) the process identified by the given process ID (``pid``), e.g. the one returned by :ref:`execute` in non-blocking mode. Note that this method can also be used to kill processes that were not spawned by the game. -.. _class_OS_move_window_to_foreground: +.. _class_OS_method_move_window_to_foreground: - void **move_window_to_foreground** **(** **)** Moves the window to the front. -.. _class_OS_native_video_is_playing: +.. _class_OS_method_native_video_is_playing: - :ref:`bool` **native_video_is_playing** **(** **)** Returns ``true`` if native video is playing. -.. _class_OS_native_video_pause: +.. _class_OS_method_native_video_pause: - void **native_video_pause** **(** **)** Pauses native video playback. -.. _class_OS_native_video_play: +.. _class_OS_method_native_video_play: - :ref:`Error` **native_video_play** **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** @@ -1019,95 +1097,95 @@ Plays native video from the specified path, at the given volume and with audio a Note: This method is only implemented on Android and iOS, and the current Android implementation does not support the ``volume``, ``audio_track`` and ``subtitle_track`` options. -.. _class_OS_native_video_stop: +.. _class_OS_method_native_video_stop: - void **native_video_stop** **(** **)** Stops native video playback. -.. _class_OS_native_video_unpause: +.. _class_OS_method_native_video_unpause: - void **native_video_unpause** **(** **)** Resumes native video playback. -.. _class_OS_open_midi_inputs: +.. _class_OS_method_open_midi_inputs: - void **open_midi_inputs** **(** **)** -.. _class_OS_print_all_resources: +.. _class_OS_method_print_all_resources: - void **print_all_resources** **(** :ref:`String` tofile="" **)** Shows all resources in the game. Optionally the list can be written to a file. -.. _class_OS_print_all_textures_by_size: +.. _class_OS_method_print_all_textures_by_size: - void **print_all_textures_by_size** **(** **)** Shows the list of loaded textures sorted by size in memory. -.. _class_OS_print_resources_by_type: +.. _class_OS_method_print_resources_by_type: - void **print_resources_by_type** **(** :ref:`PoolStringArray` types **)** Shows the number of resources loaded by the game of the given types. -.. _class_OS_print_resources_in_use: +.. _class_OS_method_print_resources_in_use: - void **print_resources_in_use** **(** :ref:`bool` short=false **)** Shows all resources currently used by the game. -.. _class_OS_request_attention: +.. _class_OS_method_request_attention: - void **request_attention** **(** **)** Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX. -.. _class_OS_set_icon: +.. _class_OS_method_set_icon: - void **set_icon** **(** :ref:`Image` icon **)** Sets the game's icon. -.. _class_OS_set_ime_active: +.. _class_OS_method_set_ime_active: - void **set_ime_active** **(** :ref:`bool` active **)** Sets whether IME input mode should be enabled. -.. _class_OS_set_ime_position: +.. _class_OS_method_set_ime_position: - void **set_ime_position** **(** :ref:`Vector2` position **)** Sets position of IME suggestion list popup (in window coordinates). -.. _class_OS_set_thread_name: +.. _class_OS_method_set_thread_name: - :ref:`Error` **set_thread_name** **(** :ref:`String` name **)** Sets the name of the current thread. -.. _class_OS_set_use_file_access_save_and_swap: +.. _class_OS_method_set_use_file_access_save_and_swap: - void **set_use_file_access_save_and_swap** **(** :ref:`bool` enabled **)** Enables backup saves if ``enabled`` is ``true``. -.. _class_OS_set_window_always_on_top: +.. _class_OS_method_set_window_always_on_top: - void **set_window_always_on_top** **(** :ref:`bool` enabled **)** Sets whether the window should always be on top. -.. _class_OS_set_window_title: +.. _class_OS_method_set_window_title: - void **set_window_title** **(** :ref:`String` title **)** Sets the window title to the specified string. -.. _class_OS_shell_open: +.. _class_OS_method_shell_open: - :ref:`Error` **shell_open** **(** :ref:`String` uri **)** @@ -1117,7 +1195,7 @@ Requests the OS to open a resource with the most appropriate program. For exampl ``OS.shell_open("http://godotengine.org")`` opens the default web browser on the official Godot website. -.. _class_OS_show_virtual_keyboard: +.. _class_OS_method_show_virtual_keyboard: - void **show_virtual_keyboard** **(** :ref:`String` existing_text="" **)** diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 47fc00e95..36b1e3e5a 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -19,34 +19,34 @@ Brief Description Properties ---------- -+-------------------------------------------+-----------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`__data__` | -+-------------------------------------------+-----------------------------------------------------+ ++-------------------------------------------+--------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`__data__` | ++-------------------------------------------+--------------------------------------------------------------+ Methods ------- -+----------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`pack` **(** :ref:`Variant` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`pack` **(** :ref:`Variant` value **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** const | ++---------------------------------------+----------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_PackedDataContainer___data__: +.. _class_PackedDataContainer_property___data__: - :ref:`PoolByteArray` **__data__** Method Descriptions ------------------- -.. _class_PackedDataContainer_pack: +.. _class_PackedDataContainer_method_pack: - :ref:`Error` **pack** **(** :ref:`Variant` value **)** -.. _class_PackedDataContainer_size: +.. _class_PackedDataContainer_method_size: - :ref:`int` **size** **(** **)** const diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index ecf565e77..c06da50c2 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -19,14 +19,14 @@ Brief Description Methods ------- -+------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** const | -+------------------------+------------------------------------------------------------------+ ++-----------------------+-------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** const | ++-----------------------+-------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_PackedDataContainerRef_size: +.. _class_PackedDataContainerRef_method_size: - :ref:`int` **size** **(** **)** const diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 8a466a068..4f9564266 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -19,35 +19,41 @@ An abstraction of a serialized scene. Properties ---------- -+-------------------------------------+---------------------------------------------+ -| :ref:`Dictionary` | :ref:`_bundled` | -+-------------------------------------+---------------------------------------------+ ++-------------------------------------+------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`_bundled` | ++-------------------------------------+------------------------------------------------------+ 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 ------------ .. _enum_PackedScene_GenEditState: +.. _class_PackedScene_constant_GEN_EDIT_STATE_DISABLED: + +.. _class_PackedScene_constant_GEN_EDIT_STATE_INSTANCE: + +.. _class_PackedScene_constant_GEN_EDIT_STATE_MAIN: + enum **GenEditState**: -- **GEN_EDIT_STATE_DISABLED** = **0** --- If passed to :ref:`instance`, blocks edits to the scene state. +- **GEN_EDIT_STATE_DISABLED** = **0** --- If passed to :ref:`instance`, blocks edits to the scene state. -- **GEN_EDIT_STATE_INSTANCE** = **1** --- If passed to :ref:`instance`, provides local scene resources to the local scene. Requires tools compiled. +- **GEN_EDIT_STATE_INSTANCE** = **1** --- If passed to :ref:`instance`, provides local scene resources to the local scene. Requires tools compiled. -- **GEN_EDIT_STATE_MAIN** = **2** --- If passed to :ref:`instance`, provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled. +- **GEN_EDIT_STATE_MAIN** = **2** --- If passed to :ref:`instance`, provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled. Description ----------- @@ -81,7 +87,7 @@ Example of saving a node with different owners: The following example creates 3 Property Descriptions --------------------- -.. _class_PackedScene__bundled: +.. _class_PackedScene_property__bundled: - :ref:`Dictionary` **_bundled** @@ -92,27 +98,27 @@ Available keys include "rnames" and "variants" for resources, "node_count", "nod Method Descriptions ------------------- -.. _class_PackedScene_can_instance: +.. _class_PackedScene_method_can_instance: - :ref:`bool` **can_instance** **(** **)** const Returns ``true`` if the scene file has nodes. -.. _class_PackedScene_get_state: +.. _class_PackedScene_method_get_state: - :ref:`SceneState` **get_state** **(** **)** Returns the ``SceneState`` representing the scene file contents. -.. _class_PackedScene_instance: +.. _class_PackedScene_method_instance: - :ref:`Node` **instance** **(** :ref:`GenEditState` edit_state=0 **)** const Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers :ref:`Node`'s ``NOTIFICATION_INSTANCED`` notification on the root node. -.. _class_PackedScene_pack: +.. _class_PackedScene_method_pack: - :ref:`Error` **pack** **(** :ref:`Node` path **)** -Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner`. +Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner`. diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index d3768534d..ba076acfe 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -21,26 +21,26 @@ Abstraction and base class for packet-based protocols. Properties ---------- -+-------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_object_decoding` | -+-------------------------+----------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_object_decoding` | ++-------------------------+-------------------------------------------------------------------------------+ Methods ------- -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_packet_error` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_var` **(** :ref:`Variant` var **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`get_packet_error` **(** **)** const | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`put_var` **(** :ref:`Variant` var **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -50,7 +50,7 @@ PacketPeer is an abstraction and base class for packet-based protocols (such as Property Descriptions --------------------- -.. _class_PacketPeer_allow_object_decoding: +.. _class_PacketPeer_property_allow_object_decoding: - :ref:`bool` **allow_object_decoding** @@ -63,37 +63,37 @@ Property Descriptions Method Descriptions ------------------- -.. _class_PacketPeer_get_available_packet_count: +.. _class_PacketPeer_method_get_available_packet_count: - :ref:`int` **get_available_packet_count** **(** **)** const Return the number of packets currently available in the ring-buffer. -.. _class_PacketPeer_get_packet: +.. _class_PacketPeer_method_get_packet: - :ref:`PoolByteArray` **get_packet** **(** **)** Get a raw packet. -.. _class_PacketPeer_get_packet_error: +.. _class_PacketPeer_method_get_packet_error: - :ref:`Error` **get_packet_error** **(** **)** const -Return the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). +Return the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). -.. _class_PacketPeer_get_var: +.. _class_PacketPeer_method_get_var: - :ref:`Variant` **get_var** **(** **)** Get a Variant. -.. _class_PacketPeer_put_packet: +.. _class_PacketPeer_method_put_packet: - :ref:`Error` **put_packet** **(** :ref:`PoolByteArray` buffer **)** Send a raw packet. -.. _class_PacketPeer_put_var: +.. _class_PacketPeer_method_put_var: - :ref:`Error` **put_var** **(** :ref:`Variant` var **)** diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 2a539d16e..44f394d0c 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -19,13 +19,13 @@ Wrapper to use a PacketPeer over a StreamPeer. Properties ---------- -+-------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`input_buffer_max_size` | -+-------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`output_buffer_max_size` | -+-------------------------------------+------------------------------------------------------------------------------+ -| :ref:`StreamPeer` | :ref:`stream_peer` | -+-------------------------------------+------------------------------------------------------------------------------+ ++-------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`input_buffer_max_size` | ++-------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`output_buffer_max_size` | ++-------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`StreamPeer` | :ref:`stream_peer` | ++-------------------------------------+---------------------------------------------------------------------------------------+ Description ----------- @@ -35,7 +35,7 @@ PacketStreamPeer provides a wrapper for working using packets over a stream. Thi Property Descriptions --------------------- -.. _class_PacketPeerStream_input_buffer_max_size: +.. _class_PacketPeerStream_property_input_buffer_max_size: - :ref:`int` **input_buffer_max_size** @@ -45,7 +45,7 @@ Property Descriptions | *Getter* | get_input_buffer_max_size() | +----------+----------------------------------+ -.. _class_PacketPeerStream_output_buffer_max_size: +.. _class_PacketPeerStream_property_output_buffer_max_size: - :ref:`int` **output_buffer_max_size** @@ -55,7 +55,7 @@ Property Descriptions | *Getter* | get_output_buffer_max_size() | +----------+-----------------------------------+ -.. _class_PacketPeerStream_stream_peer: +.. _class_PacketPeerStream_property_stream_peer: - :ref:`StreamPeer` **stream_peer** diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 0a2b8067e..6cad76ace 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -19,21 +19,21 @@ UDP packet peer. Methods ------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_port` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`wait` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_port` **(** **)** const | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`wait` **(** **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -43,31 +43,31 @@ UDP packet peer. Can be used to send raw UDP packets as well as :ref:`Variant` **get_packet_ip** **(** **)** const -Return the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). +Return the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). -.. _class_PacketPeerUDP_get_packet_port: +.. _class_PacketPeerUDP_method_get_packet_port: - :ref:`int` **get_packet_port** **(** **)** const -Return the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). +Return the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). -.. _class_PacketPeerUDP_is_listening: +.. _class_PacketPeerUDP_method_is_listening: - :ref:`bool` **is_listening** **(** **)** const Return whether this ``PacketPeerUDP`` is listening. -.. _class_PacketPeerUDP_listen: +.. _class_PacketPeerUDP_method_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** @@ -79,15 +79,15 @@ If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the peer wi If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). -.. _class_PacketPeerUDP_set_dest_address: +.. _class_PacketPeerUDP_method_set_dest_address: - :ref:`Error` **set_dest_address** **(** :ref:`String` host, :ref:`int` port **)** Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid. -.. _class_PacketPeerUDP_wait: +.. _class_PacketPeerUDP_method_wait: - :ref:`Error` **wait** **(** **)** -Wait for a packet to arrive on the listening port, see :ref:`listen`. +Wait for a packet to arrive on the listening port, see :ref:`listen`. diff --git a/classes/class_panel.rst b/classes/class_panel.rst index 9a64c5d51..b1654854a 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -19,13 +19,13 @@ Provides an opaque background for :ref:`Control` children. Theme Properties ---------------- -+---------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`panelf` | -+---------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`panelnc` | -+---------------------------------+-------------------------------------+ ++---------------------------------+---------+ +| :ref:`StyleBox` | panel | ++---------------------------------+---------+ +| :ref:`StyleBox` | panelf | ++---------------------------------+---------+ +| :ref:`StyleBox` | panelnc | ++---------------------------------+---------+ Description ----------- diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index cb51a9d4b..24de8b7f2 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -21,9 +21,9 @@ Panel container type. Theme Properties ---------------- -+---------------------------------+------------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+------------------------------------------+ ++---------------------------------+-------+ +| :ref:`StyleBox` | panel | ++---------------------------------+-------+ Description ----------- diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index 4455cd828..bfb322cbe 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -19,9 +19,9 @@ A type of :ref:`Sky` used to draw a background texture. Properties ---------- -+-------------------------------+---------------------------------------------+ -| :ref:`Texture` | :ref:`panorama` | -+-------------------------------+---------------------------------------------+ ++-------------------------------+------------------------------------------------------+ +| :ref:`Texture` | :ref:`panorama` | ++-------------------------------+------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ A resource referenced in an :ref:`Environment` that is used t Property Descriptions --------------------- -.. _class_PanoramaSky_panorama: +.. _class_PanoramaSky_property_panorama: - :ref:`Texture` **panorama** diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index d9160a5f2..bc2a9610f 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -19,29 +19,29 @@ A node used to create a parallax scrolling background. Properties ---------- -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_base_offset` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_base_scale` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_ignore_camera_zoom` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_limit_begin` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_limit_end` | -+-------------------------------+--------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scroll_offset` | -+-------------------------------+--------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`scroll_base_offset` | ++-------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`scroll_base_scale` | ++-------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`scroll_ignore_camera_zoom` | ++-------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`scroll_limit_begin` | ++-------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`scroll_limit_end` | ++-------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`scroll_offset` | ++-------------------------------+-----------------------------------------------------------------------------------------------+ Description ----------- -A ParallaxBackground uses one or more :ref:`ParallaxLayer` child nodes to create a parallax effect. Each :ref:`ParallaxLayer` can move at a different speed using :ref:`ParallaxLayer.motion_offset`. This creates an illusion of depth in a 2D game. If not used with a :ref:`Camera2D`, you must manually calculate the :ref:`scroll_offset`. +A ParallaxBackground uses one or more :ref:`ParallaxLayer` child nodes to create a parallax effect. Each :ref:`ParallaxLayer` can move at a different speed using :ref:`ParallaxLayer.motion_offset`. This creates an illusion of depth in a 2D game. If not used with a :ref:`Camera2D`, you must manually calculate the :ref:`scroll_offset`. Property Descriptions --------------------- -.. _class_ParallaxBackground_scroll_base_offset: +.. _class_ParallaxBackground_property_scroll_base_offset: - :ref:`Vector2` **scroll_base_offset** @@ -53,7 +53,7 @@ Property Descriptions Base position offset of all :ref:`ParallaxLayer` children. -.. _class_ParallaxBackground_scroll_base_scale: +.. _class_ParallaxBackground_property_scroll_base_scale: - :ref:`Vector2` **scroll_base_scale** @@ -65,7 +65,7 @@ Base position offset of all :ref:`ParallaxLayer` children. Base motion scale of all :ref:`ParallaxLayer` children. -.. _class_ParallaxBackground_scroll_ignore_camera_zoom: +.. _class_ParallaxBackground_property_scroll_ignore_camera_zoom: - :ref:`bool` **scroll_ignore_camera_zoom** @@ -77,7 +77,7 @@ Base motion scale of all :ref:`ParallaxLayer` children. If ``true``, elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. -.. _class_ParallaxBackground_scroll_limit_begin: +.. _class_ParallaxBackground_property_scroll_limit_begin: - :ref:`Vector2` **scroll_limit_begin** @@ -87,9 +87,9 @@ If ``true``, elements in :ref:`ParallaxLayer` child aren't | *Getter* | get_limit_begin() | +----------+------------------------+ -Top left limits for scrolling to begin. If the camera is outside of this limit the background will stop scrolling. Must be lower than :ref:`scroll_limit_end` to work. +Top left limits for scrolling to begin. If the camera is outside of this limit the background will stop scrolling. Must be lower than :ref:`scroll_limit_end` to work. -.. _class_ParallaxBackground_scroll_limit_end: +.. _class_ParallaxBackground_property_scroll_limit_end: - :ref:`Vector2` **scroll_limit_end** @@ -99,9 +99,9 @@ Top left limits for scrolling to begin. If the camera is outside of this limit t | *Getter* | get_limit_end() | +----------+----------------------+ -Right bottom limits for scrolling to end. If the camera is outside of this limit the background will stop scrolling. Must be higher than :ref:`scroll_limit_begin` to work. +Right bottom limits for scrolling to end. If the camera is outside of this limit the background will stop scrolling. Must be higher than :ref:`scroll_limit_begin` to work. -.. _class_ParallaxBackground_scroll_offset: +.. _class_ParallaxBackground_property_scroll_offset: - :ref:`Vector2` **scroll_offset** diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 594013ded..b748c34a3 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -19,18 +19,18 @@ A parallax scrolling layer to be used with :ref:`ParallaxBackground` | :ref:`motion_mirroring` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion_offset` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion_scale` | -+-------------------------------+---------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`motion_mirroring` | ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`motion_offset` | ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`motion_scale` | ++-------------------------------+------------------------------------------------------------------------+ Description ----------- -A ParallaxLayer must be the child of a :ref:`ParallaxBackground` node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the :ref:`ParallaxBackground.scroll_offset` value. +A ParallaxLayer must be the child of a :ref:`ParallaxBackground` node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the :ref:`ParallaxBackground.scroll_offset` value. This node's children will be affected by its scroll offset. @@ -39,7 +39,7 @@ Note that any changes to this node's position and scale made after it enters the Property Descriptions --------------------- -.. _class_ParallaxLayer_motion_mirroring: +.. _class_ParallaxLayer_property_motion_mirroring: - :ref:`Vector2` **motion_mirroring** @@ -51,7 +51,7 @@ Property Descriptions The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating an infinite scrolling background. If an axis is set to ``0`` the :ref:`Texture` will not be mirrored. Default value: ``(0, 0)``. -.. _class_ParallaxLayer_motion_offset: +.. _class_ParallaxLayer_property_motion_offset: - :ref:`Vector2` **motion_offset** @@ -61,9 +61,9 @@ The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating | *Getter* | get_motion_offset() | +----------+--------------------------+ -The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. +The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. -.. _class_ParallaxLayer_motion_scale: +.. _class_ParallaxLayer_property_motion_scale: - :ref:`Vector2` **motion_scale** diff --git a/classes/class_particles.rst b/classes/class_particles.rst index ecde28874..89b64d9fc 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -19,60 +19,66 @@ Brief Description Properties ---------- -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`amount` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`DrawOrder` | :ref:`draw_order` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`Mesh` | :ref:`draw_pass_1` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`Mesh` | :ref:`draw_pass_2` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`Mesh` | :ref:`draw_pass_3` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`Mesh` | :ref:`draw_pass_4` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`draw_passes` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`emitting` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`explosiveness` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_fps` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`fract_delta` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`lifetime` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`local_coords` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`preprocess` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`Material` | :ref:`process_material` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`randomness` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+--------------------------------------------+-----------------------------------------------------------+ -| :ref:`AABB` | :ref:`visibility_aabb` | -+--------------------------------------------+-----------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`amount` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`DrawOrder` | :ref:`draw_order` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`draw_pass_1` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`draw_pass_2` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`draw_pass_3` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`draw_pass_4` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`draw_passes` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`emitting` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`explosiveness` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`fixed_fps` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fract_delta` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`lifetime` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`local_coords` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`one_shot` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`preprocess` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`Material` | :ref:`process_material` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`randomness` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`speed_scale` | ++--------------------------------------------+--------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`visibility_aabb` | ++--------------------------------------------+--------------------------------------------------------------------+ Methods ------- -+--------------------------+---------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`capture_aabb` **(** **)** const | -+--------------------------+---------------------------------------------------------------------+ -| void | :ref:`restart` **(** **)** | -+--------------------------+---------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`capture_aabb` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++-------------------------+----------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Particles_DrawOrder: +.. _class_Particles_constant_DRAW_ORDER_INDEX: + +.. _class_Particles_constant_DRAW_ORDER_LIFETIME: + +.. _class_Particles_constant_DRAW_ORDER_VIEW_DEPTH: + enum **DrawOrder**: - **DRAW_ORDER_INDEX** = **0** --- Particles are drawn in the order emitted. @@ -84,6 +90,8 @@ enum **DrawOrder**: Constants --------- +.. _class_Particles_constant_MAX_DRAW_PASSES: + - **MAX_DRAW_PASSES** = **4** --- Maximum number of draw passes supported. Description @@ -96,7 +104,7 @@ Use the ``process_material`` property to add a :ref:`ParticlesMaterial` **amount** @@ -108,7 +116,7 @@ Property Descriptions Number of particles to emit. -.. _class_Particles_draw_order: +.. _class_Particles_property_draw_order: - :ref:`DrawOrder` **draw_order** @@ -120,7 +128,7 @@ Number of particles to emit. Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. -.. _class_Particles_draw_pass_1: +.. _class_Particles_property_draw_pass_1: - :ref:`Mesh` **draw_pass_1** @@ -132,7 +140,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I :ref:`Mesh` that is drawn for the first draw pass. -.. _class_Particles_draw_pass_2: +.. _class_Particles_property_draw_pass_2: - :ref:`Mesh` **draw_pass_2** @@ -144,7 +152,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I :ref:`Mesh` that is drawn for the second draw pass. -.. _class_Particles_draw_pass_3: +.. _class_Particles_property_draw_pass_3: - :ref:`Mesh` **draw_pass_3** @@ -156,7 +164,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I :ref:`Mesh` that is drawn for the third draw pass. -.. _class_Particles_draw_pass_4: +.. _class_Particles_property_draw_pass_4: - :ref:`Mesh` **draw_pass_4** @@ -168,7 +176,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I :ref:`Mesh` that is drawn for the fourth draw pass. -.. _class_Particles_draw_passes: +.. _class_Particles_property_draw_passes: - :ref:`int` **draw_passes** @@ -180,7 +188,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I The number of draw passes when rendering particles. -.. _class_Particles_emitting: +.. _class_Particles_property_emitting: - :ref:`bool` **emitting** @@ -192,7 +200,7 @@ The number of draw passes when rendering particles. If ``true``, particles are being emitted. Default value: ``true``. -.. _class_Particles_explosiveness: +.. _class_Particles_property_explosiveness: - :ref:`float` **explosiveness** @@ -204,7 +212,7 @@ If ``true``, particles are being emitted. Default value: ``true``. Time ratio between each emission. If ``0`` particles are emitted continuously. If ``1`` all particles are emitted simultaneously. Default value: ``0``. -.. _class_Particles_fixed_fps: +.. _class_Particles_property_fixed_fps: - :ref:`int` **fixed_fps** @@ -214,7 +222,7 @@ Time ratio between each emission. If ``0`` particles are emitted continuously. I | *Getter* | get_fixed_fps() | +----------+----------------------+ -.. _class_Particles_fract_delta: +.. _class_Particles_property_fract_delta: - :ref:`bool` **fract_delta** @@ -224,7 +232,7 @@ Time ratio between each emission. If ``0`` particles are emitted continuously. I | *Getter* | get_fractional_delta() | +----------+-----------------------------+ -.. _class_Particles_lifetime: +.. _class_Particles_property_lifetime: - :ref:`float` **lifetime** @@ -236,7 +244,7 @@ Time ratio between each emission. If ``0`` particles are emitted continuously. I Amount of time each particle will exist. Default value: ``1``. -.. _class_Particles_local_coords: +.. _class_Particles_property_local_coords: - :ref:`bool` **local_coords** @@ -248,7 +256,7 @@ Amount of time each particle will exist. Default value: ``1``. If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. -.. _class_Particles_one_shot: +.. _class_Particles_property_one_shot: - :ref:`bool` **one_shot** @@ -260,7 +268,7 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the If ``true``, only ``amount`` particles will be emitted. Default value: ``false``. -.. _class_Particles_preprocess: +.. _class_Particles_property_preprocess: - :ref:`float` **preprocess** @@ -272,7 +280,7 @@ If ``true``, only ``amount`` particles will be emitted. Default value: ``false`` Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. -.. _class_Particles_process_material: +.. _class_Particles_property_process_material: - :ref:`Material` **process_material** @@ -284,7 +292,7 @@ Amount of time to preprocess the particles before animation starts. Lets you sta :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. -.. _class_Particles_randomness: +.. _class_Particles_property_randomness: - :ref:`float` **randomness** @@ -296,7 +304,7 @@ Amount of time to preprocess the particles before animation starts. Lets you sta Emission randomness ratio. Default value: ``0``. -.. _class_Particles_speed_scale: +.. _class_Particles_property_speed_scale: - :ref:`float` **speed_scale** @@ -308,7 +316,7 @@ Emission randomness ratio. Default value: ``0``. Speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. -.. _class_Particles_visibility_aabb: +.. _class_Particles_property_visibility_aabb: - :ref:`AABB` **visibility_aabb** @@ -323,11 +331,11 @@ The :ref:`AABB` that determines the area of the world part of which Method Descriptions ------------------- -.. _class_Particles_capture_aabb: +.. _class_Particles_method_capture_aabb: - :ref:`AABB` **capture_aabb** **(** **)** const -.. _class_Particles_restart: +.. _class_Particles_method_restart: - void **restart** **(** **)** diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index aacf1ebfb..9a59b05fe 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -19,54 +19,58 @@ Brief Description Properties ---------- -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`int` | :ref:`amount` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`DrawOrder` | :ref:`draw_order` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`emitting` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`explosiveness` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`int` | :ref:`fixed_fps` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`fract_delta` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`lifetime` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`local_coords` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`preprocess` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`Material` | :ref:`process_material` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`randomness` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`speed_scale` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+----------------------------------------------+-------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`visibility_rect` | -+----------------------------------------------+-------------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`int` | :ref:`amount` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`DrawOrder` | :ref:`draw_order` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`emitting` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`explosiveness` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`int` | :ref:`fixed_fps` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fract_delta` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`lifetime` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`local_coords` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`normal_map` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`one_shot` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`preprocess` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`Material` | :ref:`process_material` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`randomness` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`speed_scale` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++----------------------------------------------+----------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`visibility_rect` | ++----------------------------------------------+----------------------------------------------------------------------+ Methods ------- -+----------------------------+-----------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | -+----------------------------+-----------------------------------------------------------------------+ -| void | :ref:`restart` **(** **)** | -+----------------------------+-----------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | ++---------------------------+------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++---------------------------+------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Particles2D_DrawOrder: +.. _class_Particles2D_constant_DRAW_ORDER_INDEX: + +.. _class_Particles2D_constant_DRAW_ORDER_LIFETIME: + enum **DrawOrder**: - **DRAW_ORDER_INDEX** = **0** --- Particles are drawn in the order emitted. @@ -83,7 +87,7 @@ Use the ``process_material`` property to add a :ref:`ParticlesMaterial` **amount** @@ -95,7 +99,7 @@ Property Descriptions Number of particles emitted in one emission cycle. -.. _class_Particles2D_draw_order: +.. _class_Particles2D_property_draw_order: - :ref:`DrawOrder` **draw_order** @@ -107,7 +111,7 @@ Number of particles emitted in one emission cycle. Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. -.. _class_Particles2D_emitting: +.. _class_Particles2D_property_emitting: - :ref:`bool` **emitting** @@ -119,7 +123,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I If ``true``, particles are being emitted. Default value: ``true``. -.. _class_Particles2D_explosiveness: +.. _class_Particles2D_property_explosiveness: - :ref:`float` **explosiveness** @@ -131,7 +135,7 @@ If ``true``, particles are being emitted. Default value: ``true``. How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. -.. _class_Particles2D_fixed_fps: +.. _class_Particles2D_property_fixed_fps: - :ref:`int` **fixed_fps** @@ -141,7 +145,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t | *Getter* | get_fixed_fps() | +----------+----------------------+ -.. _class_Particles2D_fract_delta: +.. _class_Particles2D_property_fract_delta: - :ref:`bool` **fract_delta** @@ -151,7 +155,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t | *Getter* | get_fractional_delta() | +----------+-----------------------------+ -.. _class_Particles2D_lifetime: +.. _class_Particles2D_property_lifetime: - :ref:`float` **lifetime** @@ -163,7 +167,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t Amount of time each particle will exist. Default value: ``1``. -.. _class_Particles2D_local_coords: +.. _class_Particles2D_property_local_coords: - :ref:`bool` **local_coords** @@ -175,7 +179,7 @@ Amount of time each particle will exist. Default value: ``1``. If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. -.. _class_Particles2D_normal_map: +.. _class_Particles2D_property_normal_map: - :ref:`Texture` **normal_map** @@ -185,7 +189,7 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the | *Getter* | get_normal_map() | +----------+-----------------------+ -.. _class_Particles2D_one_shot: +.. _class_Particles2D_property_one_shot: - :ref:`bool` **one_shot** @@ -197,7 +201,7 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. -.. _class_Particles2D_preprocess: +.. _class_Particles2D_property_preprocess: - :ref:`float` **preprocess** @@ -209,7 +213,7 @@ If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emi Particle system starts as if it had already run for this many seconds. -.. _class_Particles2D_process_material: +.. _class_Particles2D_property_process_material: - :ref:`Material` **process_material** @@ -221,7 +225,7 @@ Particle system starts as if it had already run for this many seconds. :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. -.. _class_Particles2D_randomness: +.. _class_Particles2D_property_randomness: - :ref:`float` **randomness** @@ -233,7 +237,7 @@ Particle system starts as if it had already run for this many seconds. Emission lifetime randomness ratio. Default value: ``0``. -.. _class_Particles2D_speed_scale: +.. _class_Particles2D_property_speed_scale: - :ref:`float` **speed_scale** @@ -245,7 +249,7 @@ Emission lifetime randomness ratio. Default value: ``0``. Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. -.. _class_Particles2D_texture: +.. _class_Particles2D_property_texture: - :ref:`Texture` **texture** @@ -257,7 +261,7 @@ Particle system's running speed scaling ratio. Default value: ``1``. A value of Particle texture. If ``null`` particles will be squares. -.. _class_Particles2D_visibility_rect: +.. _class_Particles2D_property_visibility_rect: - :ref:`Rect2` **visibility_rect** @@ -272,11 +276,11 @@ Editor visibility helper. Method Descriptions ------------------- -.. _class_Particles2D_capture_rect: +.. _class_Particles2D_method_capture_rect: - :ref:`Rect2` **capture_rect** **(** **)** const -.. _class_Particles2D_restart: +.. _class_Particles2D_method_restart: - void **restart** **(** **)** diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 17ace9a01..dc106db6b 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -19,159 +19,201 @@ Particle properties for :ref:`Particles` and :ref:`Particles2D< Properties ---------- -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`angle_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`angular_velocity_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`anim_offset_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_offset_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`anim_speed_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anim_speed_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`color_ramp` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`damping_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`emission_box_extents` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`emission_color_texture` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`emission_normal_texture` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`emission_point_count` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`emission_point_texture` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`EmissionShape` | :ref:`emission_shape` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_sphere_radius` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_align_y` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_disable_z` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flag_rotate_y` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`flatness` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`gravity` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`hue_variation_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hue_variation_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`initial_velocity_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`linear_accel_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_accel_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`orbit_velocity` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`orbit_velocity_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`orbit_velocity_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`radial_accel_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_accel_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`scale_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`scale_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`spread` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tangential_accel_curve` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tangential_accel_random` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`GradientTexture` | :ref:`trail_color_modifier` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`trail_divisor` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`CurveTexture` | :ref:`trail_size_modifier` | -+------------------------------------------------------------+---------------------------------------------------------------------------------+ ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`angle_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`angular_velocity_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_offset` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`anim_offset_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_offset_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_speed` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`anim_speed_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anim_speed_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`color_ramp` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`damping_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`emission_box_extents` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`emission_color_texture` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`emission_normal_texture` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`emission_point_count` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`emission_point_texture` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`EmissionShape` | :ref:`emission_shape` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`emission_sphere_radius` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flag_align_y` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flag_disable_z` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flag_rotate_y` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`flatness` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`gravity` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`hue_variation` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`hue_variation_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`hue_variation_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`initial_velocity` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`initial_velocity_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_accel` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`linear_accel_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_accel_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`orbit_velocity` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`orbit_velocity_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`orbit_velocity_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_accel` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`radial_accel_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_accel_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`scale` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`scale_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`scale_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`spread` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tangential_accel` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tangential_accel_curve` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tangential_accel_random` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`GradientTexture` | :ref:`trail_color_modifier` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`trail_divisor` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`CurveTexture` | :ref:`trail_size_modifier` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_ParticlesMaterial_Parameter: +.. _class_ParticlesMaterial_constant_PARAM_INITIAL_LINEAR_VELOCITY: + +.. _class_ParticlesMaterial_constant_PARAM_ANGULAR_VELOCITY: + +.. _class_ParticlesMaterial_constant_PARAM_ORBIT_VELOCITY: + +.. _class_ParticlesMaterial_constant_PARAM_LINEAR_ACCEL: + +.. _class_ParticlesMaterial_constant_PARAM_RADIAL_ACCEL: + +.. _class_ParticlesMaterial_constant_PARAM_TANGENTIAL_ACCEL: + +.. _class_ParticlesMaterial_constant_PARAM_DAMPING: + +.. _class_ParticlesMaterial_constant_PARAM_ANGLE: + +.. _class_ParticlesMaterial_constant_PARAM_SCALE: + +.. _class_ParticlesMaterial_constant_PARAM_HUE_VARIATION: + +.. _class_ParticlesMaterial_constant_PARAM_ANIM_SPEED: + +.. _class_ParticlesMaterial_constant_PARAM_ANIM_OFFSET: + +.. _class_ParticlesMaterial_constant_PARAM_MAX: + enum **Parameter**: -- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set initial velocity properties. +- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set initial velocity properties. -- **PARAM_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set angular velocity properties. +- **PARAM_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set angular velocity properties. -- **PARAM_ORBIT_VELOCITY** = **2** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set orbital_velocity properties. +- **PARAM_ORBIT_VELOCITY** = **2** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set orbital_velocity properties. -- **PARAM_LINEAR_ACCEL** = **3** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set linear acceleration properties. +- **PARAM_LINEAR_ACCEL** = **3** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set linear acceleration properties. -- **PARAM_RADIAL_ACCEL** = **4** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set radial acceleration properties. +- **PARAM_RADIAL_ACCEL** = **4** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set radial acceleration properties. -- **PARAM_TANGENTIAL_ACCEL** = **5** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set tangential acceleration properties. +- **PARAM_TANGENTIAL_ACCEL** = **5** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set tangential acceleration properties. -- **PARAM_DAMPING** = **6** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set damping properties. +- **PARAM_DAMPING** = **6** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set damping properties. -- **PARAM_ANGLE** = **7** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set angle properties. +- **PARAM_ANGLE** = **7** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set angle properties. -- **PARAM_SCALE** = **8** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set scale properties. +- **PARAM_SCALE** = **8** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set scale properties. -- **PARAM_HUE_VARIATION** = **9** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set hue_variation properties. +- **PARAM_HUE_VARIATION** = **9** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set hue_variation properties. -- **PARAM_ANIM_SPEED** = **10** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation speed properties. +- **PARAM_ANIM_SPEED** = **10** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation speed properties. -- **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation offset properties. +- **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation offset properties. - **PARAM_MAX** = **12** .. _enum_ParticlesMaterial_Flags: +.. _class_ParticlesMaterial_constant_FLAG_ALIGN_Y_TO_VELOCITY: + +.. _class_ParticlesMaterial_constant_FLAG_ROTATE_Y: + +.. _class_ParticlesMaterial_constant_FLAG_MAX: + enum **Flags**: -- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag` to set :ref:`flag_align_y`. +- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** --- Use with :ref:`set_flag` to set :ref:`flag_align_y`. -- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag` to set :ref:`flag_rotate_y` +- **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag` to set :ref:`flag_rotate_y` - **FLAG_MAX** = **3** .. _enum_ParticlesMaterial_EmissionShape: +.. _class_ParticlesMaterial_constant_EMISSION_SHAPE_POINT: + +.. _class_ParticlesMaterial_constant_EMISSION_SHAPE_SPHERE: + +.. _class_ParticlesMaterial_constant_EMISSION_SHAPE_BOX: + +.. _class_ParticlesMaterial_constant_EMISSION_SHAPE_POINTS: + +.. _class_ParticlesMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS: + enum **EmissionShape**: - **EMISSION_SHAPE_POINT** = **0** --- All particles will be emitted from a single point. @@ -194,7 +236,7 @@ Some of this material's properties are applied to each particle when emitted, wh Property Descriptions --------------------- -.. _class_ParticlesMaterial_angle: +.. _class_ParticlesMaterial_property_angle: - :ref:`float` **angle** @@ -206,7 +248,7 @@ Property Descriptions Initial rotation applied to each particle. -.. _class_ParticlesMaterial_angle_curve: +.. _class_ParticlesMaterial_property_angle_curve: - :ref:`Texture` **angle_curve** @@ -218,7 +260,7 @@ Initial rotation applied to each particle. Each particle's rotation will be animated along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_angle_random: +.. _class_ParticlesMaterial_property_angle_random: - :ref:`float` **angle_random** @@ -230,7 +272,7 @@ Each particle's rotation will be animated along this :ref:`CurveTexture` **angular_velocity** @@ -242,7 +284,7 @@ Rotation randomness ratio. Default value: ``0``. Initial angular velocity applied to each particle. -.. _class_ParticlesMaterial_angular_velocity_curve: +.. _class_ParticlesMaterial_property_angular_velocity_curve: - :ref:`Texture` **angular_velocity_curve** @@ -254,7 +296,7 @@ Initial angular velocity applied to each particle. Each particle's angular velocity will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_angular_velocity_random: +.. _class_ParticlesMaterial_property_angular_velocity_random: - :ref:`float` **angular_velocity_random** @@ -266,7 +308,7 @@ Each particle's angular velocity will vary along this :ref:`CurveTexture` **anim_offset** @@ -278,7 +320,7 @@ Angular velocity randomness ratio. Default value: ``0``. Particle animation offset. -.. _class_ParticlesMaterial_anim_offset_curve: +.. _class_ParticlesMaterial_property_anim_offset_curve: - :ref:`Texture` **anim_offset_curve** @@ -290,7 +332,7 @@ Particle animation offset. Each particle's animation offset will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_anim_offset_random: +.. _class_ParticlesMaterial_property_anim_offset_random: - :ref:`float` **anim_offset_random** @@ -302,7 +344,7 @@ Each particle's animation offset will vary along this :ref:`CurveTexture` **anim_speed** @@ -314,7 +356,7 @@ Animation offset randomness ratio. Default value: ``0``. Particle animation speed. -.. _class_ParticlesMaterial_anim_speed_curve: +.. _class_ParticlesMaterial_property_anim_speed_curve: - :ref:`Texture` **anim_speed_curve** @@ -326,7 +368,7 @@ Particle animation speed. Each particle's animation speed will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_anim_speed_random: +.. _class_ParticlesMaterial_property_anim_speed_random: - :ref:`float` **anim_speed_random** @@ -338,7 +380,7 @@ Each particle's animation speed will vary along this :ref:`CurveTexture` **color** @@ -350,7 +392,7 @@ Animation speed randomness ratio. Default value: ``0``. Each particle's initial color. If the :ref:`Particles2D`'s ``texture`` is defined, it will be multiplied by this color. -.. _class_ParticlesMaterial_color_ramp: +.. _class_ParticlesMaterial_property_color_ramp: - :ref:`Texture` **color_ramp** @@ -362,7 +404,7 @@ Each particle's initial color. If the :ref:`Particles2D`'s `` Each particle's color will vary along this :ref:`GradientTexture`. -.. _class_ParticlesMaterial_damping: +.. _class_ParticlesMaterial_property_damping: - :ref:`float` **damping** @@ -374,7 +416,7 @@ Each particle's color will vary along this :ref:`GradientTexture` **damping_curve** @@ -386,7 +428,7 @@ The rate at which particles lose velocity. Damping will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_damping_random: +.. _class_ParticlesMaterial_property_damping_random: - :ref:`float` **damping_random** @@ -398,7 +440,7 @@ Damping will vary along this :ref:`CurveTexture`. Damping randomness ratio. Default value: ``0``. -.. _class_ParticlesMaterial_emission_box_extents: +.. _class_ParticlesMaterial_property_emission_box_extents: - :ref:`Vector3` **emission_box_extents** @@ -410,7 +452,7 @@ Damping randomness ratio. Default value: ``0``. The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. -.. _class_ParticlesMaterial_emission_color_texture: +.. _class_ParticlesMaterial_property_emission_color_texture: - :ref:`Texture` **emission_color_texture** @@ -420,7 +462,7 @@ The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. | *Getter* | get_emission_color_texture() | +----------+-----------------------------------+ -.. _class_ParticlesMaterial_emission_normal_texture: +.. _class_ParticlesMaterial_property_emission_normal_texture: - :ref:`Texture` **emission_normal_texture** @@ -430,7 +472,7 @@ The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. | *Getter* | get_emission_normal_texture() | +----------+------------------------------------+ -.. _class_ParticlesMaterial_emission_point_count: +.. _class_ParticlesMaterial_property_emission_point_count: - :ref:`int` **emission_point_count** @@ -442,7 +484,7 @@ The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_POINTS`` or ``EMISSION_SHAPE_DIRECTED_POINTS``. -.. _class_ParticlesMaterial_emission_point_texture: +.. _class_ParticlesMaterial_property_emission_point_texture: - :ref:`Texture` **emission_point_texture** @@ -452,7 +494,7 @@ The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_P | *Getter* | get_emission_point_texture() | +----------+-----------------------------------+ -.. _class_ParticlesMaterial_emission_shape: +.. _class_ParticlesMaterial_property_emission_shape: - :ref:`EmissionShape` **emission_shape** @@ -464,7 +506,7 @@ The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_P Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. Default value: ``EMISSION_SHAPE_POINT``. -.. _class_ParticlesMaterial_emission_sphere_radius: +.. _class_ParticlesMaterial_property_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** @@ -476,7 +518,7 @@ Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. -.. _class_ParticlesMaterial_flag_align_y: +.. _class_ParticlesMaterial_property_flag_align_y: - :ref:`bool` **flag_align_y** @@ -486,7 +528,7 @@ The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. | *Getter* | get_flag() | +----------+-----------------+ -.. _class_ParticlesMaterial_flag_disable_z: +.. _class_ParticlesMaterial_property_flag_disable_z: - :ref:`bool` **flag_disable_z** @@ -498,7 +540,7 @@ The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. If ``true``, particles will not move on the z axis. Default value: ``true`` for :ref:`Particles2D`, ``false`` for :ref:`Particles`. -.. _class_ParticlesMaterial_flag_rotate_y: +.. _class_ParticlesMaterial_property_flag_rotate_y: - :ref:`bool` **flag_rotate_y** @@ -508,7 +550,7 @@ If ``true``, particles will not move on the z axis. Default value: ``true`` for | *Getter* | get_flag() | +----------+-----------------+ -.. _class_ParticlesMaterial_flatness: +.. _class_ParticlesMaterial_property_flatness: - :ref:`float` **flatness** @@ -518,7 +560,7 @@ If ``true``, particles will not move on the z axis. Default value: ``true`` for | *Getter* | get_flatness() | +----------+---------------------+ -.. _class_ParticlesMaterial_gravity: +.. _class_ParticlesMaterial_property_gravity: - :ref:`Vector3` **gravity** @@ -530,7 +572,7 @@ If ``true``, particles will not move on the z axis. Default value: ``true`` for Gravity applied to every particle. Default value: ``(0, 98, 0)``. -.. _class_ParticlesMaterial_hue_variation: +.. _class_ParticlesMaterial_property_hue_variation: - :ref:`float` **hue_variation** @@ -542,7 +584,7 @@ Gravity applied to every particle. Default value: ``(0, 98, 0)``. Initial hue variation applied to each particle. -.. _class_ParticlesMaterial_hue_variation_curve: +.. _class_ParticlesMaterial_property_hue_variation_curve: - :ref:`Texture` **hue_variation_curve** @@ -554,7 +596,7 @@ Initial hue variation applied to each particle. Each particle's hue will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_hue_variation_random: +.. _class_ParticlesMaterial_property_hue_variation_random: - :ref:`float` **hue_variation_random** @@ -566,7 +608,7 @@ Each particle's hue will vary along this :ref:`CurveTexture` Hue variation randomness ratio. Default value: ``0``. -.. _class_ParticlesMaterial_initial_velocity: +.. _class_ParticlesMaterial_property_initial_velocity: - :ref:`float` **initial_velocity** @@ -578,7 +620,7 @@ Hue variation randomness ratio. Default value: ``0``. Initial velocity for each particle. -.. _class_ParticlesMaterial_initial_velocity_random: +.. _class_ParticlesMaterial_property_initial_velocity_random: - :ref:`float` **initial_velocity_random** @@ -590,7 +632,7 @@ Initial velocity for each particle. Initial velocity randomness ratio. Default value: ``0``. -.. _class_ParticlesMaterial_linear_accel: +.. _class_ParticlesMaterial_property_linear_accel: - :ref:`float` **linear_accel** @@ -602,7 +644,7 @@ Initial velocity randomness ratio. Default value: ``0``. Linear acceleration applied to each particle. -.. _class_ParticlesMaterial_linear_accel_curve: +.. _class_ParticlesMaterial_property_linear_accel_curve: - :ref:`Texture` **linear_accel_curve** @@ -614,7 +656,7 @@ Linear acceleration applied to each particle. Each particle's linear acceleration will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_linear_accel_random: +.. _class_ParticlesMaterial_property_linear_accel_random: - :ref:`float` **linear_accel_random** @@ -626,7 +668,7 @@ Each particle's linear acceleration will vary along this :ref:`CurveTexture` **orbit_velocity** @@ -638,7 +680,7 @@ Linear acceleration randomness ratio. Default value: ``0``. Orbital velocity applied to each particle. -.. _class_ParticlesMaterial_orbit_velocity_curve: +.. _class_ParticlesMaterial_property_orbit_velocity_curve: - :ref:`Texture` **orbit_velocity_curve** @@ -650,7 +692,7 @@ Orbital velocity applied to each particle. Each particle's orbital velocity will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_orbit_velocity_random: +.. _class_ParticlesMaterial_property_orbit_velocity_random: - :ref:`float` **orbit_velocity_random** @@ -662,7 +704,7 @@ Each particle's orbital velocity will vary along this :ref:`CurveTexture` **radial_accel** @@ -674,7 +716,7 @@ Orbital velocity randomness ratio. Default value: ``0``. Radial acceleration applied to each particle. -.. _class_ParticlesMaterial_radial_accel_curve: +.. _class_ParticlesMaterial_property_radial_accel_curve: - :ref:`Texture` **radial_accel_curve** @@ -686,7 +728,7 @@ Radial acceleration applied to each particle. Each particle's radial acceleration will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_radial_accel_random: +.. _class_ParticlesMaterial_property_radial_accel_random: - :ref:`float` **radial_accel_random** @@ -698,7 +740,7 @@ Each particle's radial acceleration will vary along this :ref:`CurveTexture` **scale** @@ -710,7 +752,7 @@ Radial acceleration randomness ratio. Default value: ``0``. Initial scale applied to each particle. -.. _class_ParticlesMaterial_scale_curve: +.. _class_ParticlesMaterial_property_scale_curve: - :ref:`Texture` **scale_curve** @@ -722,7 +764,7 @@ Initial scale applied to each particle. Each particle's scale will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_scale_random: +.. _class_ParticlesMaterial_property_scale_random: - :ref:`float` **scale_random** @@ -734,7 +776,7 @@ Each particle's scale will vary along this :ref:`CurveTexture` **spread** @@ -746,7 +788,7 @@ Scale randomness ratio. Default value: ``0``. Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. -.. _class_ParticlesMaterial_tangential_accel: +.. _class_ParticlesMaterial_property_tangential_accel: - :ref:`float` **tangential_accel** @@ -758,7 +800,7 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity. -.. _class_ParticlesMaterial_tangential_accel_curve: +.. _class_ParticlesMaterial_property_tangential_accel_curve: - :ref:`Texture` **tangential_accel_curve** @@ -770,7 +812,7 @@ Tangential acceleration applied to each particle. Tangential acceleration is per Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. -.. _class_ParticlesMaterial_tangential_accel_random: +.. _class_ParticlesMaterial_property_tangential_accel_random: - :ref:`float` **tangential_accel_random** @@ -782,7 +824,7 @@ Each particle's tangential acceleration will vary along this :ref:`CurveTexture< Tangential acceleration randomness ratio. Default value: ``0``. -.. _class_ParticlesMaterial_trail_color_modifier: +.. _class_ParticlesMaterial_property_trail_color_modifier: - :ref:`GradientTexture` **trail_color_modifier** @@ -794,7 +836,7 @@ Tangential acceleration randomness ratio. Default value: ``0``. Trail particles' color will vary along this :ref:`GradientTexture`. -.. _class_ParticlesMaterial_trail_divisor: +.. _class_ParticlesMaterial_property_trail_divisor: - :ref:`int` **trail_divisor** @@ -806,7 +848,7 @@ Trail particles' color will vary along this :ref:`GradientTexture` **trail_size_modifier** diff --git a/classes/class_path.rst b/classes/class_path.rst index 424b3062f..597e54d21 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -19,14 +19,14 @@ Container for a :ref:`Curve3D`. Properties ---------- -+-------------------------------+--------------------------------+ -| :ref:`Curve3D` | :ref:`curve` | -+-------------------------------+--------------------------------+ ++-------------------------------+-----------------------------------------+ +| :ref:`Curve3D` | :ref:`curve` | ++-------------------------------+-----------------------------------------+ Signals ------- -.. _class_Path_curve_changed: +.. _class_Path_signal_curve_changed: - **curve_changed** **(** **)** @@ -38,7 +38,7 @@ This class is a container/Node-ification of a :ref:`Curve3D`, so Property Descriptions --------------------- -.. _class_Path_curve: +.. _class_Path_property_curve: - :ref:`Curve3D` **curve** diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index e74461f64..d6ca5a501 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -19,9 +19,9 @@ Contains a :ref:`Curve2D` path for :ref:`PathFollow2D` | :ref:`curve` | -+-------------------------------+----------------------------------+ ++-------------------------------+-------------------------------------------+ +| :ref:`Curve2D` | :ref:`curve` | ++-------------------------------+-------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Can have :ref:`PathFollow2D` child-nodes moving along the :r Property Descriptions --------------------- -.. _class_Path2D_curve: +.. _class_Path2D_property_curve: - :ref:`Curve2D` **curve** diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index 927fd5a7f..d35397739 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -19,27 +19,35 @@ Point sampler for a :ref:`Path`. Properties ---------- -+---------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`cubic_interp` | -+---------------------------------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`h_offset` | -+---------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`loop` | -+---------------------------------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`offset` | -+---------------------------------------------------+------------------------------------------------------+ -| :ref:`RotationMode` | :ref:`rotation_mode` | -+---------------------------------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`unit_offset` | -+---------------------------------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`v_offset` | -+---------------------------------------------------+------------------------------------------------------+ ++---------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`cubic_interp` | ++---------------------------------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`h_offset` | ++---------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`loop` | ++---------------------------------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`offset` | ++---------------------------------------------------+---------------------------------------------------------------+ +| :ref:`RotationMode` | :ref:`rotation_mode` | ++---------------------------------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`unit_offset` | ++---------------------------------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`v_offset` | ++---------------------------------------------------+---------------------------------------------------------------+ Enumerations ------------ .. _enum_PathFollow_RotationMode: +.. _class_PathFollow_constant_ROTATION_NONE: + +.. _class_PathFollow_constant_ROTATION_Y: + +.. _class_PathFollow_constant_ROTATION_XY: + +.. _class_PathFollow_constant_ROTATION_XYZ: + enum **RotationMode**: - **ROTATION_NONE** = **0** --- Forbids the PathFollow to rotate. @@ -60,7 +68,7 @@ It is useful for making other nodes follow a path, without coding the movement p Property Descriptions --------------------- -.. _class_PathFollow_cubic_interp: +.. _class_PathFollow_property_cubic_interp: - :ref:`bool` **cubic_interp** @@ -76,7 +84,7 @@ The points along the :ref:`Curve3D` of the :ref:`Path There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. -.. _class_PathFollow_h_offset: +.. _class_PathFollow_property_h_offset: - :ref:`float` **h_offset** @@ -88,7 +96,7 @@ There are two answers to this problem: Either increase the number of cached poin The node's offset along the curve. -.. _class_PathFollow_loop: +.. _class_PathFollow_property_loop: - :ref:`bool` **loop** @@ -100,7 +108,7 @@ The node's offset along the curve. If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. -.. _class_PathFollow_offset: +.. _class_PathFollow_property_offset: - :ref:`float` **offset** @@ -112,7 +120,7 @@ If ``true``, any offset outside the path's length will wrap around, instead of s The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. -.. _class_PathFollow_rotation_mode: +.. _class_PathFollow_property_rotation_mode: - :ref:`RotationMode` **rotation_mode** @@ -124,7 +132,7 @@ The distance from the first vertex, measured in 3D units along the path. This se Allows or forbids rotation on one or more axes, depending on the constants being used. -.. _class_PathFollow_unit_offset: +.. _class_PathFollow_property_unit_offset: - :ref:`float` **unit_offset** @@ -136,7 +144,7 @@ Allows or forbids rotation on one or more axes, depending on the constants being The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. -.. _class_PathFollow_v_offset: +.. _class_PathFollow_property_v_offset: - :ref:`float` **v_offset** diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index 4d7b80dac..c28797c34 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -19,23 +19,23 @@ Point sampler for a :ref:`Path2D`. Properties ---------- -+---------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`cubic_interp` | -+---------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`h_offset` | -+---------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`lookahead` | -+---------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`loop` | -+---------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`offset` | -+---------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`rotate` | -+---------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`unit_offset` | -+---------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`v_offset` | -+---------------------------+------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`cubic_interp` | ++---------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`h_offset` | ++---------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`lookahead` | ++---------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`loop` | ++---------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`offset` | ++---------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`rotate` | ++---------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`unit_offset` | ++---------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`v_offset` | ++---------------------------+---------------------------------------------------------------+ Description ----------- @@ -47,7 +47,7 @@ It is useful for making other nodes follow a path, without coding the movement p Property Descriptions --------------------- -.. _class_PathFollow2D_cubic_interp: +.. _class_PathFollow2D_property_cubic_interp: - :ref:`bool` **cubic_interp** @@ -63,7 +63,7 @@ The points along the :ref:`Curve2D` of the :ref:`Path2D` **h_offset** @@ -75,7 +75,7 @@ There are two answers to this problem: Either increase the number of cached poin The node's offset along the curve. -.. _class_PathFollow2D_lookahead: +.. _class_PathFollow2D_property_lookahead: - :ref:`float` **lookahead** @@ -87,7 +87,7 @@ The node's offset along the curve. How far to look ahead of the curve to calculate the tangent if the node is rotating. E.g. shorter lookaheads will lead to faster rotations. Default value: ``4``. -.. _class_PathFollow2D_loop: +.. _class_PathFollow2D_property_loop: - :ref:`bool` **loop** @@ -99,7 +99,7 @@ How far to look ahead of the curve to calculate the tangent if the node is rotat If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. -.. _class_PathFollow2D_offset: +.. _class_PathFollow2D_property_offset: - :ref:`float` **offset** @@ -111,7 +111,7 @@ If ``true``, any offset outside the path's length will wrap around, instead of s The distance along the path in pixels. -.. _class_PathFollow2D_rotate: +.. _class_PathFollow2D_property_rotate: - :ref:`bool` **rotate** @@ -123,7 +123,7 @@ The distance along the path in pixels. If ``true``, this node rotates to follow the path, making its descendants rotate. -.. _class_PathFollow2D_unit_offset: +.. _class_PathFollow2D_property_unit_offset: - :ref:`float` **unit_offset** @@ -135,7 +135,7 @@ If ``true``, this node rotates to follow the path, making its descendants rotate The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. -.. _class_PathFollow2D_v_offset: +.. _class_PathFollow2D_property_v_offset: - :ref:`float` **v_offset** diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 935c14826..225484469 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -19,26 +19,26 @@ Brief Description Methods ------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`add_file` **(** :ref:`String` pck_path, :ref:`String` source_path **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`flush` **(** :ref:`bool` verbose **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`pck_start` **(** :ref:`String` pck_name, :ref:`int` alignment **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`add_file` **(** :ref:`String` pck_path, :ref:`String` source_path **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`flush` **(** :ref:`bool` verbose **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`pck_start` **(** :ref:`String` pck_name, :ref:`int` alignment **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_PCKPacker_add_file: +.. _class_PCKPacker_method_add_file: - :ref:`Error` **add_file** **(** :ref:`String` pck_path, :ref:`String` source_path **)** -.. _class_PCKPacker_flush: +.. _class_PCKPacker_method_flush: - :ref:`Error` **flush** **(** :ref:`bool` verbose **)** -.. _class_PCKPacker_pck_start: +.. _class_PCKPacker_method_pck_start: - :ref:`Error` **pck_start** **(** :ref:`String` pck_name, :ref:`int` alignment **)** diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 5cdb82213..81d2558e3 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -19,15 +19,73 @@ Exposes performance related data. Methods ------- -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_monitor` **(** :ref:`Monitor` monitor **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_monitor` **(** :ref:`Monitor` monitor **)** const | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Performance_Monitor: +.. _class_Performance_constant_TIME_FPS: + +.. _class_Performance_constant_TIME_PROCESS: + +.. _class_Performance_constant_TIME_PHYSICS_PROCESS: + +.. _class_Performance_constant_MEMORY_STATIC: + +.. _class_Performance_constant_MEMORY_DYNAMIC: + +.. _class_Performance_constant_MEMORY_STATIC_MAX: + +.. _class_Performance_constant_MEMORY_DYNAMIC_MAX: + +.. _class_Performance_constant_MEMORY_MESSAGE_BUFFER_MAX: + +.. _class_Performance_constant_OBJECT_COUNT: + +.. _class_Performance_constant_OBJECT_RESOURCE_COUNT: + +.. _class_Performance_constant_OBJECT_NODE_COUNT: + +.. _class_Performance_constant_RENDER_OBJECTS_IN_FRAME: + +.. _class_Performance_constant_RENDER_VERTICES_IN_FRAME: + +.. _class_Performance_constant_RENDER_MATERIAL_CHANGES_IN_FRAME: + +.. _class_Performance_constant_RENDER_SHADER_CHANGES_IN_FRAME: + +.. _class_Performance_constant_RENDER_SURFACE_CHANGES_IN_FRAME: + +.. _class_Performance_constant_RENDER_DRAW_CALLS_IN_FRAME: + +.. _class_Performance_constant_RENDER_VIDEO_MEM_USED: + +.. _class_Performance_constant_RENDER_TEXTURE_MEM_USED: + +.. _class_Performance_constant_RENDER_VERTEX_MEM_USED: + +.. _class_Performance_constant_RENDER_USAGE_VIDEO_MEM_TOTAL: + +.. _class_Performance_constant_PHYSICS_2D_ACTIVE_OBJECTS: + +.. _class_Performance_constant_PHYSICS_2D_COLLISION_PAIRS: + +.. _class_Performance_constant_PHYSICS_2D_ISLAND_COUNT: + +.. _class_Performance_constant_PHYSICS_3D_ACTIVE_OBJECTS: + +.. _class_Performance_constant_PHYSICS_3D_COLLISION_PAIRS: + +.. _class_Performance_constant_PHYSICS_3D_ISLAND_COUNT: + +.. _class_Performance_constant_AUDIO_OUTPUT_LATENCY: + +.. _class_Performance_constant_MONITOR_MAX: + enum **Monitor**: - **TIME_FPS** = **0** --- Frames per second. @@ -91,14 +149,14 @@ enum **Monitor**: Description ----------- -This class provides access to a number of different monitors related to performance, such as memory usage, draw calls, and FPS. These are the same as the values displayed in the *Monitor* tab in the editor's *Debugger* panel. By using the :ref:`get_monitor` method of this class, you can access this data from your code. Note that a few of these monitors are only available in debug mode and will always return 0 when used in a release build. +This class provides access to a number of different monitors related to performance, such as memory usage, draw calls, and FPS. These are the same as the values displayed in the *Monitor* tab in the editor's *Debugger* panel. By using the :ref:`get_monitor` method of this class, you can access this data from your code. Note that a few of these monitors are only available in debug mode and will always return 0 when used in a release build. Many of these monitors are not updated in real-time, so there may be a short delay between changes. Method Descriptions ------------------- -.. _class_Performance_get_monitor: +.. _class_Performance_method_get_monitor: - :ref:`float` **get_monitor** **(** :ref:`Monitor` monitor **)** const diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index fa00aec09..fc57d1344 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -19,9 +19,9 @@ Optimized translation. Methods ------- -+-------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate` **(** :ref:`Translation` from **)** | -+-------+---------------------------------------------------------------------------------------------------------+ ++------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate` **(** :ref:`Translation` from **)** | ++------+----------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Optimized translation. Uses real-time compressed translations, which results in Method Descriptions ------------------- -.. _class_PHashTranslation_generate: +.. _class_PHashTranslation_method_generate: - void **generate** **(** :ref:`Translation` from **)** diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index 77a5bc64d..9eda4abb0 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -19,42 +19,54 @@ Brief Description Properties ---------- -+-----------------------------------------------+--------------------------------------------------------+ -| :ref:`Transform` | :ref:`body_offset` | -+-----------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_scale` | -+-----------------------------------------------+--------------------------------------------------------+ -| :ref:`Transform` | :ref:`joint_offset` | -+-----------------------------------------------+--------------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_type` | -+-----------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`mass` | -+-----------------------------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`weight` | -+-----------------------------------------------+--------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------+ +| :ref:`Transform` | :ref:`body_offset` | ++-----------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`bounce` | ++-----------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`friction` | ++-----------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`gravity_scale` | ++-----------------------------------------------+-----------------------------------------------------------------+ +| :ref:`Transform` | :ref:`joint_offset` | ++-----------------------------------------------+-----------------------------------------------------------------+ +| :ref:`JointType` | :ref:`joint_type` | ++-----------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`mass` | ++-----------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`weight` | ++-----------------------------------------------+-----------------------------------------------------------------+ Methods ------- -+--------------------------+------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_id` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_simulate_physics` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_simulating_physics` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_static_body` **(** **)** | -+--------------------------+------------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_id` **(** **)** const | ++-------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_simulate_physics` **(** **)** | ++-------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_simulating_physics` **(** **)** | ++-------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_static_body` **(** **)** | ++-------------------------+-------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_PhysicalBone_JointType: +.. _class_PhysicalBone_constant_JOINT_TYPE_NONE: + +.. _class_PhysicalBone_constant_JOINT_TYPE_PIN: + +.. _class_PhysicalBone_constant_JOINT_TYPE_CONE: + +.. _class_PhysicalBone_constant_JOINT_TYPE_HINGE: + +.. _class_PhysicalBone_constant_JOINT_TYPE_SLIDER: + +.. _class_PhysicalBone_constant_JOINT_TYPE_6DOF: + enum **JointType**: - **JOINT_TYPE_NONE** = **0** @@ -72,7 +84,7 @@ enum **JointType**: Property Descriptions --------------------- -.. _class_PhysicalBone_body_offset: +.. _class_PhysicalBone_property_body_offset: - :ref:`Transform` **body_offset** @@ -82,7 +94,7 @@ Property Descriptions | *Getter* | get_body_offset() | +----------+------------------------+ -.. _class_PhysicalBone_bounce: +.. _class_PhysicalBone_property_bounce: - :ref:`float` **bounce** @@ -92,7 +104,7 @@ Property Descriptions | *Getter* | get_bounce() | +----------+-------------------+ -.. _class_PhysicalBone_friction: +.. _class_PhysicalBone_property_friction: - :ref:`float` **friction** @@ -102,7 +114,7 @@ Property Descriptions | *Getter* | get_friction() | +----------+---------------------+ -.. _class_PhysicalBone_gravity_scale: +.. _class_PhysicalBone_property_gravity_scale: - :ref:`float` **gravity_scale** @@ -112,7 +124,7 @@ Property Descriptions | *Getter* | get_gravity_scale() | +----------+--------------------------+ -.. _class_PhysicalBone_joint_offset: +.. _class_PhysicalBone_property_joint_offset: - :ref:`Transform` **joint_offset** @@ -122,7 +134,7 @@ Property Descriptions | *Getter* | get_joint_offset() | +----------+-------------------------+ -.. _class_PhysicalBone_joint_type: +.. _class_PhysicalBone_property_joint_type: - :ref:`JointType` **joint_type** @@ -132,7 +144,7 @@ Property Descriptions | *Getter* | get_joint_type() | +----------+-----------------------+ -.. _class_PhysicalBone_mass: +.. _class_PhysicalBone_property_mass: - :ref:`float` **mass** @@ -142,7 +154,7 @@ Property Descriptions | *Getter* | get_mass() | +----------+-----------------+ -.. _class_PhysicalBone_weight: +.. _class_PhysicalBone_property_weight: - :ref:`float` **weight** @@ -155,19 +167,19 @@ Property Descriptions Method Descriptions ------------------- -.. _class_PhysicalBone_get_bone_id: +.. _class_PhysicalBone_method_get_bone_id: - :ref:`int` **get_bone_id** **(** **)** const -.. _class_PhysicalBone_get_simulate_physics: +.. _class_PhysicalBone_method_get_simulate_physics: - :ref:`bool` **get_simulate_physics** **(** **)** -.. _class_PhysicalBone_is_simulating_physics: +.. _class_PhysicalBone_method_is_simulating_physics: - :ref:`bool` **is_simulating_physics** **(** **)** -.. _class_PhysicalBone_is_static_body: +.. _class_PhysicalBone_method_is_static_body: - :ref:`bool` **is_static_body** **(** **)** diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 4e1cae62e..e0c21cc2c 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -21,70 +21,70 @@ Direct access object to a physics body in the :ref:`Physics2DServer` | :ref:`angular_velocity` | -+---------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inverse_inertia` | -+---------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inverse_mass` | -+---------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`linear_velocity` | -+---------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sleeping` | -+---------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`step` | -+---------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`total_angular_damp` | -+---------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`total_gravity` | -+---------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`total_linear_damp` | -+---------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | -+---------------------------------------+------------------------------------------------------------------------------+ ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity` | ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_inertia` | ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_mass` | ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`linear_velocity` | ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`sleeping` | ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`step` | ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_angular_damp` | ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`total_gravity` | ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_linear_damp` | ++---------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`transform` | ++---------------------------------------+---------------------------------------------------------------------------------------+ 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` **(** **)** | ++-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -94,7 +94,7 @@ Direct access object to a physics body in the :ref:`Physics2DServer` **angular_velocity** @@ -106,7 +106,7 @@ Property Descriptions The angular velocity of the body. -.. _class_Physics2DDirectBodyState_inverse_inertia: +.. _class_Physics2DDirectBodyState_property_inverse_inertia: - :ref:`float` **inverse_inertia** @@ -116,7 +116,7 @@ The angular velocity of the body. The inverse of the inertia of the body. -.. _class_Physics2DDirectBodyState_inverse_mass: +.. _class_Physics2DDirectBodyState_property_inverse_mass: - :ref:`float` **inverse_mass** @@ -126,7 +126,7 @@ The inverse of the inertia of the body. The inverse of the mass of the body. -.. _class_Physics2DDirectBodyState_linear_velocity: +.. _class_Physics2DDirectBodyState_property_linear_velocity: - :ref:`Vector2` **linear_velocity** @@ -138,7 +138,7 @@ The inverse of the mass of the body. The linear velocity of the body. -.. _class_Physics2DDirectBodyState_sleeping: +.. _class_Physics2DDirectBodyState_property_sleeping: - :ref:`bool` **sleeping** @@ -150,7 +150,7 @@ The linear velocity of the body. ``true`` if this body is currently sleeping (not active). -.. _class_Physics2DDirectBodyState_step: +.. _class_Physics2DDirectBodyState_property_step: - :ref:`float` **step** @@ -160,7 +160,7 @@ The linear velocity of the body. The timestep (delta) used for the simulation. -.. _class_Physics2DDirectBodyState_total_angular_damp: +.. _class_Physics2DDirectBodyState_property_total_angular_damp: - :ref:`float` **total_angular_damp** @@ -170,7 +170,7 @@ The timestep (delta) used for the simulation. The rate at which the body stops rotating, if there are not any other forces moving it. -.. _class_Physics2DDirectBodyState_total_gravity: +.. _class_Physics2DDirectBodyState_property_total_gravity: - :ref:`Vector2` **total_gravity** @@ -180,7 +180,7 @@ The rate at which the body stops rotating, if there are not any other forces mov The total gravity vector being currently applied to this body. -.. _class_Physics2DDirectBodyState_total_linear_damp: +.. _class_Physics2DDirectBodyState_property_total_linear_damp: - :ref:`float` **total_linear_damp** @@ -190,7 +190,7 @@ The total gravity vector being currently applied to this body. The rate at which the body stops moving, if there are not any other forces moving it. -.. _class_Physics2DDirectBodyState_transform: +.. _class_Physics2DDirectBodyState_property_transform: - :ref:`Transform2D` **transform** @@ -205,103 +205,103 @@ The transformation matrix of the body. Method Descriptions ------------------- -.. _class_Physics2DDirectBodyState_add_central_force: +.. _class_Physics2DDirectBodyState_method_add_central_force: - void **add_central_force** **(** :ref:`Vector2` force **)** -.. _class_Physics2DDirectBodyState_add_force: +.. _class_Physics2DDirectBodyState_method_add_force: - void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** -.. _class_Physics2DDirectBodyState_add_torque: +.. _class_Physics2DDirectBodyState_method_add_torque: - void **add_torque** **(** :ref:`float` torque **)** -.. _class_Physics2DDirectBodyState_apply_central_impulse: +.. _class_Physics2DDirectBodyState_method_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** -.. _class_Physics2DDirectBodyState_apply_impulse: +.. _class_Physics2DDirectBodyState_method_apply_impulse: - void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** -.. _class_Physics2DDirectBodyState_apply_torque_impulse: +.. _class_Physics2DDirectBodyState_method_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`float` impulse **)** -.. _class_Physics2DDirectBodyState_get_contact_collider: +.. _class_Physics2DDirectBodyState_method_get_contact_collider: - :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const Return the :ref:`RID` of the collider. -.. _class_Physics2DDirectBodyState_get_contact_collider_id: +.. _class_Physics2DDirectBodyState_method_get_contact_collider_id: - :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const Return the object id of the collider. -.. _class_Physics2DDirectBodyState_get_contact_collider_object: +.. _class_Physics2DDirectBodyState_method_get_contact_collider_object: - :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const Return the collider object, this depends on how it was created (will return a scene node if such was used to create it). -.. _class_Physics2DDirectBodyState_get_contact_collider_position: +.. _class_Physics2DDirectBodyState_method_get_contact_collider_position: - :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const Return the contact position in the collider. -.. _class_Physics2DDirectBodyState_get_contact_collider_shape: +.. _class_Physics2DDirectBodyState_method_get_contact_collider_shape: - :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const Return the collider shape index. -.. _class_Physics2DDirectBodyState_get_contact_collider_shape_metadata: +.. _class_Physics2DDirectBodyState_method_get_contact_collider_shape_metadata: - :ref:`Variant` **get_contact_collider_shape_metadata** **(** :ref:`int` contact_idx **)** const -Return the metadata of the collided shape. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. +Return the metadata of the collided shape. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. -.. _class_Physics2DDirectBodyState_get_contact_collider_velocity_at_position: +.. _class_Physics2DDirectBodyState_method_get_contact_collider_velocity_at_position: - :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const Return the linear velocity vector at contact point of the collider. -.. _class_Physics2DDirectBodyState_get_contact_count: +.. _class_Physics2DDirectBodyState_method_get_contact_count: - :ref:`int` **get_contact_count** **(** **)** const Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. -.. _class_Physics2DDirectBodyState_get_contact_local_normal: +.. _class_Physics2DDirectBodyState_method_get_contact_local_normal: - :ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const Return the local normal (of this body) of the contact point. -.. _class_Physics2DDirectBodyState_get_contact_local_position: +.. _class_Physics2DDirectBodyState_method_get_contact_local_position: - :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const Return the local position (of this body) of the contact point. -.. _class_Physics2DDirectBodyState_get_contact_local_shape: +.. _class_Physics2DDirectBodyState_method_get_contact_local_shape: - :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const Return the local shape index of the collision. -.. _class_Physics2DDirectBodyState_get_space_state: +.. _class_Physics2DDirectBodyState_method_get_space_state: - :ref:`Physics2DDirectSpaceState` **get_space_state** **(** **)** Return the current state of space, useful for queries. -.. _class_Physics2DDirectBodyState_integrate_forces: +.. _class_Physics2DDirectBodyState_method_integrate_forces: - void **integrate_forces** **(** **)** diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index 5faf3e498..bb785491f 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -19,21 +19,21 @@ Direct access object to a space in the :ref:`Physics2DServer` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point_on_canvas` **(** :ref:`Vector2` point, :ref:`int` canvas_instance_id, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_point_on_canvas` **(** :ref:`Vector2` point, :ref:`int` canvas_instance_id, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -48,7 +48,7 @@ Tutorials Method Descriptions ------------------- -.. _class_Physics2DDirectSpaceState_cast_motion: +.. _class_Physics2DDirectSpaceState_method_cast_motion: - :ref:`Array` **cast_motion** **(** :ref:`Physics2DShapeQueryParameters` shape **)** @@ -56,13 +56,13 @@ Checks how far the shape can travel toward a point. Note that both the shape and If the shape can not move, the array will be empty. -.. _class_Physics2DDirectSpaceState_collide_shape: +.. _class_Physics2DDirectSpaceState_method_collide_shape: - :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** -Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. +Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. -.. _class_Physics2DDirectSpaceState_get_rest_info: +.. _class_Physics2DDirectSpaceState_method_get_rest_info: - :ref:`Dictionary` **get_rest_info** **(** :ref:`Physics2DShapeQueryParameters` shape **)** @@ -72,7 +72,7 @@ Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryPa ``linear_velocity``: The colliding object's velocity :ref:`Vector2`. If the object is an :ref:`Area2D`, the result is ``(0, 0)``. -``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. +``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. ``normal``: The object's surface normal at the intersection point. @@ -84,7 +84,7 @@ Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryPa If the shape did not intersect anything, then an empty dictionary is returned instead. -.. _class_Physics2DDirectSpaceState_intersect_point: +.. _class_Physics2DDirectSpaceState_method_intersect_point: - :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** @@ -94,7 +94,7 @@ Checks whether a point is inside any shape. The shapes the point is inside of ar ``collider_id``: The colliding object's ID. -``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. +``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. ``rid``: The intersecting object's :ref:`RID`. @@ -102,11 +102,11 @@ Checks whether a point is inside any shape. The shapes the point is inside of ar Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody`\ s or :ref:`Area`\ s, respectively. -.. _class_Physics2DDirectSpaceState_intersect_point_on_canvas: +.. _class_Physics2DDirectSpaceState_method_intersect_point_on_canvas: - :ref:`Array` **intersect_point_on_canvas** **(** :ref:`Vector2` point, :ref:`int` canvas_instance_id, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** -.. _class_Physics2DDirectSpaceState_intersect_ray: +.. _class_Physics2DDirectSpaceState_method_intersect_ray: - :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** @@ -116,7 +116,7 @@ Intersects a ray in a given space. The returned object is a dictionary with the ``collider_id``: The colliding object's ID. -``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. +``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. ``normal``: The object's surface normal at the intersection point. @@ -130,7 +130,7 @@ If the ray did not intersect anything, then an empty dictionary is returned inst Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody`\ s or :ref:`Area`\ s, respectively. -.. _class_Physics2DDirectSpaceState_intersect_shape: +.. _class_Physics2DDirectSpaceState_method_intersect_shape: - :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** @@ -140,7 +140,7 @@ Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryPa ``collider_id``: The colliding object's ID. -``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. +``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. ``rid``: The intersecting object's :ref:`RID`. diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 9f8456950..87b72afb8 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -21,217 +21,231 @@ Physics 2D Server. Methods ------- -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_canvas_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`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:`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:`RID` | :ref:`area_get_space` **(** :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 | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`float` impulse **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_canvas_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_mask` **(** :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:`BodyMode` | :ref:`body_get_mode` **(** :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:`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:`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:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** 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 | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`CCDMode` mode **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`bool` infinite_inertia, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`capsule_shape_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`circle_shape_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`concave_polygon_shape_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`convex_polygon_shape_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`DampedStringParam` param, :ref:`float` value **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`line_shape_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`ray_shape_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`rectangle_shape_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`segment_shape_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shape_get_data` **(** :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:`RID` | :ref:`space_create` **(** **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | -+---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_attach_canvas_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`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:`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:`RID` | :ref:`area_get_space` **(** :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 | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`float` impulse **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_attach_canvas_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_mask` **(** :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:`BodyMode` | :ref:`body_get_mode` **(** :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:`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:`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:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** 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 | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`CCDMode` mode **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`bool` infinite_inertia, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`capsule_shape_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`circle_shape_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`concave_polygon_shape_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`convex_polygon_shape_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`DampedStringParam` param, :ref:`float` value **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`line_shape_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`ray_shape_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`rectangle_shape_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`segment_shape_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`shape_get_data` **(** :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:`RID` | :ref:`space_create` **(** **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | ++--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Physics2DServer_SpaceParameter: +.. _class_Physics2DServer_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS: + +.. _class_Physics2DServer_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION: + +.. _class_Physics2DServer_constant_SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION: + +.. _class_Physics2DServer_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD: + +.. _class_Physics2DServer_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD: + +.. _class_Physics2DServer_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP: + +.. _class_Physics2DServer_constant_SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS: + enum **SpaceParameter**: - **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** --- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. @@ -250,6 +264,24 @@ enum **SpaceParameter**: .. _enum_Physics2DServer_ShapeType: +.. _class_Physics2DServer_constant_SHAPE_LINE: + +.. _class_Physics2DServer_constant_SHAPE_RAY: + +.. _class_Physics2DServer_constant_SHAPE_SEGMENT: + +.. _class_Physics2DServer_constant_SHAPE_CIRCLE: + +.. _class_Physics2DServer_constant_SHAPE_RECTANGLE: + +.. _class_Physics2DServer_constant_SHAPE_CAPSULE: + +.. _class_Physics2DServer_constant_SHAPE_CONVEX_POLYGON: + +.. _class_Physics2DServer_constant_SHAPE_CONCAVE_POLYGON: + +.. _class_Physics2DServer_constant_SHAPE_CUSTOM: + enum **ShapeType**: - **SHAPE_LINE** = **0** --- This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks. @@ -264,7 +296,7 @@ enum **ShapeType**: - **SHAPE_CAPSULE** = **5** --- This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks. -- **SHAPE_CONVEX_POLYGON** = **6** --- This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method :ref:`CollisionPolygon2D.set_polygon`, polygons modified with :ref:`shape_set_data` do not verify that the points supplied form is a convex polygon. +- **SHAPE_CONVEX_POLYGON** = **6** --- This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method :ref:`CollisionPolygon2D.set_polygon`, polygons modified with :ref:`shape_set_data` do not verify that the points supplied form is a convex polygon. - **SHAPE_CONCAVE_POLYGON** = **7** --- This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks. @@ -272,6 +304,22 @@ enum **ShapeType**: .. _enum_Physics2DServer_AreaParameter: +.. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY: + +.. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_VECTOR: + +.. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_IS_POINT: + +.. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE: + +.. _class_Physics2DServer_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION: + +.. _class_Physics2DServer_constant_AREA_PARAM_LINEAR_DAMP: + +.. _class_Physics2DServer_constant_AREA_PARAM_ANGULAR_DAMP: + +.. _class_Physics2DServer_constant_AREA_PARAM_PRIORITY: + enum **AreaParameter**: - **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area. @@ -292,6 +340,16 @@ enum **AreaParameter**: .. _enum_Physics2DServer_AreaSpaceOverrideMode: +.. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_DISABLED: + +.. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_COMBINE: + +.. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE: + +.. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_REPLACE: + +.. _class_Physics2DServer_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE: + enum **AreaSpaceOverrideMode**: - **AREA_SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. @@ -306,6 +364,14 @@ enum **AreaSpaceOverrideMode**: .. _enum_Physics2DServer_BodyMode: +.. _class_Physics2DServer_constant_BODY_MODE_STATIC: + +.. _class_Physics2DServer_constant_BODY_MODE_KINEMATIC: + +.. _class_Physics2DServer_constant_BODY_MODE_RIGID: + +.. _class_Physics2DServer_constant_BODY_MODE_CHARACTER: + enum **BodyMode**: - **BODY_MODE_STATIC** = **0** --- Constant for static bodies. @@ -318,6 +384,22 @@ enum **BodyMode**: .. _enum_Physics2DServer_BodyParameter: +.. _class_Physics2DServer_constant_BODY_PARAM_BOUNCE: + +.. _class_Physics2DServer_constant_BODY_PARAM_FRICTION: + +.. _class_Physics2DServer_constant_BODY_PARAM_MASS: + +.. _class_Physics2DServer_constant_BODY_PARAM_INERTIA: + +.. _class_Physics2DServer_constant_BODY_PARAM_GRAVITY_SCALE: + +.. _class_Physics2DServer_constant_BODY_PARAM_LINEAR_DAMP: + +.. _class_Physics2DServer_constant_BODY_PARAM_ANGULAR_DAMP: + +.. _class_Physics2DServer_constant_BODY_PARAM_MAX: + enum **BodyParameter**: - **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor. @@ -338,6 +420,16 @@ enum **BodyParameter**: .. _enum_Physics2DServer_BodyState: +.. _class_Physics2DServer_constant_BODY_STATE_TRANSFORM: + +.. _class_Physics2DServer_constant_BODY_STATE_LINEAR_VELOCITY: + +.. _class_Physics2DServer_constant_BODY_STATE_ANGULAR_VELOCITY: + +.. _class_Physics2DServer_constant_BODY_STATE_SLEEPING: + +.. _class_Physics2DServer_constant_BODY_STATE_CAN_SLEEP: + enum **BodyState**: - **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body. @@ -352,6 +444,12 @@ enum **BodyState**: .. _enum_Physics2DServer_JointType: +.. _class_Physics2DServer_constant_JOINT_PIN: + +.. _class_Physics2DServer_constant_JOINT_GROOVE: + +.. _class_Physics2DServer_constant_JOINT_DAMPED_SPRING: + enum **JointType**: - **JOINT_PIN** = **0** --- Constant to create pin joints. @@ -362,6 +460,12 @@ enum **JointType**: .. _enum_Physics2DServer_JointParam: +.. _class_Physics2DServer_constant_JOINT_PARAM_BIAS: + +.. _class_Physics2DServer_constant_JOINT_PARAM_MAX_BIAS: + +.. _class_Physics2DServer_constant_JOINT_PARAM_MAX_FORCE: + enum **JointParam**: - **JOINT_PARAM_BIAS** = **0** @@ -372,6 +476,12 @@ enum **JointParam**: .. _enum_Physics2DServer_DampedStringParam: +.. _class_Physics2DServer_constant_DAMPED_STRING_REST_LENGTH: + +.. _class_Physics2DServer_constant_DAMPED_STRING_STIFFNESS: + +.. _class_Physics2DServer_constant_DAMPED_STRING_DAMPING: + enum **DampedStringParam**: - **DAMPED_STRING_REST_LENGTH** = **0** --- Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. @@ -382,6 +492,12 @@ enum **DampedStringParam**: .. _enum_Physics2DServer_CCDMode: +.. _class_Physics2DServer_constant_CCD_MODE_DISABLED: + +.. _class_Physics2DServer_constant_CCD_MODE_CAST_RAY: + +.. _class_Physics2DServer_constant_CCD_MODE_CAST_SHAPE: + enum **CCDMode**: - **CCD_MODE_DISABLED** = **0** --- Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. @@ -392,6 +508,10 @@ enum **CCDMode**: .. _enum_Physics2DServer_AreaBodyStatus: +.. _class_Physics2DServer_constant_AREA_BODY_ADDED: + +.. _class_Physics2DServer_constant_AREA_BODY_REMOVED: + enum **AreaBodyStatus**: - **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes. @@ -400,6 +520,12 @@ enum **AreaBodyStatus**: .. _enum_Physics2DServer_ProcessInfo: +.. _class_Physics2DServer_constant_INFO_ACTIVE_OBJECTS: + +.. _class_Physics2DServer_constant_INFO_COLLISION_PAIRS: + +.. _class_Physics2DServer_constant_INFO_ISLAND_COUNT: + enum **ProcessInfo**: - **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping. @@ -416,109 +542,109 @@ Physics 2D Server is the server responsible for all 2D physics. It can create ma Method Descriptions ------------------- -.. _class_Physics2DServer_area_add_shape: +.. _class_Physics2DServer_method_area_add_shape: - void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. -.. _class_Physics2DServer_area_attach_canvas_instance_id: +.. _class_Physics2DServer_method_area_attach_canvas_instance_id: - void **area_attach_canvas_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** -.. _class_Physics2DServer_area_attach_object_instance_id: +.. _class_Physics2DServer_method_area_attach_object_instance_id: - void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. -.. _class_Physics2DServer_area_clear_shapes: +.. _class_Physics2DServer_method_area_clear_shapes: - void **area_clear_shapes** **(** :ref:`RID` area **)** Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. -.. _class_Physics2DServer_area_create: +.. _class_Physics2DServer_method_area_create: - :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area2D`. -.. _class_Physics2DServer_area_get_canvas_instance_id: +.. _class_Physics2DServer_method_area_get_canvas_instance_id: - :ref:`int` **area_get_canvas_instance_id** **(** :ref:`RID` area **)** const -.. _class_Physics2DServer_area_get_object_instance_id: +.. _class_Physics2DServer_method_area_get_object_instance_id: - :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const Gets the instance ID of the object the area is assigned to. -.. _class_Physics2DServer_area_get_param: +.. _class_Physics2DServer_method_area_get_param: - :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 AREA_PARAM\_\* constants. -.. _class_Physics2DServer_area_get_shape: +.. _class_Physics2DServer_method_area_get_shape: - :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of an area. -.. _class_Physics2DServer_area_get_shape_count: +.. _class_Physics2DServer_method_area_get_shape_count: - :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const Returns the number of shapes assigned to an area. -.. _class_Physics2DServer_area_get_shape_transform: +.. _class_Physics2DServer_method_area_get_shape_transform: - :ref:`Transform2D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the transform matrix of a shape within an area. -.. _class_Physics2DServer_area_get_space: +.. _class_Physics2DServer_method_area_get_space: - :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. -.. _class_Physics2DServer_area_get_space_override_mode: +.. _class_Physics2DServer_method_area_get_space_override_mode: - :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. -.. _class_Physics2DServer_area_get_transform: +.. _class_Physics2DServer_method_area_get_transform: - :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. -.. _class_Physics2DServer_area_remove_shape: +.. _class_Physics2DServer_method_area_remove_shape: - void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** Removes a shape from an area. It does not delete the shape, so it can be reassigned later. -.. _class_Physics2DServer_area_set_area_monitor_callback: +.. _class_Physics2DServer_method_area_set_area_monitor_callback: - void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** -.. _class_Physics2DServer_area_set_collision_layer: +.. _class_Physics2DServer_method_area_set_collision_layer: - void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** Assigns the area to one or many physics layers. -.. _class_Physics2DServer_area_set_collision_mask: +.. _class_Physics2DServer_method_area_set_collision_mask: - void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** Sets which physics layers the area will monitor. -.. _class_Physics2DServer_area_set_monitor_callback: +.. _class_Physics2DServer_method_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** @@ -534,239 +660,239 @@ Sets the function to call when any body/area enters or exits the area. This call 5: The shape index of the area where the object entered/exited. -.. _class_Physics2DServer_area_set_monitorable: +.. _class_Physics2DServer_method_area_set_monitorable: - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** -.. _class_Physics2DServer_area_set_param: +.. _class_Physics2DServer_method_area_set_param: - void **area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM\_\* constants. -.. _class_Physics2DServer_area_set_shape: +.. _class_Physics2DServer_method_area_set_shape: - void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. -.. _class_Physics2DServer_area_set_shape_disabled: +.. _class_Physics2DServer_method_area_set_shape_disabled: - void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** Disables a given shape in an area. -.. _class_Physics2DServer_area_set_shape_transform: +.. _class_Physics2DServer_method_area_set_shape_transform: - void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** Sets the transform matrix for an area shape. -.. _class_Physics2DServer_area_set_space: +.. _class_Physics2DServer_method_area_set_space: - void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. -.. _class_Physics2DServer_area_set_space_override_mode: +.. _class_Physics2DServer_method_area_set_space_override_mode: - void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE\_\*. -.. _class_Physics2DServer_area_set_transform: +.. _class_Physics2DServer_method_area_set_transform: - void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** Sets the transform matrix for an area. -.. _class_Physics2DServer_body_add_central_force: +.. _class_Physics2DServer_method_body_add_central_force: - void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** -.. _class_Physics2DServer_body_add_collision_exception: +.. _class_Physics2DServer_method_body_add_collision_exception: - void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Adds a body to the list of bodies exempt from collisions. -.. _class_Physics2DServer_body_add_force: +.. _class_Physics2DServer_method_body_add_force: - void **body_add_force** **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** -Adds a positioned force to the applied force and torque. As with :ref:`body_apply_impulse`, both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. +Adds a positioned force to the applied force and torque. As with :ref:`body_apply_impulse`, both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. -.. _class_Physics2DServer_body_add_shape: +.. _class_Physics2DServer_method_body_add_shape: - void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. -.. _class_Physics2DServer_body_add_torque: +.. _class_Physics2DServer_method_body_add_torque: - void **body_add_torque** **(** :ref:`RID` body, :ref:`float` torque **)** -.. _class_Physics2DServer_body_apply_central_impulse: +.. _class_Physics2DServer_method_body_apply_central_impulse: - void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** -.. _class_Physics2DServer_body_apply_impulse: +.. _class_Physics2DServer_method_body_apply_impulse: - void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. -.. _class_Physics2DServer_body_apply_torque_impulse: +.. _class_Physics2DServer_method_body_apply_torque_impulse: - void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** -.. _class_Physics2DServer_body_attach_canvas_instance_id: +.. _class_Physics2DServer_method_body_attach_canvas_instance_id: - void **body_attach_canvas_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** -.. _class_Physics2DServer_body_attach_object_instance_id: +.. _class_Physics2DServer_method_body_attach_object_instance_id: - void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. -.. _class_Physics2DServer_body_clear_shapes: +.. _class_Physics2DServer_method_body_clear_shapes: - void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. -.. _class_Physics2DServer_body_create: +.. _class_Physics2DServer_method_body_create: - :ref:`RID` **body_create** **(** **)** Creates a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. -.. _class_Physics2DServer_body_get_canvas_instance_id: +.. _class_Physics2DServer_method_body_get_canvas_instance_id: - :ref:`int` **body_get_canvas_instance_id** **(** :ref:`RID` body **)** const -.. _class_Physics2DServer_body_get_collision_layer: +.. _class_Physics2DServer_method_body_get_collision_layer: - :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body belongs to. -.. _class_Physics2DServer_body_get_collision_mask: +.. _class_Physics2DServer_method_body_get_collision_mask: - :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body can collide with. -.. _class_Physics2DServer_body_get_continuous_collision_detection_mode: +.. _class_Physics2DServer_method_body_get_continuous_collision_detection_mode: - :ref:`CCDMode` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** const Returns the continuous collision detection mode. -.. _class_Physics2DServer_body_get_direct_state: +.. _class_Physics2DServer_method_body_get_direct_state: - :ref:`Physics2DDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** Returns the :ref:`Physics2DDirectBodyState` of the body. -.. _class_Physics2DServer_body_get_max_contacts_reported: +.. _class_Physics2DServer_method_body_get_max_contacts_reported: - :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`. +Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. -.. _class_Physics2DServer_body_get_mode: +.. _class_Physics2DServer_method_body_get_mode: - :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. -.. _class_Physics2DServer_body_get_object_instance_id: +.. _class_Physics2DServer_method_body_get_object_instance_id: - :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const Gets the instance ID of the object the area is assigned to. -.. _class_Physics2DServer_body_get_param: +.. _class_Physics2DServer_method_body_get_param: - :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 BODY_PARAM\_\* constants. -.. _class_Physics2DServer_body_get_shape: +.. _class_Physics2DServer_method_body_get_shape: - :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of a body. -.. _class_Physics2DServer_body_get_shape_count: +.. _class_Physics2DServer_method_body_get_shape_count: - :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const Returns the number of shapes assigned to a body. -.. _class_Physics2DServer_body_get_shape_metadata: +.. _class_Physics2DServer_method_body_get_shape_metadata: - :ref:`Variant` **body_get_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the metadata of a shape of a body. -.. _class_Physics2DServer_body_get_shape_transform: +.. _class_Physics2DServer_method_body_get_shape_transform: - :ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the transform matrix of a body shape. -.. _class_Physics2DServer_body_get_space: +.. _class_Physics2DServer_method_body_get_space: - :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const Returns the :ref:`RID` of the space assigned to a body. -.. _class_Physics2DServer_body_get_state: +.. _class_Physics2DServer_method_body_get_state: - :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const Returns a body state. -.. _class_Physics2DServer_body_is_omitting_force_integration: +.. _class_Physics2DServer_method_body_is_omitting_force_integration: - :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`). +Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). -.. _class_Physics2DServer_body_remove_collision_exception: +.. _class_Physics2DServer_method_body_remove_collision_exception: - void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Removes a body from the list of bodies exempt from collisions. -.. _class_Physics2DServer_body_remove_shape: +.. _class_Physics2DServer_method_body_remove_shape: - void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. -.. _class_Physics2DServer_body_set_axis_velocity: +.. _class_Physics2DServer_method_body_set_axis_velocity: - void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** 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. -.. _class_Physics2DServer_body_set_collision_layer: +.. _class_Physics2DServer_method_body_set_collision_layer: - void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** Sets the physics layer or layers a body belongs to. -.. _class_Physics2DServer_body_set_collision_mask: +.. _class_Physics2DServer_method_body_set_collision_mask: - void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** Sets the physics layer or layers a body can collide with. -.. _class_Physics2DServer_body_set_continuous_collision_detection_mode: +.. _class_Physics2DServer_method_body_set_continuous_collision_detection_mode: - void **body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`CCDMode` mode **)** @@ -774,231 +900,231 @@ Sets the continuous collision detection mode from any of the CCD_MODE\_\* consta Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. -.. _class_Physics2DServer_body_set_force_integration_callback: +.. _class_Physics2DServer_method_body_set_force_integration_callback: - void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** -Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration`). +Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration`). -.. _class_Physics2DServer_body_set_max_contacts_reported: +.. _class_Physics2DServer_method_body_set_max_contacts_reported: - void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. -.. _class_Physics2DServer_body_set_mode: +.. _class_Physics2DServer_method_body_set_mode: - void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** Sets the body mode, from one of the constants BODY_MODE\*. -.. _class_Physics2DServer_body_set_omit_force_integration: +.. _class_Physics2DServer_method_body_set_omit_force_integration: - void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** -Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). +Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). -.. _class_Physics2DServer_body_set_param: +.. _class_Physics2DServer_method_body_set_param: - void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** Sets a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. -.. _class_Physics2DServer_body_set_shape: +.. _class_Physics2DServer_method_body_set_shape: - void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. -.. _class_Physics2DServer_body_set_shape_as_one_way_collision: +.. _class_Physics2DServer_method_body_set_shape_as_one_way_collision: - void **body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** Enables one way collision on body if ``enable`` is ``true``. -.. _class_Physics2DServer_body_set_shape_disabled: +.. _class_Physics2DServer_method_body_set_shape_disabled: - void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** Disables shape in body if ``disable`` is ``true``. -.. _class_Physics2DServer_body_set_shape_metadata: +.. _class_Physics2DServer_method_body_set_shape_metadata: - void **body_set_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** -Sets metadata of a shape within a body. This metadata is different from :ref:`Object.set_meta`, and can be retrieved on shape queries. +Sets metadata of a shape within a body. This metadata is different from :ref:`Object.set_meta`, and can be retrieved on shape queries. -.. _class_Physics2DServer_body_set_shape_transform: +.. _class_Physics2DServer_method_body_set_shape_transform: - void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** Sets the transform matrix for a body shape. -.. _class_Physics2DServer_body_set_space: +.. _class_Physics2DServer_method_body_set_space: - void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** -Assigns a space to the body (see :ref:`space_create`). +Assigns a space to the body (see :ref:`space_create`). -.. _class_Physics2DServer_body_set_state: +.. _class_Physics2DServer_method_body_set_state: - void **body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** Sets a body state (see BODY_STATE\* constants). -.. _class_Physics2DServer_body_test_motion: +.. _class_Physics2DServer_method_body_test_motion: - :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`bool` infinite_inertia, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult` can be passed to return additional information in. -.. _class_Physics2DServer_capsule_shape_create: +.. _class_Physics2DServer_method_capsule_shape_create: - :ref:`RID` **capsule_shape_create** **(** **)** -.. _class_Physics2DServer_circle_shape_create: +.. _class_Physics2DServer_method_circle_shape_create: - :ref:`RID` **circle_shape_create** **(** **)** -.. _class_Physics2DServer_concave_polygon_shape_create: +.. _class_Physics2DServer_method_concave_polygon_shape_create: - :ref:`RID` **concave_polygon_shape_create** **(** **)** -.. _class_Physics2DServer_convex_polygon_shape_create: +.. _class_Physics2DServer_method_convex_polygon_shape_create: - :ref:`RID` **convex_polygon_shape_create** **(** **)** -.. _class_Physics2DServer_damped_spring_joint_create: +.. _class_Physics2DServer_method_damped_spring_joint_create: - :ref:`RID` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. -.. _class_Physics2DServer_damped_string_joint_get_param: +.. _class_Physics2DServer_method_damped_string_joint_get_param: - :ref:`float` **damped_string_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** const Returns the value of a damped spring joint parameter. -.. _class_Physics2DServer_damped_string_joint_set_param: +.. _class_Physics2DServer_method_damped_string_joint_set_param: - void **damped_string_joint_set_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param, :ref:`float` value **)** Sets a damped spring joint parameter. Parameters are explained in the DAMPED_STRING\* constants. -.. _class_Physics2DServer_free_rid: +.. _class_Physics2DServer_method_free_rid: - void **free_rid** **(** :ref:`RID` rid **)** Destroys any of the objects created by Physics2DServer. If the :ref:`RID` passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. -.. _class_Physics2DServer_get_process_info: +.. _class_Physics2DServer_method_get_process_info: - :ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** Returns information about the current state of the 2D physics engine. The states are listed under the INFO\_\* constants. -.. _class_Physics2DServer_groove_joint_create: +.. _class_Physics2DServer_method_groove_joint_create: - :ref:`RID` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** Creates a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. -.. _class_Physics2DServer_joint_get_param: +.. _class_Physics2DServer_method_joint_get_param: - :ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** const Returns the value of a joint parameter. -.. _class_Physics2DServer_joint_get_type: +.. _class_Physics2DServer_method_joint_get_type: - :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of a joint (see JOINT\_\* constants). -.. _class_Physics2DServer_joint_set_param: +.. _class_Physics2DServer_method_joint_set_param: - void **joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** Sets a joint parameter. Parameters are explained in the JOINT_PARAM\* constants. -.. _class_Physics2DServer_line_shape_create: +.. _class_Physics2DServer_method_line_shape_create: - :ref:`RID` **line_shape_create** **(** **)** -.. _class_Physics2DServer_pin_joint_create: +.. _class_Physics2DServer_method_pin_joint_create: - :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. -.. _class_Physics2DServer_ray_shape_create: +.. _class_Physics2DServer_method_ray_shape_create: - :ref:`RID` **ray_shape_create** **(** **)** -.. _class_Physics2DServer_rectangle_shape_create: +.. _class_Physics2DServer_method_rectangle_shape_create: - :ref:`RID` **rectangle_shape_create** **(** **)** -.. _class_Physics2DServer_segment_shape_create: +.. _class_Physics2DServer_method_segment_shape_create: - :ref:`RID` **segment_shape_create** **(** **)** -.. _class_Physics2DServer_set_active: +.. _class_Physics2DServer_method_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 2D physics engine. -.. _class_Physics2DServer_shape_get_data: +.. _class_Physics2DServer_method_shape_get_data: - :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. -.. _class_Physics2DServer_shape_get_type: +.. _class_Physics2DServer_method_shape_get_type: - :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see SHAPE\_\* constants). -.. _class_Physics2DServer_shape_set_data: +.. _class_Physics2DServer_method_shape_set_data: - void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** -Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. +Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. -.. _class_Physics2DServer_space_create: +.. _class_Physics2DServer_method_space_create: - :ref:`RID` **space_create** **(** **)** -Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. +Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. -.. _class_Physics2DServer_space_get_direct_state: +.. _class_Physics2DServer_method_space_get_direct_state: - :ref:`Physics2DDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** Returns the state of a space, a :ref:`Physics2DDirectSpaceState`. This object can be used to make collision/intersection queries. -.. _class_Physics2DServer_space_get_param: +.. _class_Physics2DServer_method_space_get_param: - :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const Returns the value of a space parameter. -.. _class_Physics2DServer_space_is_active: +.. _class_Physics2DServer_method_space_is_active: - :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. -.. _class_Physics2DServer_space_set_active: +.. _class_Physics2DServer_method_space_set_active: - void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** Marks a space as active. It will not have an effect, unless it is assigned to an area or body. -.. _class_Physics2DServer_space_set_param: +.. _class_Physics2DServer_method_space_set_param: - void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 6b7c349e2..e17ef3a31 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -19,30 +19,30 @@ Parameters to be sent to a 2D shape physics query. Properties ---------- -+---------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_areas` | -+---------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_bodies` | -+---------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+---------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`exclude` | -+---------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin` | -+---------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion` | -+---------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_rid` | -+---------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | -+---------------------------------------+-------------------------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | ++---------------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | ++---------------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++---------------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`exclude` | ++---------------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin` | ++---------------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`motion` | ++---------------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shape_rid` | ++---------------------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`transform` | ++---------------------------------------+----------------------------------------------------------------------------------------------+ Methods ------- -+-------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | -+-------+-------------------------------------------------------------------------------------------------------------------+ ++------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | ++------+--------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -52,7 +52,7 @@ This class contains the shape and other parameters for intersection/collision qu Property Descriptions --------------------- -.. _class_Physics2DShapeQueryParameters_collide_with_areas: +.. _class_Physics2DShapeQueryParameters_property_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -62,7 +62,7 @@ Property Descriptions | *Getter* | is_collide_with_areas_enabled() | +----------+---------------------------------+ -.. _class_Physics2DShapeQueryParameters_collide_with_bodies: +.. _class_Physics2DShapeQueryParameters_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -72,7 +72,7 @@ Property Descriptions | *Getter* | is_collide_with_bodies_enabled() | +----------+----------------------------------+ -.. _class_Physics2DShapeQueryParameters_collision_layer: +.. _class_Physics2DShapeQueryParameters_property_collision_layer: - :ref:`int` **collision_layer** @@ -84,7 +84,7 @@ Property Descriptions The physics layer the query should be made on. -.. _class_Physics2DShapeQueryParameters_exclude: +.. _class_Physics2DShapeQueryParameters_property_exclude: - :ref:`Array` **exclude** @@ -96,7 +96,7 @@ The physics layer the query should be made on. The list of objects or object :ref:`RID`\ s, that will be excluded from collisions. -.. _class_Physics2DShapeQueryParameters_margin: +.. _class_Physics2DShapeQueryParameters_property_margin: - :ref:`float` **margin** @@ -108,7 +108,7 @@ The list of objects or object :ref:`RID`\ s, that will be excluded fr The collision margin for the shape. -.. _class_Physics2DShapeQueryParameters_motion: +.. _class_Physics2DShapeQueryParameters_property_motion: - :ref:`Vector2` **motion** @@ -120,7 +120,7 @@ The collision margin for the shape. The motion of the shape being queried for. -.. _class_Physics2DShapeQueryParameters_shape_rid: +.. _class_Physics2DShapeQueryParameters_property_shape_rid: - :ref:`RID` **shape_rid** @@ -130,9 +130,9 @@ The motion of the shape being queried for. | *Getter* | get_shape_rid() | +----------+----------------------+ -The :ref:`RID` of the queried shape. See :ref:`set_shape` also. +The :ref:`RID` of the queried shape. See :ref:`set_shape` also. -.. _class_Physics2DShapeQueryParameters_transform: +.. _class_Physics2DShapeQueryParameters_property_transform: - :ref:`Transform2D` **transform** @@ -147,7 +147,7 @@ the transform matrix of the queried shape. Method Descriptions ------------------- -.. _class_Physics2DShapeQueryParameters_set_shape: +.. _class_Physics2DShapeQueryParameters_method_set_shape: - void **set_shape** **(** :ref:`Resource` shape **)** diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index f642ce5d7..6b2aa5af6 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -19,38 +19,38 @@ Brief Description 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_get_result_count: +.. _class_Physics2DShapeQueryResult_method_get_result_count: - :ref:`int` **get_result_count** **(** **)** const -.. _class_Physics2DShapeQueryResult_get_result_object: +.. _class_Physics2DShapeQueryResult_method_get_result_object: - :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const -.. _class_Physics2DShapeQueryResult_get_result_object_id: +.. _class_Physics2DShapeQueryResult_method_get_result_object_id: - :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const -.. _class_Physics2DShapeQueryResult_get_result_object_shape: +.. _class_Physics2DShapeQueryResult_method_get_result_object_shape: - :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const -.. _class_Physics2DShapeQueryResult_get_result_rid: +.. _class_Physics2DShapeQueryResult_method_get_result_rid: - :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index 7fe0ade0f..0a0c68feb 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -19,30 +19,30 @@ Brief Description Properties ---------- -+-------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`collider` | -+-------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_id` | -+-------------------------------+-----------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`collider_rid` | -+-------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collider_shape` | -+-------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`collider_velocity` | -+-------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`collision_normal` | -+-------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`collision_point` | -+-------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion` | -+-------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`motion_remainder` | -+-------------------------------+-----------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`collider` | ++-------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collider_id` | ++-------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`collider_rid` | ++-------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collider_shape` | ++-------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`collider_velocity` | ++-------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`collision_normal` | ++-------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`collision_point` | ++-------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`motion` | ++-------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`motion_remainder` | ++-------------------------------+--------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_Physics2DTestMotionResult_collider: +.. _class_Physics2DTestMotionResult_property_collider: - :ref:`Object` **collider** @@ -50,7 +50,7 @@ Property Descriptions | *Getter* | get_collider() | +----------+----------------+ -.. _class_Physics2DTestMotionResult_collider_id: +.. _class_Physics2DTestMotionResult_property_collider_id: - :ref:`int` **collider_id** @@ -58,7 +58,7 @@ Property Descriptions | *Getter* | get_collider_id() | +----------+-------------------+ -.. _class_Physics2DTestMotionResult_collider_rid: +.. _class_Physics2DTestMotionResult_property_collider_rid: - :ref:`RID` **collider_rid** @@ -66,7 +66,7 @@ Property Descriptions | *Getter* | get_collider_rid() | +----------+--------------------+ -.. _class_Physics2DTestMotionResult_collider_shape: +.. _class_Physics2DTestMotionResult_property_collider_shape: - :ref:`int` **collider_shape** @@ -74,7 +74,7 @@ Property Descriptions | *Getter* | get_collider_shape() | +----------+----------------------+ -.. _class_Physics2DTestMotionResult_collider_velocity: +.. _class_Physics2DTestMotionResult_property_collider_velocity: - :ref:`Vector2` **collider_velocity** @@ -82,7 +82,7 @@ Property Descriptions | *Getter* | get_collider_velocity() | +----------+-------------------------+ -.. _class_Physics2DTestMotionResult_collision_normal: +.. _class_Physics2DTestMotionResult_property_collision_normal: - :ref:`Vector2` **collision_normal** @@ -90,7 +90,7 @@ Property Descriptions | *Getter* | get_collision_normal() | +----------+------------------------+ -.. _class_Physics2DTestMotionResult_collision_point: +.. _class_Physics2DTestMotionResult_property_collision_point: - :ref:`Vector2` **collision_point** @@ -98,7 +98,7 @@ Property Descriptions | *Getter* | get_collision_point() | +----------+-----------------------+ -.. _class_Physics2DTestMotionResult_motion: +.. _class_Physics2DTestMotionResult_property_motion: - :ref:`Vector2` **motion** @@ -106,7 +106,7 @@ Property Descriptions | *Getter* | get_motion() | +----------+--------------+ -.. _class_Physics2DTestMotionResult_motion_remainder: +.. _class_Physics2DTestMotionResult_property_motion_remainder: - :ref:`Vector2` **motion_remainder** diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 7e74a0123..3e09278aa 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -21,30 +21,30 @@ Base class for all objects affected by physics in 3D space. Properties ---------- -+-----------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-----------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-----------------------+-----------------------------------------------------------+ ++-----------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++-----------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-----------------------+--------------------------------------------------------------------+ Methods ------- -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_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 **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_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 **)** | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -59,7 +59,7 @@ Tutorials Property Descriptions --------------------- -.. _class_PhysicsBody_collision_layer: +.. _class_PhysicsBody_property_collision_layer: - :ref:`int` **collision_layer** @@ -75,7 +75,7 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. -.. _class_PhysicsBody_collision_mask: +.. _class_PhysicsBody_property_collision_mask: - :ref:`int` **collision_mask** @@ -90,43 +90,43 @@ The physics layers this area scans for collisions. Method Descriptions ------------------- -.. _class_PhysicsBody_add_collision_exception_with: +.. _class_PhysicsBody_method_add_collision_exception_with: - void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. -.. _class_PhysicsBody_get_collision_exceptions: +.. _class_PhysicsBody_method_get_collision_exceptions: - :ref:`Array` **get_collision_exceptions** **(** **)** Returns an array of nodes that were added as collision exceptions for this body. -.. _class_PhysicsBody_get_collision_layer_bit: +.. _class_PhysicsBody_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. -.. _class_PhysicsBody_get_collision_mask_bit: +.. _class_PhysicsBody_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. -.. _class_PhysicsBody_remove_collision_exception_with: +.. _class_PhysicsBody_method_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. -.. _class_PhysicsBody_set_collision_layer_bit: +.. _class_PhysicsBody_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. -.. _class_PhysicsBody_set_collision_mask_bit: +.. _class_PhysicsBody_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 772c98b7e..01e5f4102 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -21,32 +21,32 @@ Base class for all objects affected by physics in 2D space. Properties ---------- -+-----------------------+-------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+-----------------------+-------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-----------------------+-------------------------------------------------------------+ -| :ref:`int` | :ref:`layers` | -+-----------------------+-------------------------------------------------------------+ ++-----------------------+----------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++-----------------------+----------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-----------------------+----------------------------------------------------------------------+ +| :ref:`int` | :ref:`layers` | ++-----------------------+----------------------------------------------------------------------+ Methods ------- -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_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 **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_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 **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -61,7 +61,7 @@ Tutorials Property Descriptions --------------------- -.. _class_PhysicsBody2D_collision_layer: +.. _class_PhysicsBody2D_property_collision_layer: - :ref:`int` **collision_layer** @@ -77,7 +77,7 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. -.. _class_PhysicsBody2D_collision_mask: +.. _class_PhysicsBody2D_property_collision_mask: - :ref:`int` **collision_mask** @@ -89,52 +89,52 @@ A contact is detected if object A is in any of the layers that object B scans, o The physics layers this area scans for collisions. -.. _class_PhysicsBody2D_layers: +.. _class_PhysicsBody2D_property_layers: - :ref:`int` **layers** -Both :ref:`collision_layer` and :ref:`collision_mask`. Returns :ref:`collision_layer` when accessed. Updates :ref:`collision_layer` and :ref:`collision_mask` when modified. +Both :ref:`collision_layer` and :ref:`collision_mask`. Returns :ref:`collision_layer` when accessed. Updates :ref:`collision_layer` and :ref:`collision_mask` when modified. Method Descriptions ------------------- -.. _class_PhysicsBody2D_add_collision_exception_with: +.. _class_PhysicsBody2D_method_add_collision_exception_with: - void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. -.. _class_PhysicsBody2D_get_collision_exceptions: +.. _class_PhysicsBody2D_method_get_collision_exceptions: - :ref:`Array` **get_collision_exceptions** **(** **)** Returns an array of nodes that were added as collision exceptions for this body. -.. _class_PhysicsBody2D_get_collision_layer_bit: +.. _class_PhysicsBody2D_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. -.. _class_PhysicsBody2D_get_collision_mask_bit: +.. _class_PhysicsBody2D_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. -.. _class_PhysicsBody2D_remove_collision_exception_with: +.. _class_PhysicsBody2D_method_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. -.. _class_PhysicsBody2D_set_collision_layer_bit: +.. _class_PhysicsBody2D_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. -.. _class_PhysicsBody2D_set_collision_mask_bit: +.. _class_PhysicsBody2D_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index 95948f6f8..88e1d0ec0 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -21,79 +21,79 @@ Brief Description Properties ---------- -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`angular_velocity` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`center_of_mass` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`inverse_inertia` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inverse_mass` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`linear_velocity` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`principal_inertia_axes` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sleeping` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`step` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`total_angular_damp` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`total_gravity` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`total_linear_damp` | -+-----------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`transform` | -+-----------------------------------+------------------------------------------------------------------------------------+ ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`angular_velocity` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`center_of_mass` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`inverse_inertia` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_mass` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`linear_velocity` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`principal_inertia_axes` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`sleeping` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`step` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_angular_damp` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`total_gravity` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_linear_damp` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`transform` | ++-----------------------------------+---------------------------------------------------------------------------------------------+ 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 --------------------- -.. _class_PhysicsDirectBodyState_angular_velocity: +.. _class_PhysicsDirectBodyState_property_angular_velocity: - :ref:`Vector3` **angular_velocity** @@ -105,7 +105,7 @@ Property Descriptions The angular velocity of the body. -.. _class_PhysicsDirectBodyState_center_of_mass: +.. _class_PhysicsDirectBodyState_property_center_of_mass: - :ref:`Vector3` **center_of_mass** @@ -113,7 +113,7 @@ The angular velocity of the body. | *Getter* | get_center_of_mass() | +----------+----------------------+ -.. _class_PhysicsDirectBodyState_inverse_inertia: +.. _class_PhysicsDirectBodyState_property_inverse_inertia: - :ref:`Vector3` **inverse_inertia** @@ -123,7 +123,7 @@ The angular velocity of the body. The inverse of the inertia of the body. -.. _class_PhysicsDirectBodyState_inverse_mass: +.. _class_PhysicsDirectBodyState_property_inverse_mass: - :ref:`float` **inverse_mass** @@ -133,7 +133,7 @@ The inverse of the inertia of the body. The inverse of the mass of the body. -.. _class_PhysicsDirectBodyState_linear_velocity: +.. _class_PhysicsDirectBodyState_property_linear_velocity: - :ref:`Vector3` **linear_velocity** @@ -145,7 +145,7 @@ The inverse of the mass of the body. The linear velocity of the body. -.. _class_PhysicsDirectBodyState_principal_inertia_axes: +.. _class_PhysicsDirectBodyState_property_principal_inertia_axes: - :ref:`Basis` **principal_inertia_axes** @@ -153,7 +153,7 @@ The linear velocity of the body. | *Getter* | get_principal_inertia_axes() | +----------+------------------------------+ -.. _class_PhysicsDirectBodyState_sleeping: +.. _class_PhysicsDirectBodyState_property_sleeping: - :ref:`bool` **sleeping** @@ -165,7 +165,7 @@ The linear velocity of the body. ``true`` if this body is currently sleeping (not active). -.. _class_PhysicsDirectBodyState_step: +.. _class_PhysicsDirectBodyState_property_step: - :ref:`float` **step** @@ -175,7 +175,7 @@ The linear velocity of the body. The timestep (delta) used for the simulation. -.. _class_PhysicsDirectBodyState_total_angular_damp: +.. _class_PhysicsDirectBodyState_property_total_angular_damp: - :ref:`float` **total_angular_damp** @@ -185,7 +185,7 @@ The timestep (delta) used for the simulation. The rate at which the body stops rotating, if there are not any other forces moving it. -.. _class_PhysicsDirectBodyState_total_gravity: +.. _class_PhysicsDirectBodyState_property_total_gravity: - :ref:`Vector3` **total_gravity** @@ -195,7 +195,7 @@ The rate at which the body stops rotating, if there are not any other forces mov The total gravity vector being currently applied to this body. -.. _class_PhysicsDirectBodyState_total_linear_damp: +.. _class_PhysicsDirectBodyState_property_total_linear_damp: - :ref:`float` **total_linear_damp** @@ -205,7 +205,7 @@ The total gravity vector being currently applied to this body. The rate at which the body stops moving, if there are not any other forces moving it. -.. _class_PhysicsDirectBodyState_transform: +.. _class_PhysicsDirectBodyState_property_transform: - :ref:`Transform` **transform** @@ -220,7 +220,7 @@ The transformation matrix of the body. Method Descriptions ------------------- -.. _class_PhysicsDirectBodyState_add_central_force: +.. _class_PhysicsDirectBodyState_method_add_central_force: - void **add_central_force** **(** :ref:`Vector3` force **)** @@ -228,19 +228,19 @@ Adds a constant directional force without affecting rotation. This is equivalent to ``add_force(force, Vector3(0,0,0))``. -.. _class_PhysicsDirectBodyState_add_force: +.. _class_PhysicsDirectBodyState_method_add_force: - void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** Adds a constant force (i.e. acceleration). -.. _class_PhysicsDirectBodyState_add_torque: +.. _class_PhysicsDirectBodyState_method_add_torque: - void **add_torque** **(** :ref:`Vector3` torque **)** Adds a constant rotational force (i.e. a motor) without affecting position. -.. _class_PhysicsDirectBodyState_apply_central_impulse: +.. _class_PhysicsDirectBodyState_method_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector3` j **)** @@ -248,69 +248,69 @@ Applies a single directional impulse without affecting rotation. This is equivalent to ``apply_impulse(Vector3(0, 0, 0), impulse)``. -.. _class_PhysicsDirectBodyState_apply_impulse: +.. _class_PhysicsDirectBodyState_method_apply_impulse: - void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` j **)** Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the object's origin. -.. _class_PhysicsDirectBodyState_apply_torque_impulse: +.. _class_PhysicsDirectBodyState_method_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`Vector3` j **)** Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector. -.. _class_PhysicsDirectBodyState_get_contact_collider: +.. _class_PhysicsDirectBodyState_method_get_contact_collider: - :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_id: +.. _class_PhysicsDirectBodyState_method_get_contact_collider_id: - :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_object: +.. _class_PhysicsDirectBodyState_method_get_contact_collider_object: - :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_position: +.. _class_PhysicsDirectBodyState_method_get_contact_collider_position: - :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_shape: +.. _class_PhysicsDirectBodyState_method_get_contact_collider_shape: - :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_velocity_at_position: +.. _class_PhysicsDirectBodyState_method_get_contact_collider_velocity_at_position: - :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_count: +.. _class_PhysicsDirectBodyState_method_get_contact_count: - :ref:`int` **get_contact_count** **(** **)** const -.. _class_PhysicsDirectBodyState_get_contact_impulse: +.. _class_PhysicsDirectBodyState_method_get_contact_impulse: - :ref:`float` **get_contact_impulse** **(** :ref:`int` contact_idx **)** const Impulse created by the contact. Only implemented for Bullet physics. -.. _class_PhysicsDirectBodyState_get_contact_local_normal: +.. _class_PhysicsDirectBodyState_method_get_contact_local_normal: - :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_local_position: +.. _class_PhysicsDirectBodyState_method_get_contact_local_position: - :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_local_shape: +.. _class_PhysicsDirectBodyState_method_get_contact_local_shape: - :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_space_state: +.. _class_PhysicsDirectBodyState_method_get_space_state: - :ref:`PhysicsDirectSpaceState` **get_space_state** **(** **)** -.. _class_PhysicsDirectBodyState_integrate_forces: +.. _class_PhysicsDirectBodyState_method_integrate_forces: - void **integrate_forces** **(** **)** diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index a9db34ce2..14242ec0e 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -19,17 +19,17 @@ Direct access object to a space in the :ref:`PhysicsServer` Methods ------- -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_mask=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_mask=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -44,7 +44,7 @@ Tutorials Method Descriptions ------------------- -.. _class_PhysicsDirectSpaceState_cast_motion: +.. _class_PhysicsDirectSpaceState_method_cast_motion: - :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** @@ -52,13 +52,13 @@ Checks whether the shape can travel to a point. The method will return an array If the shape can not move, the returned array will be ``[0, 0]``. -.. _class_PhysicsDirectSpaceState_collide_shape: +.. _class_PhysicsDirectSpaceState_method_collide_shape: - :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** -Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. +Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. -.. _class_PhysicsDirectSpaceState_get_rest_info: +.. _class_PhysicsDirectSpaceState_method_get_rest_info: - :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters` shape **)** @@ -78,7 +78,7 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara If the shape did not intersect anything, then an empty dictionary is returned instead. -.. _class_PhysicsDirectSpaceState_intersect_ray: +.. _class_PhysicsDirectSpaceState_method_intersect_ray: - :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_mask=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** @@ -100,7 +100,7 @@ If the ray did not intersect anything, then an empty dictionary is returned inst Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody`\ s or :ref:`Area`\ s, respectively. -.. _class_PhysicsDirectSpaceState_intersect_shape: +.. _class_PhysicsDirectSpaceState_method_intersect_shape: - :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index 3db1d1a58..1c45e9150 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -19,15 +19,15 @@ A material for physics properties. Properties ---------- -+---------------------------+---------------------------------------------------+ -| :ref:`bool` | :ref:`absorbent` | -+---------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+---------------------------+---------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+---------------------------+---------------------------------------------------+ -| :ref:`bool` | :ref:`rough` | -+---------------------------+---------------------------------------------------+ ++---------------------------+------------------------------------------------------------+ +| :ref:`bool` | :ref:`absorbent` | ++---------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`bounce` | ++---------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`friction` | ++---------------------------+------------------------------------------------------------+ +| :ref:`bool` | :ref:`rough` | ++---------------------------+------------------------------------------------------------+ Description ----------- @@ -37,7 +37,7 @@ Provides a means of modifying the collision properties of a :ref:`PhysicsBody` **absorbent** @@ -47,7 +47,7 @@ Property Descriptions | *Getter* | is_absorbent() | +----------+----------------------+ -.. _class_PhysicsMaterial_bounce: +.. _class_PhysicsMaterial_property_bounce: - :ref:`float` **bounce** @@ -59,7 +59,7 @@ Property Descriptions The body's bounciness. Default value: ``0``. -.. _class_PhysicsMaterial_friction: +.. _class_PhysicsMaterial_property_friction: - :ref:`float` **friction** @@ -71,7 +71,7 @@ The body's bounciness. Default value: ``0``. The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. -.. _class_PhysicsMaterial_rough: +.. _class_PhysicsMaterial_property_rough: - :ref:`bool` **rough** diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index fd92ea614..9c9a395fd 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -21,235 +21,245 @@ Server interface for low level physics access. Methods ------- -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`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:`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:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :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 | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform` transform **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_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:`int` | :ref:`body_get_max_contacts_reported` **(** :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:`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:`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:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** 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_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_ray_pickable` **(** :ref:`RID` body **)** const | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_kinematic_safe_margin` **(** :ref:`RID` body, :ref:`float` margin **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`generic_6dof_joint_get_flag` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`generic_6dof_joint_get_param` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generic_6dof_joint_set_flag` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generic_6dof_joint_set_param` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`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 **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_cone_twist` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_generic_6dof` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_hinge` **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_pin` **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`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_b` **(** :ref:`RID` joint **)** 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 **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_create` **(** :ref:`ShapeType` type **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shape_get_data` **(** :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 | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space_create` **(** **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_create` **(** **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`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:`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:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :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 | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform` transform **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_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:`int` | :ref:`body_get_max_contacts_reported` **(** :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:`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:`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:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** 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_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_ray_pickable` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_kinematic_safe_margin` **(** :ref:`RID` body, :ref:`float` margin **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`generic_6dof_joint_get_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`generic_6dof_joint_get_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generic_6dof_joint_set_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generic_6dof_joint_set_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`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 **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_cone_twist` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_generic_6dof` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_hinge` **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_pin` **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`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_b` **(** :ref:`RID` joint **)** 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 **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shape_create` **(** :ref:`ShapeType` type **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`shape_get_data` **(** :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 | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`space_create` **(** **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_PhysicsServer_JointType: +.. _class_PhysicsServer_constant_JOINT_PIN: + +.. _class_PhysicsServer_constant_JOINT_HINGE: + +.. _class_PhysicsServer_constant_JOINT_SLIDER: + +.. _class_PhysicsServer_constant_JOINT_CONE_TWIST: + +.. _class_PhysicsServer_constant_JOINT_6DOF: + enum **JointType**: - **JOINT_PIN** = **0** --- The :ref:`Joint` is a :ref:`PinJoint`. @@ -264,6 +274,12 @@ enum **JointType**: .. _enum_PhysicsServer_PinJointParam: +.. _class_PhysicsServer_constant_PIN_JOINT_BIAS: + +.. _class_PhysicsServer_constant_PIN_JOINT_DAMPING: + +.. _class_PhysicsServer_constant_PIN_JOINT_IMPULSE_CLAMP: + enum **PinJointParam**: - **PIN_JOINT_BIAS** = **0** --- The strength with which the pinned objects try to stay in positional relation to each other. @@ -278,6 +294,22 @@ The higher, the stronger. .. _enum_PhysicsServer_HingeJointParam: +.. _class_PhysicsServer_constant_HINGE_JOINT_BIAS: + +.. _class_PhysicsServer_constant_HINGE_JOINT_LIMIT_UPPER: + +.. _class_PhysicsServer_constant_HINGE_JOINT_LIMIT_LOWER: + +.. _class_PhysicsServer_constant_HINGE_JOINT_LIMIT_BIAS: + +.. _class_PhysicsServer_constant_HINGE_JOINT_LIMIT_SOFTNESS: + +.. _class_PhysicsServer_constant_HINGE_JOINT_LIMIT_RELAXATION: + +.. _class_PhysicsServer_constant_HINGE_JOINT_MOTOR_TARGET_VELOCITY: + +.. _class_PhysicsServer_constant_HINGE_JOINT_MOTOR_MAX_IMPULSE: + enum **HingeJointParam**: - **HINGE_JOINT_BIAS** = **0** --- The speed with which the two bodies get pulled together when they move in different directions. @@ -298,6 +330,10 @@ enum **HingeJointParam**: .. _enum_PhysicsServer_HingeJointFlag: +.. _class_PhysicsServer_constant_HINGE_JOINT_FLAG_USE_LIMIT: + +.. _class_PhysicsServer_constant_HINGE_JOINT_FLAG_ENABLE_MOTOR: + enum **HingeJointFlag**: - **HINGE_JOINT_FLAG_USE_LIMIT** = **0** --- If ``true``, the Hinge has a maximum and a minimum rotation. @@ -306,6 +342,52 @@ enum **HingeJointFlag**: .. _enum_PhysicsServer_SliderJointParam: +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_LIMIT_UPPER: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_LIMIT_LOWER: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_LIMIT_DAMPING: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_MOTION_SOFTNESS: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_MOTION_RESTITUTION: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_MOTION_DAMPING: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_LIMIT_UPPER: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_LIMIT_LOWER: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_LIMIT_DAMPING: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_MOTION_DAMPING: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING: + +.. _class_PhysicsServer_constant_SLIDER_JOINT_MAX: + enum **SliderJointParam**: - **SLIDER_JOINT_LINEAR_LIMIT_UPPER** = **0** --- The maximum difference between the pivot points on their x-axis before damping happens. @@ -356,6 +438,16 @@ enum **SliderJointParam**: .. _enum_PhysicsServer_ConeTwistJointParam: +.. _class_PhysicsServer_constant_CONE_TWIST_JOINT_SWING_SPAN: + +.. _class_PhysicsServer_constant_CONE_TWIST_JOINT_TWIST_SPAN: + +.. _class_PhysicsServer_constant_CONE_TWIST_JOINT_BIAS: + +.. _class_PhysicsServer_constant_CONE_TWIST_JOINT_SOFTNESS: + +.. _class_PhysicsServer_constant_CONE_TWIST_JOINT_RELAXATION: + enum **ConeTwistJointParam**: - **CONE_TWIST_JOINT_SWING_SPAN** = **0** --- Swing is rotation from side to side, around the axis perpendicular to the twist axis. @@ -380,6 +472,38 @@ The higher, the faster. .. _enum_PhysicsServer_G6DOFJointAxisParam: +.. _class_PhysicsServer_constant_G6DOF_JOINT_LINEAR_LOWER_LIMIT: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_LINEAR_UPPER_LIMIT: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_LINEAR_RESTITUTION: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_LINEAR_DAMPING: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_LINEAR_MOTOR_TARGET_VELOCITY: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_LINEAR_MOTOR_FORCE_LIMIT: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_ANGULAR_LOWER_LIMIT: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_ANGULAR_UPPER_LIMIT: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_ANGULAR_DAMPING: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_ANGULAR_RESTITUTION: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_ANGULAR_FORCE_LIMIT: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_ANGULAR_ERP: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT: + enum **G6DOFJointAxisParam**: - **G6DOF_JOINT_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes. @@ -416,6 +540,14 @@ enum **G6DOFJointAxisParam**: .. _enum_PhysicsServer_G6DOFJointAxisFlag: +.. _class_PhysicsServer_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_FLAG_ENABLE_MOTOR: + +.. _class_PhysicsServer_constant_G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR: + enum **G6DOFJointAxisFlag**: - **G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. @@ -428,6 +560,26 @@ enum **G6DOFJointAxisFlag**: .. _enum_PhysicsServer_ShapeType: +.. _class_PhysicsServer_constant_SHAPE_PLANE: + +.. _class_PhysicsServer_constant_SHAPE_RAY: + +.. _class_PhysicsServer_constant_SHAPE_SPHERE: + +.. _class_PhysicsServer_constant_SHAPE_BOX: + +.. _class_PhysicsServer_constant_SHAPE_CAPSULE: + +.. _class_PhysicsServer_constant_SHAPE_CYLINDER: + +.. _class_PhysicsServer_constant_SHAPE_CONVEX_POLYGON: + +.. _class_PhysicsServer_constant_SHAPE_CONCAVE_POLYGON: + +.. _class_PhysicsServer_constant_SHAPE_HEIGHTMAP: + +.. _class_PhysicsServer_constant_SHAPE_CUSTOM: + enum **ShapeType**: - **SHAPE_PLANE** = **0** --- The :ref:`Shape` is a :ref:`PlaneShape`. @@ -452,6 +604,22 @@ enum **ShapeType**: .. _enum_PhysicsServer_AreaParameter: +.. _class_PhysicsServer_constant_AREA_PARAM_GRAVITY: + +.. _class_PhysicsServer_constant_AREA_PARAM_GRAVITY_VECTOR: + +.. _class_PhysicsServer_constant_AREA_PARAM_GRAVITY_IS_POINT: + +.. _class_PhysicsServer_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE: + +.. _class_PhysicsServer_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION: + +.. _class_PhysicsServer_constant_AREA_PARAM_LINEAR_DAMP: + +.. _class_PhysicsServer_constant_AREA_PARAM_ANGULAR_DAMP: + +.. _class_PhysicsServer_constant_AREA_PARAM_PRIORITY: + enum **AreaParameter**: - **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area. @@ -472,6 +640,16 @@ enum **AreaParameter**: .. _enum_PhysicsServer_AreaSpaceOverrideMode: +.. _class_PhysicsServer_constant_AREA_SPACE_OVERRIDE_DISABLED: + +.. _class_PhysicsServer_constant_AREA_SPACE_OVERRIDE_COMBINE: + +.. _class_PhysicsServer_constant_AREA_SPACE_OVERRIDE_COMBINE_REPLACE: + +.. _class_PhysicsServer_constant_AREA_SPACE_OVERRIDE_REPLACE: + +.. _class_PhysicsServer_constant_AREA_SPACE_OVERRIDE_REPLACE_COMBINE: + enum **AreaSpaceOverrideMode**: - **AREA_SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. @@ -486,6 +664,14 @@ enum **AreaSpaceOverrideMode**: .. _enum_PhysicsServer_BodyMode: +.. _class_PhysicsServer_constant_BODY_MODE_STATIC: + +.. _class_PhysicsServer_constant_BODY_MODE_KINEMATIC: + +.. _class_PhysicsServer_constant_BODY_MODE_RIGID: + +.. _class_PhysicsServer_constant_BODY_MODE_CHARACTER: + enum **BodyMode**: - **BODY_MODE_STATIC** = **0** --- Constant for static bodies. @@ -498,6 +684,20 @@ enum **BodyMode**: .. _enum_PhysicsServer_BodyParameter: +.. _class_PhysicsServer_constant_BODY_PARAM_BOUNCE: + +.. _class_PhysicsServer_constant_BODY_PARAM_FRICTION: + +.. _class_PhysicsServer_constant_BODY_PARAM_MASS: + +.. _class_PhysicsServer_constant_BODY_PARAM_GRAVITY_SCALE: + +.. _class_PhysicsServer_constant_BODY_PARAM_LINEAR_DAMP: + +.. _class_PhysicsServer_constant_BODY_PARAM_ANGULAR_DAMP: + +.. _class_PhysicsServer_constant_BODY_PARAM_MAX: + enum **BodyParameter**: - **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor. @@ -516,6 +716,16 @@ enum **BodyParameter**: .. _enum_PhysicsServer_BodyState: +.. _class_PhysicsServer_constant_BODY_STATE_TRANSFORM: + +.. _class_PhysicsServer_constant_BODY_STATE_LINEAR_VELOCITY: + +.. _class_PhysicsServer_constant_BODY_STATE_ANGULAR_VELOCITY: + +.. _class_PhysicsServer_constant_BODY_STATE_SLEEPING: + +.. _class_PhysicsServer_constant_BODY_STATE_CAN_SLEEP: + enum **BodyState**: - **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body. @@ -530,6 +740,10 @@ enum **BodyState**: .. _enum_PhysicsServer_AreaBodyStatus: +.. _class_PhysicsServer_constant_AREA_BODY_ADDED: + +.. _class_PhysicsServer_constant_AREA_BODY_REMOVED: + enum **AreaBodyStatus**: - **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes. @@ -538,6 +752,12 @@ enum **AreaBodyStatus**: .. _enum_PhysicsServer_ProcessInfo: +.. _class_PhysicsServer_constant_INFO_ACTIVE_OBJECTS: + +.. _class_PhysicsServer_constant_INFO_COLLISION_PAIRS: + +.. _class_PhysicsServer_constant_INFO_ISLAND_COUNT: + enum **ProcessInfo**: - **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping. @@ -548,6 +768,22 @@ enum **ProcessInfo**: .. _enum_PhysicsServer_SpaceParameter: +.. _class_PhysicsServer_constant_SPACE_PARAM_CONTACT_RECYCLE_RADIUS: + +.. _class_PhysicsServer_constant_SPACE_PARAM_CONTACT_MAX_SEPARATION: + +.. _class_PhysicsServer_constant_SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION: + +.. _class_PhysicsServer_constant_SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD: + +.. _class_PhysicsServer_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD: + +.. _class_PhysicsServer_constant_SPACE_PARAM_BODY_TIME_TO_SLEEP: + +.. _class_PhysicsServer_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO: + +.. _class_PhysicsServer_constant_SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS: + enum **SpaceParameter**: - **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** --- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. @@ -568,6 +804,18 @@ enum **SpaceParameter**: .. _enum_PhysicsServer_BodyAxis: +.. _class_PhysicsServer_constant_BODY_AXIS_LINEAR_X: + +.. _class_PhysicsServer_constant_BODY_AXIS_LINEAR_Y: + +.. _class_PhysicsServer_constant_BODY_AXIS_LINEAR_Z: + +.. _class_PhysicsServer_constant_BODY_AXIS_ANGULAR_X: + +.. _class_PhysicsServer_constant_BODY_AXIS_ANGULAR_Y: + +.. _class_PhysicsServer_constant_BODY_AXIS_ANGULAR_Z: + enum **BodyAxis**: - **BODY_AXIS_LINEAR_X** = **1** @@ -590,107 +838,107 @@ Everything related to physics in 3D. Method Descriptions ------------------- -.. _class_PhysicsServer_area_add_shape: +.. _class_PhysicsServer_method_area_add_shape: - void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. -.. _class_PhysicsServer_area_attach_object_instance_id: +.. _class_PhysicsServer_method_area_attach_object_instance_id: - void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. -.. _class_PhysicsServer_area_clear_shapes: +.. _class_PhysicsServer_method_area_clear_shapes: - void **area_clear_shapes** **(** :ref:`RID` area **)** Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. -.. _class_PhysicsServer_area_create: +.. _class_PhysicsServer_method_area_create: - :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area`. -.. _class_PhysicsServer_area_get_object_instance_id: +.. _class_PhysicsServer_method_area_get_object_instance_id: - :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const Gets the instance ID of the object the area is assigned to. -.. _class_PhysicsServer_area_get_param: +.. _class_PhysicsServer_method_area_get_param: - :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 AREA_PARAM\_\* constants. -.. _class_PhysicsServer_area_get_shape: +.. _class_PhysicsServer_method_area_get_shape: - :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of an area. -.. _class_PhysicsServer_area_get_shape_count: +.. _class_PhysicsServer_method_area_get_shape_count: - :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const Returns the number of shapes assigned to an area. -.. _class_PhysicsServer_area_get_shape_transform: +.. _class_PhysicsServer_method_area_get_shape_transform: - :ref:`Transform` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the transform matrix of a shape within an area. -.. _class_PhysicsServer_area_get_space: +.. _class_PhysicsServer_method_area_get_space: - :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. -.. _class_PhysicsServer_area_get_space_override_mode: +.. _class_PhysicsServer_method_area_get_space_override_mode: - :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. -.. _class_PhysicsServer_area_get_transform: +.. _class_PhysicsServer_method_area_get_transform: - :ref:`Transform` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. -.. _class_PhysicsServer_area_is_ray_pickable: +.. _class_PhysicsServer_method_area_is_ray_pickable: - :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** const If ``true``, area collides with rays. -.. _class_PhysicsServer_area_remove_shape: +.. _class_PhysicsServer_method_area_remove_shape: - void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** Removes a shape from an area. It does not delete the shape, so it can be reassigned later. -.. _class_PhysicsServer_area_set_area_monitor_callback: +.. _class_PhysicsServer_method_area_set_area_monitor_callback: - void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** -.. _class_PhysicsServer_area_set_collision_layer: +.. _class_PhysicsServer_method_area_set_collision_layer: - void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** Assigns the area to one or many physics layers. -.. _class_PhysicsServer_area_set_collision_mask: +.. _class_PhysicsServer_method_area_set_collision_mask: - void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** Sets which physics layers the area will monitor. -.. _class_PhysicsServer_area_set_monitor_callback: +.. _class_PhysicsServer_method_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** @@ -706,117 +954,117 @@ Sets the function to call when any body/area enters or exits the area. This call 5: The shape index of the area where the object entered/exited. -.. _class_PhysicsServer_area_set_monitorable: +.. _class_PhysicsServer_method_area_set_monitorable: - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** -.. _class_PhysicsServer_area_set_param: +.. _class_PhysicsServer_method_area_set_param: - void **area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM\_\* constants. -.. _class_PhysicsServer_area_set_ray_pickable: +.. _class_PhysicsServer_method_area_set_ray_pickable: - void **area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` enable **)** Sets object pickable with rays. -.. _class_PhysicsServer_area_set_shape: +.. _class_PhysicsServer_method_area_set_shape: - void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. -.. _class_PhysicsServer_area_set_shape_transform: +.. _class_PhysicsServer_method_area_set_shape_transform: - void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** Sets the transform matrix for an area shape. -.. _class_PhysicsServer_area_set_space: +.. _class_PhysicsServer_method_area_set_space: - void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. -.. _class_PhysicsServer_area_set_space_override_mode: +.. _class_PhysicsServer_method_area_set_space_override_mode: - void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE\_\*. -.. _class_PhysicsServer_area_set_transform: +.. _class_PhysicsServer_method_area_set_transform: - void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform` transform **)** Sets the transform matrix for an area. -.. _class_PhysicsServer_body_add_central_force: +.. _class_PhysicsServer_method_body_add_central_force: - void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** -.. _class_PhysicsServer_body_add_collision_exception: +.. _class_PhysicsServer_method_body_add_collision_exception: - void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Adds a body to the list of bodies exempt from collisions. -.. _class_PhysicsServer_body_add_force: +.. _class_PhysicsServer_method_body_add_force: - void **body_add_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** -.. _class_PhysicsServer_body_add_shape: +.. _class_PhysicsServer_method_body_add_shape: - void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. -.. _class_PhysicsServer_body_add_torque: +.. _class_PhysicsServer_method_body_add_torque: - void **body_add_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** -.. _class_PhysicsServer_body_apply_central_impulse: +.. _class_PhysicsServer_method_body_apply_central_impulse: - void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** -.. _class_PhysicsServer_body_apply_impulse: +.. _class_PhysicsServer_method_body_apply_impulse: - void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** Gives the body a push at a ``position`` in the direction of the ``impulse``. -.. _class_PhysicsServer_body_apply_torque_impulse: +.. _class_PhysicsServer_method_body_apply_torque_impulse: - void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** Gives the body a push to rotate it. -.. _class_PhysicsServer_body_attach_object_instance_id: +.. _class_PhysicsServer_method_body_attach_object_instance_id: - void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. -.. _class_PhysicsServer_body_clear_shapes: +.. _class_PhysicsServer_method_body_clear_shapes: - void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. -.. _class_PhysicsServer_body_create: +.. _class_PhysicsServer_method_body_create: - :ref:`RID` **body_create** **(** :ref:`BodyMode` mode=2, :ref:`bool` init_sleeping=false **)** Creates a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. -.. _class_PhysicsServer_body_get_collision_layer: +.. _class_PhysicsServer_method_body_get_collision_layer: - :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body belongs to. -.. _class_PhysicsServer_body_get_collision_mask: +.. _class_PhysicsServer_method_body_get_collision_mask: - :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const @@ -824,93 +1072,93 @@ Returns the physics layer or layers a body can collide with. - -.. _class_PhysicsServer_body_get_direct_state: +.. _class_PhysicsServer_method_body_get_direct_state: - :ref:`PhysicsDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** Returns the :ref:`PhysicsDirectBodyState` of the body. -.. _class_PhysicsServer_body_get_kinematic_safe_margin: +.. _class_PhysicsServer_method_body_get_kinematic_safe_margin: - :ref:`float` **body_get_kinematic_safe_margin** **(** :ref:`RID` body **)** const -.. _class_PhysicsServer_body_get_max_contacts_reported: +.. _class_PhysicsServer_method_body_get_max_contacts_reported: - :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`. +Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. -.. _class_PhysicsServer_body_get_mode: +.. _class_PhysicsServer_method_body_get_mode: - :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. -.. _class_PhysicsServer_body_get_object_instance_id: +.. _class_PhysicsServer_method_body_get_object_instance_id: - :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const Gets the instance ID of the object the area is assigned to. -.. _class_PhysicsServer_body_get_param: +.. _class_PhysicsServer_method_body_get_param: - :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 BODY_PARAM\_\* constants. -.. _class_PhysicsServer_body_get_shape: +.. _class_PhysicsServer_method_body_get_shape: - :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of a body. -.. _class_PhysicsServer_body_get_shape_count: +.. _class_PhysicsServer_method_body_get_shape_count: - :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const Returns the number of shapes assigned to a body. -.. _class_PhysicsServer_body_get_shape_transform: +.. _class_PhysicsServer_method_body_get_shape_transform: - :ref:`Transform` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the transform matrix of a body shape. -.. _class_PhysicsServer_body_get_space: +.. _class_PhysicsServer_method_body_get_space: - :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const Returns the :ref:`RID` of the space assigned to a body. -.. _class_PhysicsServer_body_get_state: +.. _class_PhysicsServer_method_body_get_state: - :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const Returns a body state. -.. _class_PhysicsServer_body_is_axis_locked: +.. _class_PhysicsServer_method_body_is_axis_locked: - :ref:`bool` **body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const -.. _class_PhysicsServer_body_is_continuous_collision_detection_enabled: +.. _class_PhysicsServer_method_body_is_continuous_collision_detection_enabled: - :ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** const If ``true``, the continuous collision detection mode is enabled. -.. _class_PhysicsServer_body_is_omitting_force_integration: +.. _class_PhysicsServer_method_body_is_omitting_force_integration: - :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`). +Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). -.. _class_PhysicsServer_body_is_ray_pickable: +.. _class_PhysicsServer_method_body_is_ray_pickable: - :ref:`bool` **body_is_ray_pickable** **(** :ref:`RID` body **)** const If ``true``, the body can be detected by rays -.. _class_PhysicsServer_body_remove_collision_exception: +.. _class_PhysicsServer_method_body_remove_collision_exception: - void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** @@ -918,35 +1166,35 @@ Removes a body from the list of bodies exempt from collisions. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. -.. _class_PhysicsServer_body_remove_shape: +.. _class_PhysicsServer_method_body_remove_shape: - void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. -.. _class_PhysicsServer_body_set_axis_lock: +.. _class_PhysicsServer_method_body_set_axis_lock: - void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** -.. _class_PhysicsServer_body_set_axis_velocity: +.. _class_PhysicsServer_method_body_set_axis_velocity: - void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** 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. -.. _class_PhysicsServer_body_set_collision_layer: +.. _class_PhysicsServer_method_body_set_collision_layer: - void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** Sets the physics layer or layers a body belongs to. -.. _class_PhysicsServer_body_set_collision_mask: +.. _class_PhysicsServer_method_body_set_collision_mask: - void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** Sets the physics layer or layers a body can collide with. -.. _class_PhysicsServer_body_set_enable_continuous_collision_detection: +.. _class_PhysicsServer_method_body_set_enable_continuous_collision_detection: - void **body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** @@ -954,299 +1202,299 @@ If ``true``, the continuous collision detection mode is enabled. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. -.. _class_PhysicsServer_body_set_force_integration_callback: +.. _class_PhysicsServer_method_body_set_force_integration_callback: - void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** -Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration`). +Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration`). -.. _class_PhysicsServer_body_set_kinematic_safe_margin: +.. _class_PhysicsServer_method_body_set_kinematic_safe_margin: - void **body_set_kinematic_safe_margin** **(** :ref:`RID` body, :ref:`float` margin **)** -.. _class_PhysicsServer_body_set_max_contacts_reported: +.. _class_PhysicsServer_method_body_set_max_contacts_reported: - void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. -.. _class_PhysicsServer_body_set_mode: +.. _class_PhysicsServer_method_body_set_mode: - void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** Sets the body mode, from one of the constants BODY_MODE\*. -.. _class_PhysicsServer_body_set_omit_force_integration: +.. _class_PhysicsServer_method_body_set_omit_force_integration: - void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** -Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). +Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). -.. _class_PhysicsServer_body_set_param: +.. _class_PhysicsServer_method_body_set_param: - void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** Sets a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. -.. _class_PhysicsServer_body_set_ray_pickable: +.. _class_PhysicsServer_method_body_set_ray_pickable: - void **body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** Sets the body pickable with rays if ``enabled`` is set. -.. _class_PhysicsServer_body_set_shape: +.. _class_PhysicsServer_method_body_set_shape: - void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. -.. _class_PhysicsServer_body_set_shape_transform: +.. _class_PhysicsServer_method_body_set_shape_transform: - void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** Sets the transform matrix for a body shape. -.. _class_PhysicsServer_body_set_space: +.. _class_PhysicsServer_method_body_set_space: - void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** -Assigns a space to the body (see :ref:`create_space`). +Assigns a space to the body (see :ref:`create_space`). -.. _class_PhysicsServer_body_set_state: +.. _class_PhysicsServer_method_body_set_state: - void **body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** Sets a body state (see BODY_STATE\* constants). -.. _class_PhysicsServer_cone_twist_joint_get_param: +.. _class_PhysicsServer_method_cone_twist_joint_get_param: - :ref:`float` **cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const Gets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants). -.. _class_PhysicsServer_cone_twist_joint_set_param: +.. _class_PhysicsServer_method_cone_twist_joint_set_param: - void **cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** Sets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants). -.. _class_PhysicsServer_free_rid: +.. _class_PhysicsServer_method_free_rid: - void **free_rid** **(** :ref:`RID` rid **)** Destroys any of the objects created by PhysicsServer. If the :ref:`RID` passed is not one of the objects that can be created by PhysicsServer, an error will be sent to the console. -.. _class_PhysicsServer_generic_6dof_joint_get_flag: +.. _class_PhysicsServer_method_generic_6dof_joint_get_flag: -- :ref:`bool` **generic_6dof_joint_get_flag** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag **)** +- :ref:`bool` **generic_6dof_joint_get_flag** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants). -.. _class_PhysicsServer_generic_6dof_joint_get_param: +.. _class_PhysicsServer_method_generic_6dof_joint_get_param: -- :ref:`float` **generic_6dof_joint_get_param** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param **)** +- :ref:`float` **generic_6dof_joint_get_param** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** Gets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*). -.. _class_PhysicsServer_generic_6dof_joint_set_flag: +.. _class_PhysicsServer_method_generic_6dof_joint_set_flag: -- void **generic_6dof_joint_set_flag** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** +- void **generic_6dof_joint_set_flag** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** Sets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants). -.. _class_PhysicsServer_generic_6dof_joint_set_param: +.. _class_PhysicsServer_method_generic_6dof_joint_set_param: -- void **generic_6dof_joint_set_param** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** +- void **generic_6dof_joint_set_param** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** Sets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*). -.. _class_PhysicsServer_get_process_info: +.. _class_PhysicsServer_method_get_process_info: - :ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** Returns an Info defined by the :ref:`ProcessInfo` input given. -.. _class_PhysicsServer_hinge_joint_get_flag: +.. _class_PhysicsServer_method_hinge_joint_get_flag: - :ref:`bool` **hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const Gets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants). -.. _class_PhysicsServer_hinge_joint_get_param: +.. _class_PhysicsServer_method_hinge_joint_get_param: - :ref:`float` **hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const Gets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*). -.. _class_PhysicsServer_hinge_joint_set_flag: +.. _class_PhysicsServer_method_hinge_joint_set_flag: - void **hinge_joint_set_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** Sets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants). -.. _class_PhysicsServer_hinge_joint_set_param: +.. _class_PhysicsServer_method_hinge_joint_set_param: - void **hinge_joint_set_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** Sets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*). -.. _class_PhysicsServer_joint_create_cone_twist: +.. _class_PhysicsServer_method_joint_create_cone_twist: - :ref:`RID` **joint_create_cone_twist** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** Creates a :ref:`ConeTwistJoint`. -.. _class_PhysicsServer_joint_create_generic_6dof: +.. _class_PhysicsServer_method_joint_create_generic_6dof: - :ref:`RID` **joint_create_generic_6dof** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** Creates a :ref:`Generic6DOFJoint`. -.. _class_PhysicsServer_joint_create_hinge: +.. _class_PhysicsServer_method_joint_create_hinge: - :ref:`RID` **joint_create_hinge** **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** Creates a :ref:`HingeJoint`. -.. _class_PhysicsServer_joint_create_pin: +.. _class_PhysicsServer_method_joint_create_pin: - :ref:`RID` **joint_create_pin** **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** Creates a :ref:`PinJoint`. -.. _class_PhysicsServer_joint_create_slider: +.. _class_PhysicsServer_method_joint_create_slider: - :ref:`RID` **joint_create_slider** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** Creates a :ref:`SliderJoint`. -.. _class_PhysicsServer_joint_get_solver_priority: +.. _class_PhysicsServer_method_joint_get_solver_priority: - :ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** const Gets the priority value of the Joint. -.. _class_PhysicsServer_joint_get_type: +.. _class_PhysicsServer_method_joint_get_type: - :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of the Joint. -.. _class_PhysicsServer_joint_set_solver_priority: +.. _class_PhysicsServer_method_joint_set_solver_priority: - void **joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int` priority **)** Sets the priority value of the Joint. -.. _class_PhysicsServer_pin_joint_get_local_a: +.. _class_PhysicsServer_method_pin_joint_get_local_a: - :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. -.. _class_PhysicsServer_pin_joint_get_local_b: +.. _class_PhysicsServer_method_pin_joint_get_local_b: - :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. -.. _class_PhysicsServer_pin_joint_get_param: +.. _class_PhysicsServer_method_pin_joint_get_param: - :ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const Gets a pin_joint parameter (see PIN_JOINT\* constants). -.. _class_PhysicsServer_pin_joint_set_local_a: +.. _class_PhysicsServer_method_pin_joint_set_local_a: - void **pin_joint_set_local_a** **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** Sets position of the joint in the local space of body a of the joint. -.. _class_PhysicsServer_pin_joint_set_local_b: +.. _class_PhysicsServer_method_pin_joint_set_local_b: - void **pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** Sets position of the joint in the local space of body b of the joint. -.. _class_PhysicsServer_pin_joint_set_param: +.. _class_PhysicsServer_method_pin_joint_set_param: - void **pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** Sets a pin_joint parameter (see PIN_JOINT\* constants). -.. _class_PhysicsServer_set_active: +.. _class_PhysicsServer_method_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 3D physics engine. -.. _class_PhysicsServer_shape_create: +.. _class_PhysicsServer_method_shape_create: - :ref:`RID` **shape_create** **(** :ref:`ShapeType` type **)** -Creates a shape of type SHAPE\_\*. Does not assign it to a body or an area. To do so, you must use :ref:`area_set_shape` or :ref:`body_set_shape`. +Creates a shape of type SHAPE\_\*. Does not assign it to a body or an area. To do so, you must use :ref:`area_set_shape` or :ref:`body_set_shape`. -.. _class_PhysicsServer_shape_get_data: +.. _class_PhysicsServer_method_shape_get_data: - :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. -.. _class_PhysicsServer_shape_get_type: +.. _class_PhysicsServer_method_shape_get_type: - :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see SHAPE\_\* constants). -.. _class_PhysicsServer_shape_set_data: +.. _class_PhysicsServer_method_shape_set_data: - void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** -Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. +Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. -.. _class_PhysicsServer_slider_joint_get_param: +.. _class_PhysicsServer_method_slider_joint_get_param: - :ref:`float` **slider_joint_get_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const Gets a slider_joint parameter (see SLIDER_JOINT\* constants). -.. _class_PhysicsServer_slider_joint_set_param: +.. _class_PhysicsServer_method_slider_joint_set_param: - void **slider_joint_set_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** Gets a slider_joint parameter (see SLIDER_JOINT\* constants). -.. _class_PhysicsServer_space_create: +.. _class_PhysicsServer_method_space_create: - :ref:`RID` **space_create** **(** **)** -Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. +Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. -.. _class_PhysicsServer_space_get_direct_state: +.. _class_PhysicsServer_method_space_get_direct_state: - :ref:`PhysicsDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** Returns the state of a space, a :ref:`PhysicsDirectSpaceState`. This object can be used to make collision/intersection queries. -.. _class_PhysicsServer_space_get_param: +.. _class_PhysicsServer_method_space_get_param: - :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const Returns the value of a space parameter. -.. _class_PhysicsServer_space_is_active: +.. _class_PhysicsServer_method_space_is_active: - :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. -.. _class_PhysicsServer_space_set_active: +.. _class_PhysicsServer_method_space_set_active: - void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** Marks a space as active. It will not have an effect, unless it is assigned to an area or body. -.. _class_PhysicsServer_space_set_param: +.. _class_PhysicsServer_method_space_set_param: - void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index c6fa6d5fc..69a851db8 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -19,33 +19,33 @@ Brief Description Properties ---------- -+-----------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_areas` | -+-----------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_bodies` | -+-----------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-----------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`exclude` | -+-----------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin` | -+-----------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_rid` | -+-----------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`transform` | -+-----------------------------------+-----------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | ++-----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | ++-----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`exclude` | ++-----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin` | ++-----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shape_rid` | ++-----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`transform` | ++-----------------------------------+--------------------------------------------------------------------------------------------+ Methods ------- -+-------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | -+-------+-----------------------------------------------------------------------------------------------------------------+ ++------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | ++------+------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_PhysicsShapeQueryParameters_collide_with_areas: +.. _class_PhysicsShapeQueryParameters_property_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -55,7 +55,7 @@ Property Descriptions | *Getter* | is_collide_with_areas_enabled() | +----------+---------------------------------+ -.. _class_PhysicsShapeQueryParameters_collide_with_bodies: +.. _class_PhysicsShapeQueryParameters_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -65,7 +65,7 @@ Property Descriptions | *Getter* | is_collide_with_bodies_enabled() | +----------+----------------------------------+ -.. _class_PhysicsShapeQueryParameters_collision_mask: +.. _class_PhysicsShapeQueryParameters_property_collision_mask: - :ref:`int` **collision_mask** @@ -75,7 +75,7 @@ Property Descriptions | *Getter* | get_collision_mask() | +----------+---------------------------+ -.. _class_PhysicsShapeQueryParameters_exclude: +.. _class_PhysicsShapeQueryParameters_property_exclude: - :ref:`Array` **exclude** @@ -85,7 +85,7 @@ Property Descriptions | *Getter* | get_exclude() | +----------+--------------------+ -.. _class_PhysicsShapeQueryParameters_margin: +.. _class_PhysicsShapeQueryParameters_property_margin: - :ref:`float` **margin** @@ -95,7 +95,7 @@ Property Descriptions | *Getter* | get_margin() | +----------+-------------------+ -.. _class_PhysicsShapeQueryParameters_shape_rid: +.. _class_PhysicsShapeQueryParameters_property_shape_rid: - :ref:`RID` **shape_rid** @@ -105,7 +105,7 @@ Property Descriptions | *Getter* | get_shape_rid() | +----------+----------------------+ -.. _class_PhysicsShapeQueryParameters_transform: +.. _class_PhysicsShapeQueryParameters_property_transform: - :ref:`Transform` **transform** @@ -118,7 +118,7 @@ Property Descriptions Method Descriptions ------------------- -.. _class_PhysicsShapeQueryParameters_set_shape: +.. _class_PhysicsShapeQueryParameters_method_set_shape: - void **set_shape** **(** :ref:`Resource` shape **)** diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index 2d15ffa16..f8e3d1ddb 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -19,38 +19,38 @@ Result of a shape query in 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_PhysicsShapeQueryResult_get_result_count: +.. _class_PhysicsShapeQueryResult_method_get_result_count: - :ref:`int` **get_result_count** **(** **)** const -.. _class_PhysicsShapeQueryResult_get_result_object: +.. _class_PhysicsShapeQueryResult_method_get_result_object: - :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const -.. _class_PhysicsShapeQueryResult_get_result_object_id: +.. _class_PhysicsShapeQueryResult_method_get_result_object_id: - :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const -.. _class_PhysicsShapeQueryResult_get_result_object_shape: +.. _class_PhysicsShapeQueryResult_method_get_result_object_shape: - :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const -.. _class_PhysicsShapeQueryResult_get_result_rid: +.. _class_PhysicsShapeQueryResult_method_get_result_rid: - :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 534441a02..5a0bf0e53 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -19,19 +19,25 @@ Pin Joint for 3D Shapes. Properties ---------- -+---------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`params/bias` | -+---------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`params/damping` | -+---------------------------+------------------------------------------------------------------+ -| :ref:`float` | :ref:`params/impulse_clamp` | -+---------------------------+------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`params/bias` | ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`params/damping` | ++---------------------------+---------------------------------------------------------------------------+ +| :ref:`float` | :ref:`params/impulse_clamp` | ++---------------------------+---------------------------------------------------------------------------+ Enumerations ------------ .. _enum_PinJoint_Param: +.. _class_PinJoint_constant_PARAM_BIAS: + +.. _class_PinJoint_constant_PARAM_DAMPING: + +.. _class_PinJoint_constant_PARAM_IMPULSE_CLAMP: + enum **Param**: - **PARAM_BIAS** = **0** --- The force with which the pinned objects stay in positional relation to each other. @@ -52,7 +58,7 @@ Pin Joint for 3D Rigid Bodies. It pins 2 bodies (rigid or static) together. Property Descriptions --------------------- -.. _class_PinJoint_params/bias: +.. _class_PinJoint_property_params/bias: - :ref:`float` **params/bias** @@ -66,7 +72,7 @@ The force with which the pinned objects stay in positional relation to each othe The higher, the stronger. -.. _class_PinJoint_params/damping: +.. _class_PinJoint_property_params/damping: - :ref:`float` **params/damping** @@ -80,7 +86,7 @@ The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. -.. _class_PinJoint_params/impulse_clamp: +.. _class_PinJoint_property_params/impulse_clamp: - :ref:`float` **params/impulse_clamp** diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index 2fbd7a540..592484e34 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -19,9 +19,9 @@ Pin Joint for 2D Shapes. Properties ---------- -+---------------------------+--------------------------------------------+ -| :ref:`float` | :ref:`softness` | -+---------------------------+--------------------------------------------+ ++---------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`softness` | ++---------------------------+-----------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Pin Joint for 2D Rigid Bodies. It pins two bodies (rigid or static) together. Property Descriptions --------------------- -.. _class_PinJoint2D_softness: +.. _class_PinJoint2D_property_softness: - :ref:`float` **softness** diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 4119660ce..2af2d8d47 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -17,52 +17,58 @@ Plane in hessian form. Properties ---------- -+-------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`d` | -+-------------------------------+-----------------------------------+ -| :ref:`Vector3` | :ref:`normal` | -+-------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`x` | -+-------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`y` | -+-------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`z` | -+-------------------------------+-----------------------------------+ ++-------------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`d` | ++-------------------------------+--------------------------------------------+ +| :ref:`Vector3` | :ref:`normal` | ++-------------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`x` | ++-------------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`y` | ++-------------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`z` | ++-------------------------------+--------------------------------------------+ Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`float` d **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`center` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_any_point` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`intersect_3` **(** :ref:`Plane` b, :ref:`Plane` c **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`intersects_segment` **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_over` **(** :ref:`Vector3` point **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`normalized` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`Plane` **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`float` d **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`center` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_any_point` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`intersect_3` **(** :ref:`Plane` b, :ref:`Plane` c **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`intersects_segment` **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_over` **(** :ref:`Vector3` point **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`normalized` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_Plane_constant_PLANE_YZ: + +.. _class_Plane_constant_PLANE_XZ: + +.. _class_Plane_constant_PLANE_XY: + - **PLANE_YZ** = **Plane( 1, 0, 0, 0 )** - **PLANE_XZ** = **Plane( 0, 1, 0, 0 )** @@ -82,102 +88,98 @@ Tutorials Property Descriptions --------------------- -.. _class_Plane_d: +.. _class_Plane_property_d: - :ref:`float` **d** -.. _class_Plane_normal: +.. _class_Plane_property_normal: - :ref:`Vector3` **normal** -.. _class_Plane_x: +.. _class_Plane_property_x: - :ref:`float` **x** -.. _class_Plane_y: +.. _class_Plane_property_y: - :ref:`float` **y** -.. _class_Plane_z: +.. _class_Plane_property_z: - :ref:`float` **z** Method Descriptions ------------------- -.. _class_Plane_Plane: +.. _class_Plane_method_Plane: - :ref:`Plane` **Plane** **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** Creates a plane from the four parameters "a", "b", "c" and "d". -.. _class_Plane_Plane: - - :ref:`Plane` **Plane** **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** Creates a plane from three points. -.. _class_Plane_Plane: - - :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`float` d **)** Creates a plane from the normal and the plane's distance to the origin. -.. _class_Plane_center: +.. _class_Plane_method_center: - :ref:`Vector3` **center** **(** **)** Returns the center of the plane. -.. _class_Plane_distance_to: +.. _class_Plane_method_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector3` point **)** Returns the shortest distance from the plane to the position "point". -.. _class_Plane_get_any_point: +.. _class_Plane_method_get_any_point: - :ref:`Vector3` **get_any_point** **(** **)** Returns a point on the plane. -.. _class_Plane_has_point: +.. _class_Plane_method_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** Returns true if "point" is inside the plane (by a very minimum threshold). -.. _class_Plane_intersect_3: +.. _class_Plane_method_intersect_3: - :ref:`Vector3` **intersect_3** **(** :ref:`Plane` b, :ref:`Plane` c **)** Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned. -.. _class_Plane_intersects_ray: +.. _class_Plane_method_intersects_ray: - :ref:`Vector3` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned. -.. _class_Plane_intersects_segment: +.. _class_Plane_method_intersects_segment: - :ref:`Vector3` **intersects_segment** **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned. -.. _class_Plane_is_point_over: +.. _class_Plane_method_is_point_over: - :ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** Returns true if "point" is located above the plane. -.. _class_Plane_normalized: +.. _class_Plane_method_normalized: - :ref:`Plane` **normalized** **(** **)** Returns a copy of the plane, normalized. -.. _class_Plane_project: +.. _class_Plane_method_project: - :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 9926a243b..775cf8395 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -19,13 +19,13 @@ Class representing a planar :ref:`PrimitiveMesh`. Properties ---------- -+-------------------------------+---------------------------------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+-------------------------------+---------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_depth` | -+-------------------------------+---------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_width` | -+-------------------------------+---------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`size` | ++-------------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_depth` | ++-------------------------------+------------------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_width` | ++-------------------------------+------------------------------------------------------------------+ Description ----------- @@ -35,7 +35,7 @@ Class representing a planar :ref:`PrimitiveMesh`. This flat Property Descriptions --------------------- -.. _class_PlaneMesh_size: +.. _class_PlaneMesh_property_size: - :ref:`Vector2` **size** @@ -47,7 +47,7 @@ Property Descriptions Size of the generated plane. Defaults to (2.0, 2.0). -.. _class_PlaneMesh_subdivide_depth: +.. _class_PlaneMesh_property_subdivide_depth: - :ref:`int` **subdivide_depth** @@ -59,7 +59,7 @@ Size of the generated plane. Defaults to (2.0, 2.0). Number of subdivision along the z-axis. Defaults to 0. -.. _class_PlaneMesh_subdivide_width: +.. _class_PlaneMesh_property_subdivide_width: - :ref:`int` **subdivide_width** diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 8eb7ba135..45f70ca87 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+---------------------------+--------------------------------------+ -| :ref:`Plane` | :ref:`plane` | -+---------------------------+--------------------------------------+ ++---------------------------+-----------------------------------------------+ +| :ref:`Plane` | :ref:`plane` | ++---------------------------+-----------------------------------------------+ Property Descriptions --------------------- -.. _class_PlaneShape_plane: +.. _class_PlaneShape_property_plane: - :ref:`Plane` **plane** diff --git a/classes/class_pluginscript.rst b/classes/class_pluginscript.rst index c3f99f5a7..49fe0a057 100644 --- a/classes/class_pluginscript.rst +++ b/classes/class_pluginscript.rst @@ -19,14 +19,14 @@ Brief Description Methods ------- -+------------------------------+-------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+------------------------------+-------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++-----------------------------+--------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_PluginScript_new: +.. _class_PluginScript_method_new: - :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index a932b6596..ab08c3a21 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -19,60 +19,60 @@ A 2D polygon. Properties ---------- -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`antialiased` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`bones` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`invert_border` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`invert_enable` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`skeleton` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`splits` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`texture_offset` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`texture_rotation` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`texture_rotation_degrees` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`texture_scale` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`uv` | -+-------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`vertex_colors` | -+-------------------------------------------------+---------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`antialiased` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`bones` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`invert_border` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`invert_enable` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`offset` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`skeleton` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`splits` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`texture_offset` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`texture_rotation` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`texture_rotation_degrees` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`texture_scale` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`uv` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`vertex_colors` | ++-------------------------------------------------+------------------------------------------------------------------------------------+ Methods ------- -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bone` **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_bones` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_bone` **(** :ref:`int` index **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_count` **(** **)** const | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_bone_path` **(** :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 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_weights` **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bone` **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_bones` **(** **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_bone` **(** :ref:`int` index **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_count` **(** **)** const | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_bone_path` **(** :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 **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_weights` **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -82,7 +82,7 @@ A Polygon2D is defined by a set of points. Each point is connected to the next, Property Descriptions --------------------- -.. _class_Polygon2D_antialiased: +.. _class_Polygon2D_property_antialiased: - :ref:`bool` **antialiased** @@ -94,11 +94,11 @@ Property Descriptions If ``true``, polygon edges will be anti-aliased. Default value: ``false``. -.. _class_Polygon2D_bones: +.. _class_Polygon2D_property_bones: - :ref:`Array` **bones** -.. _class_Polygon2D_color: +.. _class_Polygon2D_property_color: - :ref:`Color` **color** @@ -110,7 +110,7 @@ If ``true``, polygon edges will be anti-aliased. Default value: ``false``. The polygon's fill color. If ``texture`` is defined, it will be multiplied by this color. It will also be the default color for vertices not set in ``vertex_colors``. -.. _class_Polygon2D_invert_border: +.. _class_Polygon2D_property_invert_border: - :ref:`float` **invert_border** @@ -122,7 +122,7 @@ The polygon's fill color. If ``texture`` is defined, it will be multiplied by th Added padding applied to the bounding box when using ``invert``. Setting this value too small may result in a "Bad Polygon" error. Default value: ``100``. -.. _class_Polygon2D_invert_enable: +.. _class_Polygon2D_property_invert_enable: - :ref:`bool` **invert_enable** @@ -134,7 +134,7 @@ Added padding applied to the bounding box when using ``invert``. Setting this va If ``true``, polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. Default value: ``false``. -.. _class_Polygon2D_offset: +.. _class_Polygon2D_property_offset: - :ref:`Vector2` **offset** @@ -146,7 +146,7 @@ If ``true``, polygon will be inverted, containing the area outside the defined p The offset applied to each vertex. -.. _class_Polygon2D_polygon: +.. _class_Polygon2D_property_polygon: - :ref:`PoolVector2Array` **polygon** @@ -158,7 +158,7 @@ The offset applied to each vertex. The polygon's list of vertices. The final point will be connected to the first. -.. _class_Polygon2D_skeleton: +.. _class_Polygon2D_property_skeleton: - :ref:`NodePath` **skeleton** @@ -168,7 +168,7 @@ The polygon's list of vertices. The final point will be connected to the first. | *Getter* | get_skeleton() | +----------+---------------------+ -.. _class_Polygon2D_splits: +.. _class_Polygon2D_property_splits: - :ref:`PoolIntArray` **splits** @@ -178,7 +178,7 @@ The polygon's list of vertices. The final point will be connected to the first. | *Getter* | get_splits() | +----------+-------------------+ -.. _class_Polygon2D_texture: +.. _class_Polygon2D_property_texture: - :ref:`Texture` **texture** @@ -190,7 +190,7 @@ The polygon's list of vertices. The final point will be connected to the first. The polygon's fill texture. Use ``uv`` to set texture coordinates. -.. _class_Polygon2D_texture_offset: +.. _class_Polygon2D_property_texture_offset: - :ref:`Vector2` **texture_offset** @@ -202,7 +202,7 @@ The polygon's fill texture. Use ``uv`` to set texture coordinates. Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin (its top-left corner) will be placed at the polygon's ``position``. -.. _class_Polygon2D_texture_rotation: +.. _class_Polygon2D_property_texture_rotation: - :ref:`float` **texture_rotation** @@ -214,7 +214,7 @@ Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin ( The texture's rotation in radians. -.. _class_Polygon2D_texture_rotation_degrees: +.. _class_Polygon2D_property_texture_rotation_degrees: - :ref:`float` **texture_rotation_degrees** @@ -226,7 +226,7 @@ The texture's rotation in radians. The texture's rotation in degrees. -.. _class_Polygon2D_texture_scale: +.. _class_Polygon2D_property_texture_scale: - :ref:`Vector2` **texture_scale** @@ -238,7 +238,7 @@ The texture's rotation in degrees. Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. -.. _class_Polygon2D_uv: +.. _class_Polygon2D_property_uv: - :ref:`PoolVector2Array` **uv** @@ -250,7 +250,7 @@ Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger value Texture coordinates for each vertex of the polygon. There should be one ``uv`` per polygon vertex. If there are fewer, undefined vertices will use ``(0, 0)``. -.. _class_Polygon2D_vertex_colors: +.. _class_Polygon2D_property_vertex_colors: - :ref:`PoolColorArray` **vertex_colors** @@ -265,35 +265,35 @@ Color for each vertex. Colors are interpolated between vertices, resulting in sm Method Descriptions ------------------- -.. _class_Polygon2D_add_bone: +.. _class_Polygon2D_method_add_bone: - void **add_bone** **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** -.. _class_Polygon2D_clear_bones: +.. _class_Polygon2D_method_clear_bones: - void **clear_bones** **(** **)** -.. _class_Polygon2D_erase_bone: +.. _class_Polygon2D_method_erase_bone: - void **erase_bone** **(** :ref:`int` index **)** -.. _class_Polygon2D_get_bone_count: +.. _class_Polygon2D_method_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const -.. _class_Polygon2D_get_bone_path: +.. _class_Polygon2D_method_get_bone_path: - :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** const -.. _class_Polygon2D_get_bone_weights: +.. _class_Polygon2D_method_get_bone_weights: - :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** const -.. _class_Polygon2D_set_bone_path: +.. _class_Polygon2D_method_set_bone_path: - void **set_bone_path** **(** :ref:`int` index, :ref:`NodePath` path **)** -.. _class_Polygon2D_set_bone_weights: +.. _class_Polygon2D_method_set_bone_weights: - void **set_bone_weights** **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index e566e83b7..581e004e7 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -19,56 +19,56 @@ Brief Description Methods ------- -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`setup` **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`setup` **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_PolygonPathFinder_find_path: +.. _class_PolygonPathFinder_method_find_path: - :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** -.. _class_PolygonPathFinder_get_bounds: +.. _class_PolygonPathFinder_method_get_bounds: - :ref:`Rect2` **get_bounds** **(** **)** const -.. _class_PolygonPathFinder_get_closest_point: +.. _class_PolygonPathFinder_method_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** const -.. _class_PolygonPathFinder_get_intersections: +.. _class_PolygonPathFinder_method_get_intersections: - :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const -.. _class_PolygonPathFinder_get_point_penalty: +.. _class_PolygonPathFinder_method_get_point_penalty: - :ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** const -.. _class_PolygonPathFinder_is_point_inside: +.. _class_PolygonPathFinder_method_is_point_inside: - :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** const -.. _class_PolygonPathFinder_set_point_penalty: +.. _class_PolygonPathFinder_method_set_point_penalty: - void **set_point_penalty** **(** :ref:`int` idx, :ref:`float` penalty **)** -.. _class_PolygonPathFinder_setup: +.. _class_PolygonPathFinder_method_setup: - void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index ad3b8b153..be44d78f6 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -17,37 +17,37 @@ A pooled :ref:`Array` of bytes. Methods ------- -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` byte **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` byte **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` byte **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` byte **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -57,91 +57,91 @@ An :ref:`Array` specifically designed to hold bytes. Optimized for Method Descriptions ------------------- -.. _class_PoolByteArray_PoolByteArray: +.. _class_PoolByteArray_method_PoolByteArray: - :ref:`PoolByteArray` **PoolByteArray** **(** :ref:`Array` from **)** Construct a new ``PoolByteArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. -.. _class_PoolByteArray_append: +.. _class_PoolByteArray_method_append: - void **append** **(** :ref:`int` byte **)** -Append an element at the end of the array (alias of :ref:`push_back`). +Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolByteArray_append_array: +.. _class_PoolByteArray_method_append_array: - void **append_array** **(** :ref:`PoolByteArray` array **)** Append a ``PoolByteArray`` at the end of this array. -.. _class_PoolByteArray_compress: +.. _class_PoolByteArray_method_compress: - :ref:`PoolByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** Returns a new ``PoolByteArray`` with the data compressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. -.. _class_PoolByteArray_decompress: +.. _class_PoolByteArray_method_decompress: - :ref:`PoolByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** Returns a new ``PoolByteArray`` with the data decompressed. Set ``buffer_size`` to the size of the uncompressed data. Set the compression mode using one of :ref:`CompressionMode`'s constants. -.. _class_PoolByteArray_get_string_from_ascii: +.. _class_PoolByteArray_method_get_string_from_ascii: - :ref:`String` **get_string_from_ascii** **(** **)** -Returns a copy of the array's contents as :ref:`String`. Fast alternative to :ref:`get_string_from_utf8` if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`get_string_from_utf8`. +Returns a copy of the array's contents as :ref:`String`. Fast alternative to :ref:`get_string_from_utf8` if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`get_string_from_utf8`. -.. _class_PoolByteArray_get_string_from_utf8: +.. _class_PoolByteArray_method_get_string_from_utf8: - :ref:`String` **get_string_from_utf8** **(** **)** -Returns a copy of the array's contents as :ref:`String`. Slower than :ref:`get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. +Returns a copy of the array's contents as :ref:`String`. Slower than :ref:`get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. -.. _class_PoolByteArray_insert: +.. _class_PoolByteArray_method_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` byte **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). -.. _class_PoolByteArray_invert: +.. _class_PoolByteArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolByteArray_push_back: +.. _class_PoolByteArray_method_push_back: - void **push_back** **(** :ref:`int` byte **)** Append an element at the end of the array. -.. _class_PoolByteArray_remove: +.. _class_PoolByteArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolByteArray_resize: +.. _class_PoolByteArray_method_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. -.. _class_PoolByteArray_set: +.. _class_PoolByteArray_method_set: - void **set** **(** :ref:`int` idx, :ref:`int` byte **)** Change the byte at the given index. -.. _class_PoolByteArray_size: +.. _class_PoolByteArray_method_size: - :ref:`int` **size** **(** **)** Return the size of the array. -.. _class_PoolByteArray_subarray: +.. _class_PoolByteArray_method_subarray: - :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index 21690d3e2..be7c9c316 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -17,27 +17,27 @@ A pooled :ref:`Array` of :ref:`Color`. Methods ------- -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`PoolColorArray` **(** :ref:`Array` from **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Color` color **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolColorArray` array **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Color` color **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`PoolColorArray` **(** :ref:`Array` from **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Color` color **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolColorArray` array **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Color` color **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -47,61 +47,61 @@ An :ref:`Array` specifically designed to hold :ref:`Color` **PoolColorArray** **(** :ref:`Array` from **)** Construct a new ``PoolColorArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. -.. _class_PoolColorArray_append: +.. _class_PoolColorArray_method_append: - void **append** **(** :ref:`Color` color **)** -Append an element at the end of the array (alias of :ref:`push_back`). +Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolColorArray_append_array: +.. _class_PoolColorArray_method_append_array: - void **append_array** **(** :ref:`PoolColorArray` array **)** Append a ``PoolColorArray`` at the end of this array. -.. _class_PoolColorArray_insert: +.. _class_PoolColorArray_method_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Color` color **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). -.. _class_PoolColorArray_invert: +.. _class_PoolColorArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolColorArray_push_back: +.. _class_PoolColorArray_method_push_back: - void **push_back** **(** :ref:`Color` color **)** Append a value to the array. -.. _class_PoolColorArray_remove: +.. _class_PoolColorArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolColorArray_resize: +.. _class_PoolColorArray_method_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. -.. _class_PoolColorArray_set: +.. _class_PoolColorArray_method_set: - void **set** **(** :ref:`int` idx, :ref:`Color` color **)** Change the :ref:`Color` at the given index. -.. _class_PoolColorArray_size: +.. _class_PoolColorArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index 402a58836..01b8486bf 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -17,27 +17,27 @@ A pooled :ref:`Array` of integers (:ref:`int`). Methods ------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`PoolIntArray` **(** :ref:`Array` from **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` integer **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolIntArray` array **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` integer **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` integer **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`PoolIntArray` **(** :ref:`Array` from **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` integer **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolIntArray` array **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` integer **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` integer **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -47,61 +47,61 @@ An :ref:`Array` specifically designed to hold integer values (:ref: Method Descriptions ------------------- -.. _class_PoolIntArray_PoolIntArray: +.. _class_PoolIntArray_method_PoolIntArray: - :ref:`PoolIntArray` **PoolIntArray** **(** :ref:`Array` from **)** Construct a new ``PoolIntArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. -.. _class_PoolIntArray_append: +.. _class_PoolIntArray_method_append: - void **append** **(** :ref:`int` integer **)** -Append an element at the end of the array (alias of :ref:`push_back`). +Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolIntArray_append_array: +.. _class_PoolIntArray_method_append_array: - void **append_array** **(** :ref:`PoolIntArray` array **)** Append a ``PoolIntArray`` at the end of this array. -.. _class_PoolIntArray_insert: +.. _class_PoolIntArray_method_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` integer **)** Insert a new int at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). -.. _class_PoolIntArray_invert: +.. _class_PoolIntArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolIntArray_push_back: +.. _class_PoolIntArray_method_push_back: - void **push_back** **(** :ref:`int` integer **)** Append a value to the array. -.. _class_PoolIntArray_remove: +.. _class_PoolIntArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolIntArray_resize: +.. _class_PoolIntArray_method_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. -.. _class_PoolIntArray_set: +.. _class_PoolIntArray_method_set: - void **set** **(** :ref:`int` idx, :ref:`int` integer **)** Change the int at the given index. -.. _class_PoolIntArray_size: +.. _class_PoolIntArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index 139403ded..3dbdd76b6 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -17,27 +17,27 @@ A pooled :ref:`Array` of reals (:ref:`float`). Methods ------- -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`PoolRealArray` **(** :ref:`Array` from **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`float` value **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolRealArray` array **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`float` value **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`float` value **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`PoolRealArray` **(** :ref:`Array` from **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`float` value **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolRealArray` array **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`float` value **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`float` value **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -47,61 +47,61 @@ An :ref:`Array` specifically designed to hold floating point values Method Descriptions ------------------- -.. _class_PoolRealArray_PoolRealArray: +.. _class_PoolRealArray_method_PoolRealArray: - :ref:`PoolRealArray` **PoolRealArray** **(** :ref:`Array` from **)** Construct a new ``PoolRealArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. -.. _class_PoolRealArray_append: +.. _class_PoolRealArray_method_append: - void **append** **(** :ref:`float` value **)** -Append an element at the end of the array (alias of :ref:`push_back`). +Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolRealArray_append_array: +.. _class_PoolRealArray_method_append_array: - void **append_array** **(** :ref:`PoolRealArray` array **)** Append a ``PoolRealArray`` at the end of this array. -.. _class_PoolRealArray_insert: +.. _class_PoolRealArray_method_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`float` value **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). -.. _class_PoolRealArray_invert: +.. _class_PoolRealArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolRealArray_push_back: +.. _class_PoolRealArray_method_push_back: - void **push_back** **(** :ref:`float` value **)** Append an element at the end of the array. -.. _class_PoolRealArray_remove: +.. _class_PoolRealArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolRealArray_resize: +.. _class_PoolRealArray_method_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. -.. _class_PoolRealArray_set: +.. _class_PoolRealArray_method_set: - void **set** **(** :ref:`int` idx, :ref:`float` value **)** Change the float at the given index. -.. _class_PoolRealArray_size: +.. _class_PoolRealArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 8aac77c58..7231bc795 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -17,29 +17,29 @@ A pooled :ref:`Array` of :ref:`String`. Methods ------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`PoolStringArray` **(** :ref:`Array` from **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`String` string **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolStringArray` array **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`join` **(** :ref:`String` delimiter **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`String` string **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`PoolStringArray` **(** :ref:`Array` from **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`String` string **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolStringArray` array **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`join` **(** :ref:`String` delimiter **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`String` string **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -49,67 +49,67 @@ An :ref:`Array` specifically designed to hold :ref:`String` **PoolStringArray** **(** :ref:`Array` from **)** Construct a new ``PoolStringArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. -.. _class_PoolStringArray_append: +.. _class_PoolStringArray_method_append: - void **append** **(** :ref:`String` string **)** -Append an element at the end of the array (alias of :ref:`push_back`). +Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolStringArray_append_array: +.. _class_PoolStringArray_method_append_array: - void **append_array** **(** :ref:`PoolStringArray` array **)** Append a ``PoolStringArray`` at the end of this array. -.. _class_PoolStringArray_insert: +.. _class_PoolStringArray_method_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`String` string **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). -.. _class_PoolStringArray_invert: +.. _class_PoolStringArray_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolStringArray_join: +.. _class_PoolStringArray_method_join: - :ref:`String` **join** **(** :ref:`String` delimiter **)** Returns a :ref:`String` with each element of the array joined with the given ``delimiter``. -.. _class_PoolStringArray_push_back: +.. _class_PoolStringArray_method_push_back: - void **push_back** **(** :ref:`String` string **)** Append a string element at end of the array. -.. _class_PoolStringArray_remove: +.. _class_PoolStringArray_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolStringArray_resize: +.. _class_PoolStringArray_method_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. -.. _class_PoolStringArray_set: +.. _class_PoolStringArray_method_set: - void **set** **(** :ref:`int` idx, :ref:`String` string **)** Change the :ref:`String` at the given index. -.. _class_PoolStringArray_size: +.. _class_PoolStringArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index 8053ca8d4..be06d8123 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -17,27 +17,27 @@ A pooled :ref:`Array` of :ref:`Vector2`. Methods ------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`PoolVector2Array` **(** :ref:`Array` from **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolVector2Array` array **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`PoolVector2Array` **(** :ref:`Array` from **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolVector2Array` array **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -47,61 +47,61 @@ An :ref:`Array` specifically designed to hold :ref:`Vector2` **PoolVector2Array** **(** :ref:`Array` from **)** Construct a new ``PoolVector2Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. -.. _class_PoolVector2Array_append: +.. _class_PoolVector2Array_method_append: - void **append** **(** :ref:`Vector2` vector2 **)** -Append an element at the end of the array (alias of :ref:`push_back`). +Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolVector2Array_append_array: +.. _class_PoolVector2Array_method_append_array: - void **append_array** **(** :ref:`PoolVector2Array` array **)** Append a ``PoolVector2Array`` at the end of this array. -.. _class_PoolVector2Array_insert: +.. _class_PoolVector2Array_method_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). -.. _class_PoolVector2Array_invert: +.. _class_PoolVector2Array_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolVector2Array_push_back: +.. _class_PoolVector2Array_method_push_back: - void **push_back** **(** :ref:`Vector2` vector2 **)** Insert a :ref:`Vector2` at the end. -.. _class_PoolVector2Array_remove: +.. _class_PoolVector2Array_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolVector2Array_resize: +.. _class_PoolVector2Array_method_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. -.. _class_PoolVector2Array_set: +.. _class_PoolVector2Array_method_set: - void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** Change the :ref:`Vector2` at the given index. -.. _class_PoolVector2Array_size: +.. _class_PoolVector2Array_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 716dd8040..416eea819 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -17,27 +17,27 @@ A pooled :ref:`Array` of :ref:`Vector3`. Methods ------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`PoolVector3Array` **(** :ref:`Array` from **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolVector3Array` array **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`PoolVector3Array` **(** :ref:`Array` from **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolVector3Array` array **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -47,61 +47,61 @@ An :ref:`Array` specifically designed to hold :ref:`Vector3` **PoolVector3Array** **(** :ref:`Array` from **)** Construct a new ``PoolVector3Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. -.. _class_PoolVector3Array_append: +.. _class_PoolVector3Array_method_append: - void **append** **(** :ref:`Vector3` vector3 **)** -Append an element at the end of the array (alias of :ref:`push_back`). +Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolVector3Array_append_array: +.. _class_PoolVector3Array_method_append_array: - void **append_array** **(** :ref:`PoolVector3Array` array **)** Append a ``PoolVector3Array`` at the end of this array. -.. _class_PoolVector3Array_insert: +.. _class_PoolVector3Array_method_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). -.. _class_PoolVector3Array_invert: +.. _class_PoolVector3Array_method_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolVector3Array_push_back: +.. _class_PoolVector3Array_method_push_back: - void **push_back** **(** :ref:`Vector3` vector3 **)** Insert a :ref:`Vector3` at the end. -.. _class_PoolVector3Array_remove: +.. _class_PoolVector3Array_method_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolVector3Array_resize: +.. _class_PoolVector3Array_method_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. -.. _class_PoolVector3Array_set: +.. _class_PoolVector3Array_method_set: - void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** Change the :ref:`Vector3` at the given index. -.. _class_PoolVector3Array_size: +.. _class_PoolVector3Array_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 3532a0e38..59ec904aa 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -21,33 +21,33 @@ Base container control for popups and dialogs. Properties ---------- -+-------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`popup_exclusive` | -+-------------------------+-----------------------------------------------------+ ++-------------------------+--------------------------------------------------------------+ +| :ref:`bool` | :ref:`popup_exclusive` | ++-------------------------+--------------------------------------------------------------+ Methods ------- -+-------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | -+-------+-------------------------------------------------------------------------------------------------------------------------------------+ ++------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | ++------+--------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Popup_about_to_show: +.. _class_Popup_signal_about_to_show: - **about_to_show** **(** **)** This signal is emitted when a popup is about to be shown. (often used in :ref:`PopupMenu` for clearing the list of options and creating a new one according to the current context). -.. _class_Popup_popup_hide: +.. _class_Popup_signal_popup_hide: - **popup_hide** **(** **)** @@ -56,6 +56,10 @@ This signal is emitted when a popup is hidden. Constants --------- +.. _class_Popup_constant_NOTIFICATION_POST_POPUP: + +.. _class_Popup_constant_NOTIFICATION_POPUP_HIDE: + - **NOTIFICATION_POST_POPUP** = **80** --- Notification sent right after the popup is shown. - **NOTIFICATION_POPUP_HIDE** = **81** --- Notification sent right after the popup is hidden. @@ -68,7 +72,7 @@ Popup is a base :ref:`Control` used to show dialogs and popups. I Property Descriptions --------------------- -.. _class_Popup_popup_exclusive: +.. _class_Popup_property_popup_exclusive: - :ref:`bool` **popup_exclusive** @@ -83,25 +87,25 @@ If ``true``, the popup will not be hidden when a click event occurs outside of i Method Descriptions ------------------- -.. _class_Popup_popup: +.. _class_Popup_method_popup: - void **popup** **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** Popup (show the control in modal form). -.. _class_Popup_popup_centered: +.. _class_Popup_method_popup_centered: - void **popup_centered** **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by "size". -.. _class_Popup_popup_centered_minsize: +.. _class_Popup_method_popup_centered_minsize: - void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, ensuring the size is never smaller than ``minsize``. -.. _class_Popup_popup_centered_ratio: +.. _class_Popup_method_popup_centered_ratio: - void **popup_centered_ratio** **(** :ref:`float` ratio=0.75 **)** diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index bd9aca7ca..9acdcd981 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -19,176 +19,176 @@ PopupMenu displays a list of options. Properties ---------- -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_on_checkable_item_selection` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_on_item_selection` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_on_state_item_selection` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`submenu_popup_delay` | -+---------------------------+-------------------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hide_on_checkable_item_selection` | ++---------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hide_on_item_selection` | ++---------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hide_on_state_item_selection` | ++---------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`submenu_popup_delay` | ++---------------------------+----------------------------------------------------------------------------------------------------+ Methods ------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_radio_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** :ref:`String` label="" **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** 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_index` **(** :ref:`int` id **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :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_text` **(** :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_item_checkable` **(** :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_radio_checkable` **(** :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 | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_window_lose_focus` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_radio_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_multistate` **(** :ref:`int` idx, :ref:`int` state **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_item_multistate` **(** :ref:`int` idx **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_radio_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_separator` **(** :ref:`String` label="" **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** 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_index` **(** :ref:`int` id **)** const | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :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_text` **(** :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_item_checkable` **(** :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_radio_checkable` **(** :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 | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_window_lose_focus` **(** :ref:`bool` enable **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_radio_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_multistate` **(** :ref:`int` idx, :ref:`int` state **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_multistate` **(** :ref:`int` idx **)** | ++---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`checked` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_accel` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`labeled_separator_left` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`labeled_separator_right` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`panel_disabled` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`radio_checked` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`radio_unchecked` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`separator` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`submenu` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`unchecked` | -+---------------------------------+-------------------------------------------------------------------------+ -| :ref:`int` | :ref:`vseparation` | -+---------------------------------+-------------------------------------------------------------------------+ ++---------------------------------+-------------------------+ +| :ref:`Texture` | checked | ++---------------------------------+-------------------------+ +| :ref:`Font` | font | ++---------------------------------+-------------------------+ +| :ref:`Color` | font_color | ++---------------------------------+-------------------------+ +| :ref:`Color` | font_color_accel | ++---------------------------------+-------------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+-------------------------+ +| :ref:`Color` | font_color_hover | ++---------------------------------+-------------------------+ +| :ref:`StyleBox` | hover | ++---------------------------------+-------------------------+ +| :ref:`int` | hseparation | ++---------------------------------+-------------------------+ +| :ref:`StyleBox` | labeled_separator_left | ++---------------------------------+-------------------------+ +| :ref:`StyleBox` | labeled_separator_right | ++---------------------------------+-------------------------+ +| :ref:`StyleBox` | panel | ++---------------------------------+-------------------------+ +| :ref:`StyleBox` | panel_disabled | ++---------------------------------+-------------------------+ +| :ref:`Texture` | radio_checked | ++---------------------------------+-------------------------+ +| :ref:`Texture` | radio_unchecked | ++---------------------------------+-------------------------+ +| :ref:`StyleBox` | separator | ++---------------------------------+-------------------------+ +| :ref:`Texture` | submenu | ++---------------------------------+-------------------------+ +| :ref:`Texture` | unchecked | ++---------------------------------+-------------------------+ +| :ref:`int` | vseparation | ++---------------------------------+-------------------------+ Signals ------- -.. _class_PopupMenu_id_focused: +.. _class_PopupMenu_signal_id_focused: - **id_focused** **(** :ref:`int` ID **)** This event is emitted when user navigated to an item of some id using ``ui_up`` or ``ui_down`` action. -.. _class_PopupMenu_id_pressed: +.. _class_PopupMenu_signal_id_pressed: - **id_pressed** **(** :ref:`int` ID **)** This event is emitted when an item of some id is pressed or its accelerator is activated. -.. _class_PopupMenu_index_pressed: +.. _class_PopupMenu_signal_index_pressed: - **index_pressed** **(** :ref:`int` index **)** @@ -202,7 +202,7 @@ PopupMenu is the typical Control that displays a list of options. They are popul Property Descriptions --------------------- -.. _class_PopupMenu_hide_on_checkable_item_selection: +.. _class_PopupMenu_property_hide_on_checkable_item_selection: - :ref:`bool` **hide_on_checkable_item_selection** @@ -212,7 +212,7 @@ Property Descriptions | *Getter* | is_hide_on_checkable_item_selection() | +----------+---------------------------------------------+ -.. _class_PopupMenu_hide_on_item_selection: +.. _class_PopupMenu_property_hide_on_item_selection: - :ref:`bool` **hide_on_item_selection** @@ -222,7 +222,7 @@ Property Descriptions | *Getter* | is_hide_on_item_selection() | +----------+-----------------------------------+ -.. _class_PopupMenu_hide_on_state_item_selection: +.. _class_PopupMenu_property_hide_on_state_item_selection: - :ref:`bool` **hide_on_state_item_selection** @@ -232,7 +232,7 @@ Property Descriptions | *Getter* | is_hide_on_state_item_selection() | +----------+-----------------------------------------+ -.. _class_PopupMenu_submenu_popup_delay: +.. _class_PopupMenu_property_submenu_popup_delay: - :ref:`float` **submenu_popup_delay** @@ -247,17 +247,17 @@ Sets the delay time for the submenu item to popup on mouse hovering. If the popu Method Descriptions ------------------- -.. _class_PopupMenu_add_check_item: +.. _class_PopupMenu_method_add_check_item: - void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. -.. _class_PopupMenu_add_check_shortcut: +.. _class_PopupMenu_method_add_check_shortcut: - void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** -.. _class_PopupMenu_add_icon_check_item: +.. _class_PopupMenu_method_add_icon_check_item: - void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** @@ -265,249 +265,249 @@ Add a new checkable item with text "label" and icon "texture". An id can optiona created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. -.. _class_PopupMenu_add_icon_check_shortcut: +.. _class_PopupMenu_method_add_icon_check_shortcut: - void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** -.. _class_PopupMenu_add_icon_item: +.. _class_PopupMenu_method_add_icon_item: - void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. -.. _class_PopupMenu_add_icon_shortcut: +.. _class_PopupMenu_method_add_icon_shortcut: - void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** -.. _class_PopupMenu_add_item: +.. _class_PopupMenu_method_add_item: - void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. -.. _class_PopupMenu_add_radio_check_item: +.. _class_PopupMenu_method_add_radio_check_item: - void **add_radio_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** -The same as :ref:`add_check_item` but the inserted item will look as a radio button. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. +The same as :ref:`add_check_item` but the inserted item will look as a radio button. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. -.. _class_PopupMenu_add_radio_check_shortcut: +.. _class_PopupMenu_method_add_radio_check_shortcut: - void **add_radio_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** -.. _class_PopupMenu_add_separator: +.. _class_PopupMenu_method_add_separator: - void **add_separator** **(** :ref:`String` label="" **)** Add a separator between items. Separators also occupy an index. -.. _class_PopupMenu_add_shortcut: +.. _class_PopupMenu_method_add_shortcut: - void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** -.. _class_PopupMenu_add_submenu_item: +.. _class_PopupMenu_method_add_submenu_item: - void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index. -.. _class_PopupMenu_clear: +.. _class_PopupMenu_method_clear: - void **clear** **(** **)** Clear the popup menu, in effect removing all items. -.. _class_PopupMenu_get_item_accelerator: +.. _class_PopupMenu_method_get_item_accelerator: - :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** const Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. -.. _class_PopupMenu_get_item_count: +.. _class_PopupMenu_method_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Return the amount of items. -.. _class_PopupMenu_get_item_icon: +.. _class_PopupMenu_method_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". -.. _class_PopupMenu_get_item_id: +.. _class_PopupMenu_method_get_item_id: - :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const Return the id of the item at index "idx". -.. _class_PopupMenu_get_item_index: +.. _class_PopupMenu_method_get_item_index: - :ref:`int` **get_item_index** **(** :ref:`int` id **)** const Find and return the index of the item containing a given id. -.. _class_PopupMenu_get_item_metadata: +.. _class_PopupMenu_method_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const -Return the metadata of an 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. +Return the metadata of an 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. -.. _class_PopupMenu_get_item_shortcut: +.. _class_PopupMenu_method_get_item_shortcut: - :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** const -.. _class_PopupMenu_get_item_submenu: +.. _class_PopupMenu_method_get_item_submenu: - :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const Return the submenu name of the item at index "idx". -.. _class_PopupMenu_get_item_text: +.. _class_PopupMenu_method_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text of the item at index "idx". -.. _class_PopupMenu_get_item_tooltip: +.. _class_PopupMenu_method_get_item_tooltip: - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const -.. _class_PopupMenu_is_hide_on_window_lose_focus: +.. _class_PopupMenu_method_is_hide_on_window_lose_focus: - :ref:`bool` **is_hide_on_window_lose_focus** **(** **)** const -.. _class_PopupMenu_is_item_checkable: +.. _class_PopupMenu_method_is_item_checkable: - :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const Return whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. -.. _class_PopupMenu_is_item_checked: +.. _class_PopupMenu_method_is_item_checked: - :ref:`bool` **is_item_checked** **(** :ref:`int` idx **)** const Return whether the item at index "idx" is checked. -.. _class_PopupMenu_is_item_disabled: +.. _class_PopupMenu_method_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. -.. _class_PopupMenu_is_item_radio_checkable: +.. _class_PopupMenu_method_is_item_radio_checkable: - :ref:`bool` **is_item_radio_checkable** **(** :ref:`int` idx **)** const Return whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. -.. _class_PopupMenu_is_item_separator: +.. _class_PopupMenu_method_is_item_separator: - :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** const Return whether the item is a separator. If it is, it would be displayed as a line. -.. _class_PopupMenu_is_item_shortcut_disabled: +.. _class_PopupMenu_method_is_item_shortcut_disabled: - :ref:`bool` **is_item_shortcut_disabled** **(** :ref:`int` idx **)** const -.. _class_PopupMenu_remove_item: +.. _class_PopupMenu_method_remove_item: - void **remove_item** **(** :ref:`int` idx **)** Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. -.. _class_PopupMenu_set_hide_on_window_lose_focus: +.. _class_PopupMenu_method_set_hide_on_window_lose_focus: - void **set_hide_on_window_lose_focus** **(** :ref:`bool` enable **)** -.. _class_PopupMenu_set_item_accelerator: +.. _class_PopupMenu_method_set_item_accelerator: - void **set_item_accelerator** **(** :ref:`int` idx, :ref:`int` accel **)** Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. -.. _class_PopupMenu_set_item_as_checkable: +.. _class_PopupMenu_method_set_item_as_checkable: - void **set_item_as_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. -.. _class_PopupMenu_set_item_as_radio_checkable: +.. _class_PopupMenu_method_set_item_as_radio_checkable: - void **set_item_as_radio_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** -The same as :ref:`set_item_as_checkable` but placing a radio button in case of enabling. If used for disabling, it's the same. +The same as :ref:`set_item_as_checkable` but placing a radio button in case of enabling. If used for disabling, it's the same. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. -.. _class_PopupMenu_set_item_as_separator: +.. _class_PopupMenu_method_set_item_as_separator: - void **set_item_as_separator** **(** :ref:`int` idx, :ref:`bool` enable **)** Mark the item at index "idx" as a separator, which means that it would be displayed as a mere line. -.. _class_PopupMenu_set_item_checked: +.. _class_PopupMenu_method_set_item_checked: - void **set_item_checked** **(** :ref:`int` idx, :ref:`bool` checked **)** Set the checkstate status of the item at index "idx". -.. _class_PopupMenu_set_item_disabled: +.. _class_PopupMenu_method_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. -.. _class_PopupMenu_set_item_icon: +.. _class_PopupMenu_method_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** -.. _class_PopupMenu_set_item_id: +.. _class_PopupMenu_method_set_item_id: - void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** Set the id of the item at index "idx". -.. _class_PopupMenu_set_item_metadata: +.. _class_PopupMenu_method_set_item_metadata: - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** -Sets the metadata of an item, which might be of any type. You can later get it with :ref:`get_item_metadata`, which provides a simple way of assigning context data to items. +Sets the metadata of an item, which might be of any type. You can later get it with :ref:`get_item_metadata`, which provides a simple way of assigning context data to items. -.. _class_PopupMenu_set_item_multistate: +.. _class_PopupMenu_method_set_item_multistate: - void **set_item_multistate** **(** :ref:`int` idx, :ref:`int` state **)** -.. _class_PopupMenu_set_item_shortcut: +.. _class_PopupMenu_method_set_item_shortcut: - void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** -.. _class_PopupMenu_set_item_shortcut_disabled: +.. _class_PopupMenu_method_set_item_shortcut_disabled: - void **set_item_shortcut_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** -.. _class_PopupMenu_set_item_submenu: +.. _class_PopupMenu_method_set_item_submenu: - void **set_item_submenu** **(** :ref:`int` idx, :ref:`String` submenu **)** Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. -.. _class_PopupMenu_set_item_text: +.. _class_PopupMenu_method_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Set the text of the item at index "idx". -.. _class_PopupMenu_set_item_tooltip: +.. _class_PopupMenu_method_set_item_tooltip: - void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** -.. _class_PopupMenu_toggle_item_checked: +.. _class_PopupMenu_method_toggle_item_checked: - void **toggle_item_checked** **(** :ref:`int` idx **)** -.. _class_PopupMenu_toggle_item_multistate: +.. _class_PopupMenu_method_toggle_item_multistate: - void **toggle_item_multistate** **(** :ref:`int` idx **)** diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 36624fb84..c0be46403 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -19,9 +19,9 @@ Class for displaying popups with a panel background. Theme Properties ---------------- -+---------------------------------+--------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+--------------------------------------+ ++---------------------------------+-------+ +| :ref:`StyleBox` | panel | ++---------------------------------+-------+ Description ----------- diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index df45bd2bf..3e86c96ea 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -21,20 +21,20 @@ Base class for all primitive meshes. Handles applying a :ref:`Material` | :ref:`custom_aabb` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`flip_faces` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Material` | :ref:`material` | -+---------------------------------+-----------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------+ +| :ref:`AABB` | :ref:`custom_aabb` | ++---------------------------------+--------------------------------------------------------------+ +| :ref:`bool` | :ref:`flip_faces` | ++---------------------------------+--------------------------------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------+--------------------------------------------------------------+ Methods ------- -+----------------------------+-------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | ++---------------------------+--------------------------------------------------------------------------------------+ Description ----------- @@ -44,7 +44,7 @@ Base class for all primitive meshes. Handles applying a :ref:`Material` **custom_aabb** @@ -54,7 +54,7 @@ Property Descriptions | *Getter* | get_custom_aabb() | +----------+------------------------+ -.. _class_PrimitiveMesh_flip_faces: +.. _class_PrimitiveMesh_property_flip_faces: - :ref:`bool` **flip_faces** @@ -64,7 +64,7 @@ Property Descriptions | *Getter* | get_flip_faces() | +----------+-----------------------+ -.. _class_PrimitiveMesh_material: +.. _class_PrimitiveMesh_property_material: - :ref:`Material` **material** @@ -79,7 +79,7 @@ The current :ref:`Material` of the primitive mesh. Method Descriptions ------------------- -.. _class_PrimitiveMesh_get_mesh_arrays: +.. _class_PrimitiveMesh_method_get_mesh_arrays: - :ref:`Array` **get_mesh_arrays** **(** **)** const diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 5df067def..b5db40623 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -19,17 +19,17 @@ Class representing a prism-shaped :ref:`PrimitiveMesh`. Properties ---------- -+-------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`left_to_right` | -+-------------------------------+-----------------------------------------------------------+ -| :ref:`Vector3` | :ref:`size` | -+-------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_depth` | -+-------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_height` | -+-------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`subdivide_width` | -+-------------------------------+-----------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`left_to_right` | ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`size` | ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_depth` | ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_height` | ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_width` | ++-------------------------------+--------------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ Class representing a prism-shaped :ref:`PrimitiveMesh`. Property Descriptions --------------------- -.. _class_PrismMesh_left_to_right: +.. _class_PrismMesh_property_left_to_right: - :ref:`float` **left_to_right** @@ -51,7 +51,7 @@ Property Descriptions Displacement of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint). -.. _class_PrismMesh_size: +.. _class_PrismMesh_property_size: - :ref:`Vector3` **size** @@ -63,7 +63,7 @@ Displacement of the upper edge along the x-axis. 0.0 positions edge straight abo Size of the prism. Defaults to (2.0, 2.0, 2.0). -.. _class_PrismMesh_subdivide_depth: +.. _class_PrismMesh_property_subdivide_depth: - :ref:`int` **subdivide_depth** @@ -75,7 +75,7 @@ Size of the prism. Defaults to (2.0, 2.0, 2.0). Number of added edge loops along the z-axis. Defaults to 0. -.. _class_PrismMesh_subdivide_height: +.. _class_PrismMesh_property_subdivide_height: - :ref:`int` **subdivide_height** @@ -87,7 +87,7 @@ Number of added edge loops along the z-axis. Defaults to 0. Number of added edge loops along the y-axis. Defaults to 0. -.. _class_PrismMesh_subdivide_width: +.. _class_PrismMesh_property_subdivide_width: - :ref:`int` **subdivide_width** diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index 26a6b79e9..29e80152f 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -19,45 +19,57 @@ Type of :ref:`Sky` that is generated procedurally based on user input Properties ---------- -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ground_bottom_color` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`ground_curve` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`ground_energy` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ground_horizon_color` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`sky_curve` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`sky_energy` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`sky_horizon_color` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`sky_top_color` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_angle_max` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_angle_min` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`sun_color` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_curve` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_energy` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_latitude` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`sun_longitude` | -+----------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`TextureSize` | :ref:`texture_size` | -+----------------------------------------------------+-----------------------------------------------------------------------+ ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ground_bottom_color` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ground_curve` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ground_energy` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ground_horizon_color` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sky_curve` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sky_energy` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`sky_horizon_color` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`sky_top_color` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sun_angle_max` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sun_angle_min` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`sun_color` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sun_curve` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sun_energy` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sun_latitude` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sun_longitude` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`TextureSize` | :ref:`texture_size` | ++----------------------------------------------------+--------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_ProceduralSky_TextureSize: +.. _class_ProceduralSky_constant_TEXTURE_SIZE_256: + +.. _class_ProceduralSky_constant_TEXTURE_SIZE_512: + +.. _class_ProceduralSky_constant_TEXTURE_SIZE_1024: + +.. _class_ProceduralSky_constant_TEXTURE_SIZE_2048: + +.. _class_ProceduralSky_constant_TEXTURE_SIZE_4096: + +.. _class_ProceduralSky_constant_TEXTURE_SIZE_MAX: + enum **TextureSize**: - **TEXTURE_SIZE_256** = **0** @@ -82,7 +94,7 @@ The ProceduralSky is updated on the CPU after the parameters change and stored i Property Descriptions --------------------- -.. _class_ProceduralSky_ground_bottom_color: +.. _class_ProceduralSky_property_ground_bottom_color: - :ref:`Color` **ground_bottom_color** @@ -94,7 +106,7 @@ Property Descriptions Color of the ground at the bottom. -.. _class_ProceduralSky_ground_curve: +.. _class_ProceduralSky_property_ground_curve: - :ref:`float` **ground_curve** @@ -104,9 +116,9 @@ Color of the ground at the bottom. | *Getter* | get_ground_curve() | +----------+-------------------------+ -How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. +How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. -.. _class_ProceduralSky_ground_energy: +.. _class_ProceduralSky_property_ground_energy: - :ref:`float` **ground_energy** @@ -118,7 +130,7 @@ How quickly the :ref:`ground_horizon_color` **ground_horizon_color** @@ -130,7 +142,7 @@ Amount of energy contribution from the ground. Color of the ground at the horizon. -.. _class_ProceduralSky_sky_curve: +.. _class_ProceduralSky_property_sky_curve: - :ref:`float` **sky_curve** @@ -140,9 +152,9 @@ Color of the ground at the horizon. | *Getter* | get_sky_curve() | +----------+----------------------+ -How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. +How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. -.. _class_ProceduralSky_sky_energy: +.. _class_ProceduralSky_property_sky_energy: - :ref:`float` **sky_energy** @@ -154,7 +166,7 @@ How quickly the :ref:`sky_horizon_color` Amount of energy contribution from the sky. -.. _class_ProceduralSky_sky_horizon_color: +.. _class_ProceduralSky_property_sky_horizon_color: - :ref:`Color` **sky_horizon_color** @@ -166,7 +178,7 @@ Amount of energy contribution from the sky. Color of the sky at the horizon. -.. _class_ProceduralSky_sky_top_color: +.. _class_ProceduralSky_property_sky_top_color: - :ref:`Color` **sky_top_color** @@ -178,7 +190,7 @@ Color of the sky at the horizon. Color of the sky at the top. -.. _class_ProceduralSky_sun_angle_max: +.. _class_ProceduralSky_property_sun_angle_max: - :ref:`float` **sun_angle_max** @@ -190,7 +202,7 @@ Color of the sky at the top. Distance from center of sun where it fades out completely. -.. _class_ProceduralSky_sun_angle_min: +.. _class_ProceduralSky_property_sun_angle_min: - :ref:`float` **sun_angle_min** @@ -202,7 +214,7 @@ Distance from center of sun where it fades out completely. Distance from sun where it goes from solid to starting to fade. -.. _class_ProceduralSky_sun_color: +.. _class_ProceduralSky_property_sun_color: - :ref:`Color` **sun_color** @@ -214,7 +226,7 @@ Distance from sun where it goes from solid to starting to fade. Color of the sun. -.. _class_ProceduralSky_sun_curve: +.. _class_ProceduralSky_property_sun_curve: - :ref:`float` **sun_curve** @@ -224,9 +236,9 @@ Color of the sun. | *Getter* | get_sun_curve() | +----------+----------------------+ -How quickly the sun fades away between :ref:`sun_angle_min` and :ref:`sun_angle_max` +How quickly the sun fades away between :ref:`sun_angle_min` and :ref:`sun_angle_max` -.. _class_ProceduralSky_sun_energy: +.. _class_ProceduralSky_property_sun_energy: - :ref:`float` **sun_energy** @@ -238,7 +250,7 @@ How quickly the sun fades away between :ref:`sun_angle_min` **sun_latitude** @@ -250,7 +262,7 @@ Amount of energy contribution from the sun. The suns height using polar coordinates. -.. _class_ProceduralSky_sun_longitude: +.. _class_ProceduralSky_property_sun_longitude: - :ref:`float` **sun_longitude** @@ -262,7 +274,7 @@ The suns height using polar coordinates. The direction of the sun using polar coordinates. -.. _class_ProceduralSky_texture_size: +.. _class_ProceduralSky_property_texture_size: - :ref:`TextureSize` **texture_size** diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 479c9d765..b8f061f0f 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -19,24 +19,24 @@ General purpose progress bar. Properties ---------- -+-------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`percent_visible` | -+-------------------------+-----------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`percent_visible` | ++-------------------------+--------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+---------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | -+---------------------------------+---------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`fg` | -+---------------------------------+---------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+---------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+---------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_shadow` | -+---------------------------------+---------------------------------------------------------------+ ++---------------------------------+-------------------+ +| :ref:`StyleBox` | bg | ++---------------------------------+-------------------+ +| :ref:`StyleBox` | fg | ++---------------------------------+-------------------+ +| :ref:`Font` | font | ++---------------------------------+-------------------+ +| :ref:`Color` | font_color | ++---------------------------------+-------------------+ +| :ref:`Color` | font_color_shadow | ++---------------------------------+-------------------+ Description ----------- @@ -46,7 +46,7 @@ General purpose progress bar. Shows fill percentage from right to left. Property Descriptions --------------------- -.. _class_ProgressBar_percent_visible: +.. _class_ProgressBar_property_percent_visible: - :ref:`bool` **percent_visible** diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 6f0e7df96..444148477 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -19,558 +19,558 @@ Contains global variables accessible from everywhere. Properties ---------- -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`application/boot_splash/bg_color` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/boot_splash/fullsize` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/boot_splash/image` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/custom_user_dir_name` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/icon` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/name` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/project_settings_override` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/config/use_custom_user_dir` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stderr` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stdout` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`application/run/frame_delay_msec` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/low_processor_mode` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/run/main_scene` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/channel_disable_threshold_db` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/channel_disable_time` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio/driver` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio/enable_audio_input` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/mix_rate` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/output_latency` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/video_delay_compensation_ms` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/gzip/compression_level` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zlib/compression_level` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zstd/compression_level` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/completion/autocomplete_setters_and_getters` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/constant_used_as_function` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/deprecated_keyword` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_constant` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_variable` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_may_yield` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/function_used_as_property` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/incompatible_ternary` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/integer_division` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/narrowing_conversion` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/property_used_as_function` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unreachable_code` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_cast` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_method_access` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_property_access` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_argument` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_class_variable` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_signal` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_variable` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/variable_conflicts_function` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/void_assignment` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`debug/settings/crash_handler/message` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/fps/force_fps` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/profiler/max_functions` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/visual_script/max_call_stack` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`display/mouse_cursor/custom_image` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/allow_per_pixel_transparency` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`display/window/handheld/orientation` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/per_pixel_transparency` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/per_pixel_transparency_splash` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/always_on_top` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/borderless` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/fullscreen` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/height` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/resizable` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/test_height` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/test_width` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/width` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/vsync/use_vsync` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor/active` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`gui/theme/custom` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`gui/theme/custom_font` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/theme/use_hidpi` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_accept` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_cancel` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_down` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_end` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_focus_next` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_focus_prev` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_home` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_left` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_page_down` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_page_up` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_right` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_select` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_up` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_1` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_10` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_11` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_12` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_13` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_14` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_15` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_16` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_17` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_18` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_19` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_2` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_20` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_3` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_4` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_5` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_6` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_7` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_8` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_9` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_1` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_10` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_11` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_12` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_13` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_14` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_15` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_16` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_17` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_18` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_19` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_2` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_20` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_3` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_4` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_5` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_6` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_7` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_8` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_9` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`locale/fallback` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`locale/test` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`logging/file_logging/enable_file_logging` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`logging/file_logging/log_path` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`logging/file_logging/max_log_files` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_chars_per_second` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_errors_per_frame` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger_stdout/max_messages_per_frame` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_in_buffer_kb` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_in_packets` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_out_buffer_kb` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_client/max_out_packets` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_in_buffer_kb` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_in_packets` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_out_buffer_kb` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/websocket_server/max_out_packets` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/remote_fs/page_size` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node/name_casing` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node/name_num_separator` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`physics/2d/physics_engine` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/2d/thread_model` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/3d/active_soft_world` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`physics/3d/physics_engine` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/common/physics_fps` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`rendering/environment/default_clear_color` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/blend_shape_max_buffer_size_kb` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_buffer_size_kb` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_index_buffer_size_kb` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/buffers/immediate_buffer_size_kb` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/2d/use_pixel_snap` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/quality/depth_prepass/disable_for_vendors` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/depth_prepass/enable` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/directional_shadow/size` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/directional_shadow/size.mobile` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/quality/driver/driver_fallback` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/quality/driver/driver_name` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/filters/anisotropic_filter_level` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation.mobile` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx.mobile` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections.mobile` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx.mobile` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley.mobile` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading.mobile` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_0_subdiv` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_1_subdiv` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_2_subdiv` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_3_subdiv` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size.mobile` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode.mobile` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/follow_surface` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/quality` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/scale` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/weight_samples` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/voxel_cone_tracing/high_quality` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/threads/thread_model` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_bptc` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_etc` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_etc2` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_pvrtc` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/vram_compression/import_s3tc` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`script` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`application/boot_splash/bg_color` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/boot_splash/fullsize` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/boot_splash/image` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/custom_user_dir_name` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/icon` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/name` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/project_settings_override` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/config/use_custom_user_dir` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stderr` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stdout` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`application/run/frame_delay_msec` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/low_processor_mode` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/run/main_scene` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/channel_disable_threshold_db` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/channel_disable_time` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio/driver` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio/enable_audio_input` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/mix_rate` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/output_latency` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/video_delay_compensation_ms` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/gzip/compression_level` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zlib/compression_level` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zstd/compression_level` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/completion/autocomplete_setters_and_getters` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/constant_used_as_function` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/deprecated_keyword` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_constant` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_variable` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_may_yield` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/function_used_as_property` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/incompatible_ternary` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/integer_division` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/narrowing_conversion` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/property_used_as_function` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unreachable_code` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_cast` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_method_access` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_property_access` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_argument` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_class_variable` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_signal` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/unused_variable` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/variable_conflicts_function` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/void_assignment` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`debug/settings/crash_handler/message` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/fps/force_fps` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/profiler/max_functions` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/visual_script/max_call_stack` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`display/mouse_cursor/custom_image` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/allow_per_pixel_transparency` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`display/window/handheld/orientation` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/per_pixel_transparency` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/per_pixel_transparency_splash` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/always_on_top` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/borderless` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/fullscreen` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/height` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/resizable` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/test_height` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/test_width` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/width` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/vsync/use_vsync` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor/active` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`gui/theme/custom` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`gui/theme/custom_font` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/theme/use_hidpi` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_accept` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_cancel` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_down` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_end` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_focus_next` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_focus_prev` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_home` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_left` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_page_down` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_page_up` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_right` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_select` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_up` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_1` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_10` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_11` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_12` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_13` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_14` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_15` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_16` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_17` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_18` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_19` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_2` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_20` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_3` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_4` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_5` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_6` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_7` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_8` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_9` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_1` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_10` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_11` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_12` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_13` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_14` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_15` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_16` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_17` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_18` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_19` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_2` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_20` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_3` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_4` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_5` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_6` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_7` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_8` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_9` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`locale/fallback` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`locale/test` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`logging/file_logging/enable_file_logging` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`logging/file_logging/log_path` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`logging/file_logging/max_log_files` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_chars_per_second` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_errors_per_frame` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger_stdout/max_messages_per_frame` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_in_buffer_kb` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_in_packets` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_out_buffer_kb` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_client/max_out_packets` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_in_buffer_kb` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_in_packets` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_out_buffer_kb` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/websocket_server/max_out_packets` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_size` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node/name_casing` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`node/name_num_separator` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`physics/2d/physics_engine` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/2d/thread_model` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/3d/active_soft_world` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`physics/3d/physics_engine` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/common/physics_fps` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`rendering/environment/default_clear_color` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/blend_shape_max_buffer_size_kb` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_buffer_size_kb` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_index_buffer_size_kb` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/buffers/immediate_buffer_size_kb` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/2d/use_pixel_snap` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/quality/depth_prepass/disable_for_vendors` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/depth_prepass/enable` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/directional_shadow/size` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/directional_shadow/size.mobile` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/quality/driver/driver_fallback` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/quality/driver/driver_name` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/filters/anisotropic_filter_level` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation.mobile` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx.mobile` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections.mobile` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx.mobile` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley.mobile` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading.mobile` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_0_subdiv` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_1_subdiv` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_2_subdiv` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_3_subdiv` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadow_atlas/size.mobile` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/shadows/filter_mode.mobile` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/follow_surface` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/quality` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/subsurface_scattering/scale` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/weight_samples` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/voxel_cone_tracing/high_quality` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/threads/thread_model` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_bptc` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_etc` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_etc2` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_pvrtc` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/vram_compression/import_s3tc` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`script` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Methods ------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` name **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_custom` **(** :ref:`String` file **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` position **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` name **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_custom` **(** :ref:`String` file **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` position **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -580,1240 +580,1240 @@ Contains global variables accessible from everywhere. Use "ProjectSettings.get_s Property Descriptions --------------------- -.. _class_ProjectSettings_application/boot_splash/bg_color: +.. _class_ProjectSettings_property_application/boot_splash/bg_color: - :ref:`Color` **application/boot_splash/bg_color** -.. _class_ProjectSettings_application/boot_splash/fullsize: +.. _class_ProjectSettings_property_application/boot_splash/fullsize: - :ref:`bool` **application/boot_splash/fullsize** Scale the boot splash image to the full window length when engine starts (will leave it as default pixel size otherwise). -.. _class_ProjectSettings_application/boot_splash/image: +.. _class_ProjectSettings_property_application/boot_splash/image: - :ref:`String` **application/boot_splash/image** Path to an image used for boot splash. -.. _class_ProjectSettings_application/config/custom_user_dir_name: +.. _class_ProjectSettings_property_application/config/custom_user_dir_name: - :ref:`String` **application/config/custom_user_dir_name** -This user directory is used for storing persistent data (``user://`` filesystem). By default (no custom name defined), ``user://`` resolves to a project-specific folder in Godot's own configuration folder (see :ref:`OS.get_user_data_dir`). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in :ref:`OS.get_user_data_dir`). +This user directory is used for storing persistent data (``user://`` filesystem). By default (no custom name defined), ``user://`` resolves to a project-specific folder in Godot's own configuration folder (see :ref:`OS.get_user_data_dir`). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in :ref:`OS.get_user_data_dir`). -The :ref:`use_custom_user_dir` setting must be enabled for this to take effect. +The :ref:`use_custom_user_dir` setting must be enabled for this to take effect. -.. _class_ProjectSettings_application/config/icon: +.. _class_ProjectSettings_property_application/config/icon: - :ref:`String` **application/config/icon** Icon used for the project, set when project loads. Exporters will use this icon when possible to. -.. _class_ProjectSettings_application/config/name: +.. _class_ProjectSettings_property_application/config/name: - :ref:`String` **application/config/name** Name of the project. It is used from both project manager and by the exporters. Overriding this as name.locale allows setting it in multiple languages. -.. _class_ProjectSettings_application/config/project_settings_override: +.. _class_ProjectSettings_property_application/config/project_settings_override: - :ref:`String` **application/config/project_settings_override** Specifies a file to override project settings. For example: ``user://custom_settings.cfg``. -.. _class_ProjectSettings_application/config/use_custom_user_dir: +.. _class_ProjectSettings_property_application/config/use_custom_user_dir: - :ref:`bool` **application/config/use_custom_user_dir** -Allow the project to save to its own custom user dir (see :ref:`custom_user_dir_name`). This setting only works for desktop platforms. A name must be set in the :ref:`custom_user_dir_name` setting for this to take effect. +Allow the project to save to its own custom user dir (see :ref:`custom_user_dir_name`). This setting only works for desktop platforms. A name must be set in the :ref:`custom_user_dir_name` setting for this to take effect. -.. _class_ProjectSettings_application/run/disable_stderr: +.. _class_ProjectSettings_property_application/run/disable_stderr: - :ref:`bool` **application/run/disable_stderr** Disable printing to stderr on exported build. -.. _class_ProjectSettings_application/run/disable_stdout: +.. _class_ProjectSettings_property_application/run/disable_stdout: - :ref:`bool` **application/run/disable_stdout** Disable printing to stdout on exported build. -.. _class_ProjectSettings_application/run/frame_delay_msec: +.. _class_ProjectSettings_property_application/run/frame_delay_msec: - :ref:`int` **application/run/frame_delay_msec** Force a delay between frames in the main loop. This may be useful if you plan to disable vsync. -.. _class_ProjectSettings_application/run/low_processor_mode: +.. _class_ProjectSettings_property_application/run/low_processor_mode: - :ref:`bool` **application/run/low_processor_mode** Turn on low processor mode. This setting only works on desktops. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) on games. -.. _class_ProjectSettings_application/run/low_processor_mode_sleep_usec: +.. _class_ProjectSettings_property_application/run/low_processor_mode_sleep_usec: - :ref:`int` **application/run/low_processor_mode_sleep_usec** Amount of sleeping between frames when the low_processor_mode is enabled. This effectively reduces CPU usage when this mode is enabled. -.. _class_ProjectSettings_application/run/main_scene: +.. _class_ProjectSettings_property_application/run/main_scene: - :ref:`String` **application/run/main_scene** Path to the main scene file that will be loaded when the project runs. -.. _class_ProjectSettings_audio/channel_disable_threshold_db: +.. _class_ProjectSettings_property_audio/channel_disable_threshold_db: - :ref:`float` **audio/channel_disable_threshold_db** Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. -.. _class_ProjectSettings_audio/channel_disable_time: +.. _class_ProjectSettings_property_audio/channel_disable_time: - :ref:`float` **audio/channel_disable_time** Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. -.. _class_ProjectSettings_audio/driver: +.. _class_ProjectSettings_property_audio/driver: - :ref:`String` **audio/driver** -.. _class_ProjectSettings_audio/enable_audio_input: +.. _class_ProjectSettings_property_audio/enable_audio_input: - :ref:`bool` **audio/enable_audio_input** This option should be enabled if project works with microphone. -.. _class_ProjectSettings_audio/mix_rate: +.. _class_ProjectSettings_property_audio/mix_rate: - :ref:`int` **audio/mix_rate** Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system. -.. _class_ProjectSettings_audio/output_latency: +.. _class_ProjectSettings_property_audio/output_latency: - :ref:`int` **audio/output_latency** -.. _class_ProjectSettings_audio/video_delay_compensation_ms: +.. _class_ProjectSettings_property_audio/video_delay_compensation_ms: - :ref:`int` **audio/video_delay_compensation_ms** Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. -.. _class_ProjectSettings_compression/formats/gzip/compression_level: +.. _class_ProjectSettings_property_compression/formats/gzip/compression_level: - :ref:`int` **compression/formats/gzip/compression_level** Default compression level for gzip. Affects compressed scenes and resources. -.. _class_ProjectSettings_compression/formats/zlib/compression_level: +.. _class_ProjectSettings_property_compression/formats/zlib/compression_level: - :ref:`int` **compression/formats/zlib/compression_level** Default compression level for zlib. Affects compressed scenes and resources. -.. _class_ProjectSettings_compression/formats/zstd/compression_level: +.. _class_ProjectSettings_property_compression/formats/zstd/compression_level: - :ref:`int` **compression/formats/zstd/compression_level** Default compression level for zstd. Affects compressed scenes and resources. -.. _class_ProjectSettings_compression/formats/zstd/long_distance_matching: +.. _class_ProjectSettings_property_compression/formats/zstd/long_distance_matching: - :ref:`bool` **compression/formats/zstd/long_distance_matching** Enable long distance matching in zstd. -.. _class_ProjectSettings_compression/formats/zstd/window_log_size: +.. _class_ProjectSettings_property_compression/formats/zstd/window_log_size: - :ref:`int` **compression/formats/zstd/window_log_size** -.. _class_ProjectSettings_debug/gdscript/completion/autocomplete_setters_and_getters: +.. _class_ProjectSettings_property_debug/gdscript/completion/autocomplete_setters_and_getters: - :ref:`bool` **debug/gdscript/completion/autocomplete_setters_and_getters** -.. _class_ProjectSettings_debug/gdscript/warnings/constant_used_as_function: +.. _class_ProjectSettings_property_debug/gdscript/warnings/constant_used_as_function: - :ref:`bool` **debug/gdscript/warnings/constant_used_as_function** -.. _class_ProjectSettings_debug/gdscript/warnings/deprecated_keyword: +.. _class_ProjectSettings_property_debug/gdscript/warnings/deprecated_keyword: - :ref:`bool` **debug/gdscript/warnings/deprecated_keyword** -.. _class_ProjectSettings_debug/gdscript/warnings/enable: +.. _class_ProjectSettings_property_debug/gdscript/warnings/enable: - :ref:`bool` **debug/gdscript/warnings/enable** -.. _class_ProjectSettings_debug/gdscript/warnings/function_conflicts_constant: +.. _class_ProjectSettings_property_debug/gdscript/warnings/function_conflicts_constant: - :ref:`bool` **debug/gdscript/warnings/function_conflicts_constant** -.. _class_ProjectSettings_debug/gdscript/warnings/function_conflicts_variable: +.. _class_ProjectSettings_property_debug/gdscript/warnings/function_conflicts_variable: - :ref:`bool` **debug/gdscript/warnings/function_conflicts_variable** -.. _class_ProjectSettings_debug/gdscript/warnings/function_may_yield: +.. _class_ProjectSettings_property_debug/gdscript/warnings/function_may_yield: - :ref:`bool` **debug/gdscript/warnings/function_may_yield** -.. _class_ProjectSettings_debug/gdscript/warnings/function_used_as_property: +.. _class_ProjectSettings_property_debug/gdscript/warnings/function_used_as_property: - :ref:`bool` **debug/gdscript/warnings/function_used_as_property** -.. _class_ProjectSettings_debug/gdscript/warnings/incompatible_ternary: +.. _class_ProjectSettings_property_debug/gdscript/warnings/incompatible_ternary: - :ref:`bool` **debug/gdscript/warnings/incompatible_ternary** -.. _class_ProjectSettings_debug/gdscript/warnings/integer_division: +.. _class_ProjectSettings_property_debug/gdscript/warnings/integer_division: - :ref:`bool` **debug/gdscript/warnings/integer_division** -.. _class_ProjectSettings_debug/gdscript/warnings/narrowing_conversion: +.. _class_ProjectSettings_property_debug/gdscript/warnings/narrowing_conversion: - :ref:`bool` **debug/gdscript/warnings/narrowing_conversion** -.. _class_ProjectSettings_debug/gdscript/warnings/property_used_as_function: +.. _class_ProjectSettings_property_debug/gdscript/warnings/property_used_as_function: - :ref:`bool` **debug/gdscript/warnings/property_used_as_function** -.. _class_ProjectSettings_debug/gdscript/warnings/return_value_discarded: +.. _class_ProjectSettings_property_debug/gdscript/warnings/return_value_discarded: - :ref:`bool` **debug/gdscript/warnings/return_value_discarded** -.. _class_ProjectSettings_debug/gdscript/warnings/standalone_expression: +.. _class_ProjectSettings_property_debug/gdscript/warnings/standalone_expression: - :ref:`bool` **debug/gdscript/warnings/standalone_expression** -.. _class_ProjectSettings_debug/gdscript/warnings/treat_warnings_as_errors: +.. _class_ProjectSettings_property_debug/gdscript/warnings/treat_warnings_as_errors: - :ref:`bool` **debug/gdscript/warnings/treat_warnings_as_errors** -.. _class_ProjectSettings_debug/gdscript/warnings/unassigned_variable: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unassigned_variable: - :ref:`bool` **debug/gdscript/warnings/unassigned_variable** -.. _class_ProjectSettings_debug/gdscript/warnings/unassigned_variable_op_assign: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unassigned_variable_op_assign: - :ref:`bool` **debug/gdscript/warnings/unassigned_variable_op_assign** -.. _class_ProjectSettings_debug/gdscript/warnings/unreachable_code: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unreachable_code: - :ref:`bool` **debug/gdscript/warnings/unreachable_code** -.. _class_ProjectSettings_debug/gdscript/warnings/unsafe_call_argument: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_call_argument: - :ref:`bool` **debug/gdscript/warnings/unsafe_call_argument** -.. _class_ProjectSettings_debug/gdscript/warnings/unsafe_cast: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_cast: - :ref:`bool` **debug/gdscript/warnings/unsafe_cast** -.. _class_ProjectSettings_debug/gdscript/warnings/unsafe_method_access: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_method_access: - :ref:`bool` **debug/gdscript/warnings/unsafe_method_access** -.. _class_ProjectSettings_debug/gdscript/warnings/unsafe_property_access: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unsafe_property_access: - :ref:`bool` **debug/gdscript/warnings/unsafe_property_access** -.. _class_ProjectSettings_debug/gdscript/warnings/unused_argument: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unused_argument: - :ref:`bool` **debug/gdscript/warnings/unused_argument** -.. _class_ProjectSettings_debug/gdscript/warnings/unused_class_variable: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unused_class_variable: - :ref:`bool` **debug/gdscript/warnings/unused_class_variable** -.. _class_ProjectSettings_debug/gdscript/warnings/unused_signal: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unused_signal: - :ref:`bool` **debug/gdscript/warnings/unused_signal** -.. _class_ProjectSettings_debug/gdscript/warnings/unused_variable: +.. _class_ProjectSettings_property_debug/gdscript/warnings/unused_variable: - :ref:`bool` **debug/gdscript/warnings/unused_variable** -.. _class_ProjectSettings_debug/gdscript/warnings/variable_conflicts_function: +.. _class_ProjectSettings_property_debug/gdscript/warnings/variable_conflicts_function: - :ref:`bool` **debug/gdscript/warnings/variable_conflicts_function** -.. _class_ProjectSettings_debug/gdscript/warnings/void_assignment: +.. _class_ProjectSettings_property_debug/gdscript/warnings/void_assignment: - :ref:`bool` **debug/gdscript/warnings/void_assignment** -.. _class_ProjectSettings_debug/settings/crash_handler/message: +.. _class_ProjectSettings_property_debug/settings/crash_handler/message: - :ref:`String` **debug/settings/crash_handler/message** -.. _class_ProjectSettings_debug/settings/fps/force_fps: +.. _class_ProjectSettings_property_debug/settings/fps/force_fps: - :ref:`int` **debug/settings/fps/force_fps** -.. _class_ProjectSettings_debug/settings/gdscript/max_call_stack: +.. _class_ProjectSettings_property_debug/settings/gdscript/max_call_stack: - :ref:`int` **debug/settings/gdscript/max_call_stack** Maximum call stack allowed for debugging GDScript. -.. _class_ProjectSettings_debug/settings/profiler/max_functions: +.. _class_ProjectSettings_property_debug/settings/profiler/max_functions: - :ref:`int` **debug/settings/profiler/max_functions** Maximum amount of functions per frame allowed when profiling. -.. _class_ProjectSettings_debug/settings/stdout/print_fps: +.. _class_ProjectSettings_property_debug/settings/stdout/print_fps: - :ref:`bool` **debug/settings/stdout/print_fps** Print frames per second to stdout. Not very useful in general. -.. _class_ProjectSettings_debug/settings/stdout/verbose_stdout: +.. _class_ProjectSettings_property_debug/settings/stdout/verbose_stdout: - :ref:`bool` **debug/settings/stdout/verbose_stdout** Print more information to stdout when running. It shows info such as memory leaks, which scenes and resources are being loaded, etc. -.. _class_ProjectSettings_debug/settings/visual_script/max_call_stack: +.. _class_ProjectSettings_property_debug/settings/visual_script/max_call_stack: - :ref:`int` **debug/settings/visual_script/max_call_stack** Maximum call stack in visual scripting, to avoid infinite recursion. -.. _class_ProjectSettings_display/mouse_cursor/custom_image: +.. _class_ProjectSettings_property_display/mouse_cursor/custom_image: - :ref:`String` **display/mouse_cursor/custom_image** Custom image for the mouse cursor. -.. _class_ProjectSettings_display/mouse_cursor/custom_image_hotspot: +.. _class_ProjectSettings_property_display/mouse_cursor/custom_image_hotspot: - :ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** Hotspot for the custom mouse cursor image. -.. _class_ProjectSettings_display/window/allow_per_pixel_transparency: +.. _class_ProjectSettings_property_display/window/allow_per_pixel_transparency: - :ref:`bool` **display/window/allow_per_pixel_transparency** Allow per pixel transparency in a Desktop window. This affects performance if not needed, so leave it off. -.. _class_ProjectSettings_display/window/dpi/allow_hidpi: +.. _class_ProjectSettings_property_display/window/dpi/allow_hidpi: - :ref:`bool` **display/window/dpi/allow_hidpi** Allow HiDPI display on Windows and OSX. On Desktop Linux, this can't be enabled or disabled. -.. _class_ProjectSettings_display/window/energy_saving/keep_screen_on: +.. _class_ProjectSettings_property_display/window/energy_saving/keep_screen_on: - :ref:`bool` **display/window/energy_saving/keep_screen_on** Force keep the screen on, so the screensaver does not take over. Works on Desktop and Mobile. -.. _class_ProjectSettings_display/window/handheld/orientation: +.. _class_ProjectSettings_property_display/window/handheld/orientation: - :ref:`String` **display/window/handheld/orientation** Default orientation for cell phone or tablet. -.. _class_ProjectSettings_display/window/per_pixel_transparency: +.. _class_ProjectSettings_property_display/window/per_pixel_transparency: - :ref:`bool` **display/window/per_pixel_transparency** -.. _class_ProjectSettings_display/window/per_pixel_transparency_splash: +.. _class_ProjectSettings_property_display/window/per_pixel_transparency_splash: - :ref:`bool` **display/window/per_pixel_transparency_splash** -.. _class_ProjectSettings_display/window/size/always_on_top: +.. _class_ProjectSettings_property_display/window/size/always_on_top: - :ref:`bool` **display/window/size/always_on_top** Force the window to be always on top. -.. _class_ProjectSettings_display/window/size/borderless: +.. _class_ProjectSettings_property_display/window/size/borderless: - :ref:`bool` **display/window/size/borderless** Force the window to be borderless. -.. _class_ProjectSettings_display/window/size/fullscreen: +.. _class_ProjectSettings_property_display/window/size/fullscreen: - :ref:`bool` **display/window/size/fullscreen** Set the window to full screen when it starts. -.. _class_ProjectSettings_display/window/size/height: +.. _class_ProjectSettings_property_display/window/size/height: - :ref:`int` **display/window/size/height** Set the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. -.. _class_ProjectSettings_display/window/size/resizable: +.. _class_ProjectSettings_property_display/window/size/resizable: - :ref:`bool` **display/window/size/resizable** Allow the window to be resizable by default. -.. _class_ProjectSettings_display/window/size/test_height: +.. _class_ProjectSettings_property_display/window/size/test_height: - :ref:`int` **display/window/size/test_height** Test a different height for the window. The main use for this is to test with stretch modes. -.. _class_ProjectSettings_display/window/size/test_width: +.. _class_ProjectSettings_property_display/window/size/test_width: - :ref:`int` **display/window/size/test_width** Test a different width for the window. The main use for this is to test with stretch modes. -.. _class_ProjectSettings_display/window/size/width: +.. _class_ProjectSettings_property_display/window/size/width: - :ref:`int` **display/window/size/width** Set the main window width. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. -.. _class_ProjectSettings_display/window/vsync/use_vsync: +.. _class_ProjectSettings_property_display/window/vsync/use_vsync: - :ref:`bool` **display/window/vsync/use_vsync** Use VSync. Don't be stupid, don't turn this off. -.. _class_ProjectSettings_editor/active: +.. _class_ProjectSettings_property_editor/active: - :ref:`bool` **editor/active** Internal editor setting, don't touch. -.. _class_ProjectSettings_gui/common/default_scroll_deadzone: +.. _class_ProjectSettings_property_gui/common/default_scroll_deadzone: - :ref:`int` **gui/common/default_scroll_deadzone** -.. _class_ProjectSettings_gui/common/swap_ok_cancel: +.. _class_ProjectSettings_property_gui/common/swap_ok_cancel: - :ref:`bool` **gui/common/swap_ok_cancel** Enable swap OK and Cancel buttons on dialogs. This is because Windows/MacOS/Desktop Linux may use them in different order, so the GUI swaps them depending on the host OS. Disable this behavior by turning this setting off. -.. _class_ProjectSettings_gui/theme/custom: +.. _class_ProjectSettings_property_gui/theme/custom: - :ref:`String` **gui/theme/custom** Use a custom theme resource, set a path to it here. -.. _class_ProjectSettings_gui/theme/custom_font: +.. _class_ProjectSettings_property_gui/theme/custom_font: - :ref:`String` **gui/theme/custom_font** USe a custom default font resource, set a path to it here. -.. _class_ProjectSettings_gui/theme/use_hidpi: +.. _class_ProjectSettings_property_gui/theme/use_hidpi: - :ref:`bool` **gui/theme/use_hidpi** Make sure the theme used works with hidpi. -.. _class_ProjectSettings_gui/timers/incremental_search_max_interval_msec: +.. _class_ProjectSettings_property_gui/timers/incremental_search_max_interval_msec: - :ref:`int` **gui/timers/incremental_search_max_interval_msec** Timer setting for incremental search in Tree, IntemList, etc. controls. -.. _class_ProjectSettings_gui/timers/text_edit_idle_detect_sec: +.. _class_ProjectSettings_property_gui/timers/text_edit_idle_detect_sec: - :ref:`float` **gui/timers/text_edit_idle_detect_sec** Timer for detecting idle in the editor. -.. _class_ProjectSettings_input/ui_accept: +.. _class_ProjectSettings_property_input/ui_accept: - :ref:`Dictionary` **input/ui_accept** -.. _class_ProjectSettings_input/ui_cancel: +.. _class_ProjectSettings_property_input/ui_cancel: - :ref:`Dictionary` **input/ui_cancel** -.. _class_ProjectSettings_input/ui_down: +.. _class_ProjectSettings_property_input/ui_down: - :ref:`Dictionary` **input/ui_down** -.. _class_ProjectSettings_input/ui_end: +.. _class_ProjectSettings_property_input/ui_end: - :ref:`Dictionary` **input/ui_end** -.. _class_ProjectSettings_input/ui_focus_next: +.. _class_ProjectSettings_property_input/ui_focus_next: - :ref:`Dictionary` **input/ui_focus_next** -.. _class_ProjectSettings_input/ui_focus_prev: +.. _class_ProjectSettings_property_input/ui_focus_prev: - :ref:`Dictionary` **input/ui_focus_prev** -.. _class_ProjectSettings_input/ui_home: +.. _class_ProjectSettings_property_input/ui_home: - :ref:`Dictionary` **input/ui_home** -.. _class_ProjectSettings_input/ui_left: +.. _class_ProjectSettings_property_input/ui_left: - :ref:`Dictionary` **input/ui_left** -.. _class_ProjectSettings_input/ui_page_down: +.. _class_ProjectSettings_property_input/ui_page_down: - :ref:`Dictionary` **input/ui_page_down** -.. _class_ProjectSettings_input/ui_page_up: +.. _class_ProjectSettings_property_input/ui_page_up: - :ref:`Dictionary` **input/ui_page_up** -.. _class_ProjectSettings_input/ui_right: +.. _class_ProjectSettings_property_input/ui_right: - :ref:`Dictionary` **input/ui_right** -.. _class_ProjectSettings_input/ui_select: +.. _class_ProjectSettings_property_input/ui_select: - :ref:`Dictionary` **input/ui_select** -.. _class_ProjectSettings_input/ui_up: +.. _class_ProjectSettings_property_input/ui_up: - :ref:`Dictionary` **input/ui_up** -.. _class_ProjectSettings_input_devices/pointing/emulate_mouse_from_touch: +.. _class_ProjectSettings_property_input_devices/pointing/emulate_mouse_from_touch: - :ref:`bool` **input_devices/pointing/emulate_mouse_from_touch** -.. _class_ProjectSettings_input_devices/pointing/emulate_touch_from_mouse: +.. _class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse: - :ref:`bool` **input_devices/pointing/emulate_touch_from_mouse** -.. _class_ProjectSettings_layer_names/2d_physics/layer_1: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_1: - :ref:`String` **layer_names/2d_physics/layer_1** -.. _class_ProjectSettings_layer_names/2d_physics/layer_10: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_10: - :ref:`String` **layer_names/2d_physics/layer_10** -.. _class_ProjectSettings_layer_names/2d_physics/layer_11: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_11: - :ref:`String` **layer_names/2d_physics/layer_11** -.. _class_ProjectSettings_layer_names/2d_physics/layer_12: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_12: - :ref:`String` **layer_names/2d_physics/layer_12** -.. _class_ProjectSettings_layer_names/2d_physics/layer_13: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_13: - :ref:`String` **layer_names/2d_physics/layer_13** -.. _class_ProjectSettings_layer_names/2d_physics/layer_14: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_14: - :ref:`String` **layer_names/2d_physics/layer_14** -.. _class_ProjectSettings_layer_names/2d_physics/layer_15: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_15: - :ref:`String` **layer_names/2d_physics/layer_15** -.. _class_ProjectSettings_layer_names/2d_physics/layer_16: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_16: - :ref:`String` **layer_names/2d_physics/layer_16** -.. _class_ProjectSettings_layer_names/2d_physics/layer_17: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_17: - :ref:`String` **layer_names/2d_physics/layer_17** -.. _class_ProjectSettings_layer_names/2d_physics/layer_18: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_18: - :ref:`String` **layer_names/2d_physics/layer_18** -.. _class_ProjectSettings_layer_names/2d_physics/layer_19: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_19: - :ref:`String` **layer_names/2d_physics/layer_19** -.. _class_ProjectSettings_layer_names/2d_physics/layer_2: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_2: - :ref:`String` **layer_names/2d_physics/layer_2** -.. _class_ProjectSettings_layer_names/2d_physics/layer_20: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_20: - :ref:`String` **layer_names/2d_physics/layer_20** -.. _class_ProjectSettings_layer_names/2d_physics/layer_3: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_3: - :ref:`String` **layer_names/2d_physics/layer_3** -.. _class_ProjectSettings_layer_names/2d_physics/layer_4: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_4: - :ref:`String` **layer_names/2d_physics/layer_4** -.. _class_ProjectSettings_layer_names/2d_physics/layer_5: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_5: - :ref:`String` **layer_names/2d_physics/layer_5** -.. _class_ProjectSettings_layer_names/2d_physics/layer_6: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_6: - :ref:`String` **layer_names/2d_physics/layer_6** -.. _class_ProjectSettings_layer_names/2d_physics/layer_7: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_7: - :ref:`String` **layer_names/2d_physics/layer_7** -.. _class_ProjectSettings_layer_names/2d_physics/layer_8: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_8: - :ref:`String` **layer_names/2d_physics/layer_8** -.. _class_ProjectSettings_layer_names/2d_physics/layer_9: +.. _class_ProjectSettings_property_layer_names/2d_physics/layer_9: - :ref:`String` **layer_names/2d_physics/layer_9** -.. _class_ProjectSettings_layer_names/2d_render/layer_1: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_1: - :ref:`String` **layer_names/2d_render/layer_1** -.. _class_ProjectSettings_layer_names/2d_render/layer_10: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_10: - :ref:`String` **layer_names/2d_render/layer_10** -.. _class_ProjectSettings_layer_names/2d_render/layer_11: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_11: - :ref:`String` **layer_names/2d_render/layer_11** -.. _class_ProjectSettings_layer_names/2d_render/layer_12: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_12: - :ref:`String` **layer_names/2d_render/layer_12** -.. _class_ProjectSettings_layer_names/2d_render/layer_13: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_13: - :ref:`String` **layer_names/2d_render/layer_13** -.. _class_ProjectSettings_layer_names/2d_render/layer_14: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_14: - :ref:`String` **layer_names/2d_render/layer_14** -.. _class_ProjectSettings_layer_names/2d_render/layer_15: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_15: - :ref:`String` **layer_names/2d_render/layer_15** -.. _class_ProjectSettings_layer_names/2d_render/layer_16: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_16: - :ref:`String` **layer_names/2d_render/layer_16** -.. _class_ProjectSettings_layer_names/2d_render/layer_17: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_17: - :ref:`String` **layer_names/2d_render/layer_17** -.. _class_ProjectSettings_layer_names/2d_render/layer_18: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_18: - :ref:`String` **layer_names/2d_render/layer_18** -.. _class_ProjectSettings_layer_names/2d_render/layer_19: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_19: - :ref:`String` **layer_names/2d_render/layer_19** -.. _class_ProjectSettings_layer_names/2d_render/layer_2: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_2: - :ref:`String` **layer_names/2d_render/layer_2** -.. _class_ProjectSettings_layer_names/2d_render/layer_20: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_20: - :ref:`String` **layer_names/2d_render/layer_20** -.. _class_ProjectSettings_layer_names/2d_render/layer_3: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_3: - :ref:`String` **layer_names/2d_render/layer_3** -.. _class_ProjectSettings_layer_names/2d_render/layer_4: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_4: - :ref:`String` **layer_names/2d_render/layer_4** -.. _class_ProjectSettings_layer_names/2d_render/layer_5: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_5: - :ref:`String` **layer_names/2d_render/layer_5** -.. _class_ProjectSettings_layer_names/2d_render/layer_6: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_6: - :ref:`String` **layer_names/2d_render/layer_6** -.. _class_ProjectSettings_layer_names/2d_render/layer_7: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_7: - :ref:`String` **layer_names/2d_render/layer_7** -.. _class_ProjectSettings_layer_names/2d_render/layer_8: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_8: - :ref:`String` **layer_names/2d_render/layer_8** -.. _class_ProjectSettings_layer_names/2d_render/layer_9: +.. _class_ProjectSettings_property_layer_names/2d_render/layer_9: - :ref:`String` **layer_names/2d_render/layer_9** -.. _class_ProjectSettings_layer_names/3d_physics/layer_1: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_1: - :ref:`String` **layer_names/3d_physics/layer_1** -.. _class_ProjectSettings_layer_names/3d_physics/layer_10: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_10: - :ref:`String` **layer_names/3d_physics/layer_10** -.. _class_ProjectSettings_layer_names/3d_physics/layer_11: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_11: - :ref:`String` **layer_names/3d_physics/layer_11** -.. _class_ProjectSettings_layer_names/3d_physics/layer_12: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_12: - :ref:`String` **layer_names/3d_physics/layer_12** -.. _class_ProjectSettings_layer_names/3d_physics/layer_13: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_13: - :ref:`String` **layer_names/3d_physics/layer_13** -.. _class_ProjectSettings_layer_names/3d_physics/layer_14: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_14: - :ref:`String` **layer_names/3d_physics/layer_14** -.. _class_ProjectSettings_layer_names/3d_physics/layer_15: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_15: - :ref:`String` **layer_names/3d_physics/layer_15** -.. _class_ProjectSettings_layer_names/3d_physics/layer_16: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_16: - :ref:`String` **layer_names/3d_physics/layer_16** -.. _class_ProjectSettings_layer_names/3d_physics/layer_17: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_17: - :ref:`String` **layer_names/3d_physics/layer_17** -.. _class_ProjectSettings_layer_names/3d_physics/layer_18: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_18: - :ref:`String` **layer_names/3d_physics/layer_18** -.. _class_ProjectSettings_layer_names/3d_physics/layer_19: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_19: - :ref:`String` **layer_names/3d_physics/layer_19** -.. _class_ProjectSettings_layer_names/3d_physics/layer_2: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_2: - :ref:`String` **layer_names/3d_physics/layer_2** -.. _class_ProjectSettings_layer_names/3d_physics/layer_20: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_20: - :ref:`String` **layer_names/3d_physics/layer_20** -.. _class_ProjectSettings_layer_names/3d_physics/layer_3: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_3: - :ref:`String` **layer_names/3d_physics/layer_3** -.. _class_ProjectSettings_layer_names/3d_physics/layer_4: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_4: - :ref:`String` **layer_names/3d_physics/layer_4** -.. _class_ProjectSettings_layer_names/3d_physics/layer_5: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_5: - :ref:`String` **layer_names/3d_physics/layer_5** -.. _class_ProjectSettings_layer_names/3d_physics/layer_6: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_6: - :ref:`String` **layer_names/3d_physics/layer_6** -.. _class_ProjectSettings_layer_names/3d_physics/layer_7: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_7: - :ref:`String` **layer_names/3d_physics/layer_7** -.. _class_ProjectSettings_layer_names/3d_physics/layer_8: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_8: - :ref:`String` **layer_names/3d_physics/layer_8** -.. _class_ProjectSettings_layer_names/3d_physics/layer_9: +.. _class_ProjectSettings_property_layer_names/3d_physics/layer_9: - :ref:`String` **layer_names/3d_physics/layer_9** -.. _class_ProjectSettings_layer_names/3d_render/layer_1: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_1: - :ref:`String` **layer_names/3d_render/layer_1** -.. _class_ProjectSettings_layer_names/3d_render/layer_10: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_10: - :ref:`String` **layer_names/3d_render/layer_10** -.. _class_ProjectSettings_layer_names/3d_render/layer_11: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_11: - :ref:`String` **layer_names/3d_render/layer_11** -.. _class_ProjectSettings_layer_names/3d_render/layer_12: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_12: - :ref:`String` **layer_names/3d_render/layer_12** -.. _class_ProjectSettings_layer_names/3d_render/layer_13: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_13: - :ref:`String` **layer_names/3d_render/layer_13** -.. _class_ProjectSettings_layer_names/3d_render/layer_14: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_14: - :ref:`String` **layer_names/3d_render/layer_14** -.. _class_ProjectSettings_layer_names/3d_render/layer_15: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_15: - :ref:`String` **layer_names/3d_render/layer_15** -.. _class_ProjectSettings_layer_names/3d_render/layer_16: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_16: - :ref:`String` **layer_names/3d_render/layer_16** -.. _class_ProjectSettings_layer_names/3d_render/layer_17: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_17: - :ref:`String` **layer_names/3d_render/layer_17** -.. _class_ProjectSettings_layer_names/3d_render/layer_18: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_18: - :ref:`String` **layer_names/3d_render/layer_18** -.. _class_ProjectSettings_layer_names/3d_render/layer_19: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_19: - :ref:`String` **layer_names/3d_render/layer_19** -.. _class_ProjectSettings_layer_names/3d_render/layer_2: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_2: - :ref:`String` **layer_names/3d_render/layer_2** -.. _class_ProjectSettings_layer_names/3d_render/layer_20: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_20: - :ref:`String` **layer_names/3d_render/layer_20** -.. _class_ProjectSettings_layer_names/3d_render/layer_3: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_3: - :ref:`String` **layer_names/3d_render/layer_3** -.. _class_ProjectSettings_layer_names/3d_render/layer_4: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_4: - :ref:`String` **layer_names/3d_render/layer_4** -.. _class_ProjectSettings_layer_names/3d_render/layer_5: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_5: - :ref:`String` **layer_names/3d_render/layer_5** -.. _class_ProjectSettings_layer_names/3d_render/layer_6: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_6: - :ref:`String` **layer_names/3d_render/layer_6** -.. _class_ProjectSettings_layer_names/3d_render/layer_7: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_7: - :ref:`String` **layer_names/3d_render/layer_7** -.. _class_ProjectSettings_layer_names/3d_render/layer_8: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_8: - :ref:`String` **layer_names/3d_render/layer_8** -.. _class_ProjectSettings_layer_names/3d_render/layer_9: +.. _class_ProjectSettings_property_layer_names/3d_render/layer_9: - :ref:`String` **layer_names/3d_render/layer_9** -.. _class_ProjectSettings_locale/fallback: +.. _class_ProjectSettings_property_locale/fallback: - :ref:`String` **locale/fallback** -.. _class_ProjectSettings_locale/test: +.. _class_ProjectSettings_property_locale/test: - :ref:`String` **locale/test** -.. _class_ProjectSettings_logging/file_logging/enable_file_logging: +.. _class_ProjectSettings_property_logging/file_logging/enable_file_logging: - :ref:`bool` **logging/file_logging/enable_file_logging** Log all output to a file. -.. _class_ProjectSettings_logging/file_logging/log_path: +.. _class_ProjectSettings_property_logging/file_logging/log_path: - :ref:`String` **logging/file_logging/log_path** Path to logs withint he project. Using an ``user://`` based path is recommended. -.. _class_ProjectSettings_logging/file_logging/max_log_files: +.. _class_ProjectSettings_property_logging/file_logging/max_log_files: - :ref:`int` **logging/file_logging/max_log_files** Amount of log files (used for rotation). -.. _class_ProjectSettings_memory/limits/message_queue/max_size_kb: +.. _class_ProjectSettings_property_memory/limits/message_queue/max_size_kb: - :ref:`int` **memory/limits/message_queue/max_size_kb** Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. -.. _class_ProjectSettings_memory/limits/multithreaded_server/rid_pool_prealloc: +.. _class_ProjectSettings_property_memory/limits/multithreaded_server/rid_pool_prealloc: - :ref:`int` **memory/limits/multithreaded_server/rid_pool_prealloc** This is used by servers when used in multi threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. -.. _class_ProjectSettings_network/limits/debugger_stdout/max_chars_per_second: +.. _class_ProjectSettings_property_network/limits/debugger_stdout/max_chars_per_second: - :ref:`int` **network/limits/debugger_stdout/max_chars_per_second** Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. -.. _class_ProjectSettings_network/limits/debugger_stdout/max_errors_per_frame: +.. _class_ProjectSettings_property_network/limits/debugger_stdout/max_errors_per_frame: - :ref:`int` **network/limits/debugger_stdout/max_errors_per_frame** Maximum amount of errors allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. -.. _class_ProjectSettings_network/limits/debugger_stdout/max_messages_per_frame: +.. _class_ProjectSettings_property_network/limits/debugger_stdout/max_messages_per_frame: - :ref:`int` **network/limits/debugger_stdout/max_messages_per_frame** Maximum amount of messages allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. -.. _class_ProjectSettings_network/limits/packet_peer_stream/max_buffer_po2: +.. _class_ProjectSettings_property_network/limits/packet_peer_stream/max_buffer_po2: - :ref:`int` **network/limits/packet_peer_stream/max_buffer_po2** Default size of packet peer stream for deserializing godot data. Over this size, data is dropped. -.. _class_ProjectSettings_network/limits/websocket_client/max_in_buffer_kb: +.. _class_ProjectSettings_property_network/limits/websocket_client/max_in_buffer_kb: - :ref:`int` **network/limits/websocket_client/max_in_buffer_kb** -.. _class_ProjectSettings_network/limits/websocket_client/max_in_packets: +.. _class_ProjectSettings_property_network/limits/websocket_client/max_in_packets: - :ref:`int` **network/limits/websocket_client/max_in_packets** -.. _class_ProjectSettings_network/limits/websocket_client/max_out_buffer_kb: +.. _class_ProjectSettings_property_network/limits/websocket_client/max_out_buffer_kb: - :ref:`int` **network/limits/websocket_client/max_out_buffer_kb** -.. _class_ProjectSettings_network/limits/websocket_client/max_out_packets: +.. _class_ProjectSettings_property_network/limits/websocket_client/max_out_packets: - :ref:`int` **network/limits/websocket_client/max_out_packets** -.. _class_ProjectSettings_network/limits/websocket_server/max_in_buffer_kb: +.. _class_ProjectSettings_property_network/limits/websocket_server/max_in_buffer_kb: - :ref:`int` **network/limits/websocket_server/max_in_buffer_kb** -.. _class_ProjectSettings_network/limits/websocket_server/max_in_packets: +.. _class_ProjectSettings_property_network/limits/websocket_server/max_in_packets: - :ref:`int` **network/limits/websocket_server/max_in_packets** -.. _class_ProjectSettings_network/limits/websocket_server/max_out_buffer_kb: +.. _class_ProjectSettings_property_network/limits/websocket_server/max_out_buffer_kb: - :ref:`int` **network/limits/websocket_server/max_out_buffer_kb** -.. _class_ProjectSettings_network/limits/websocket_server/max_out_packets: +.. _class_ProjectSettings_property_network/limits/websocket_server/max_out_packets: - :ref:`int` **network/limits/websocket_server/max_out_packets** -.. _class_ProjectSettings_network/remote_fs/page_read_ahead: +.. _class_ProjectSettings_property_network/remote_fs/page_read_ahead: - :ref:`int` **network/remote_fs/page_read_ahead** Amount of read ahead used by remote filesystem. Improves latency. -.. _class_ProjectSettings_network/remote_fs/page_size: +.. _class_ProjectSettings_property_network/remote_fs/page_size: - :ref:`int` **network/remote_fs/page_size** Page size used by remote filesystem. -.. _class_ProjectSettings_node/name_casing: +.. _class_ProjectSettings_property_node/name_casing: - :ref:`int` **node/name_casing** When creating nodes names automatically, set the type of casing in this project. This is mostly an editor setting. -.. _class_ProjectSettings_node/name_num_separator: +.. _class_ProjectSettings_property_node/name_num_separator: - :ref:`int` **node/name_num_separator** What to use to separate node name from number. This is mostly an editor setting. -.. _class_ProjectSettings_physics/2d/physics_engine: +.. _class_ProjectSettings_property_physics/2d/physics_engine: - :ref:`String` **physics/2d/physics_engine** -.. _class_ProjectSettings_physics/2d/thread_model: +.. _class_ProjectSettings_property_physics/2d/thread_model: - :ref:`int` **physics/2d/thread_model** Set whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API Access to only physics process. -.. _class_ProjectSettings_physics/3d/active_soft_world: +.. _class_ProjectSettings_property_physics/3d/active_soft_world: - :ref:`bool` **physics/3d/active_soft_world** -.. _class_ProjectSettings_physics/3d/physics_engine: +.. _class_ProjectSettings_property_physics/3d/physics_engine: - :ref:`String` **physics/3d/physics_engine** -.. _class_ProjectSettings_physics/common/physics_fps: +.. _class_ProjectSettings_property_physics/common/physics_fps: - :ref:`int` **physics/common/physics_fps** Frames per second used in the physics. Physics always needs a fixed amount of frames per second. -.. _class_ProjectSettings_physics/common/physics_jitter_fix: +.. _class_ProjectSettings_property_physics/common/physics_jitter_fix: - :ref:`float` **physics/common/physics_jitter_fix** Fix to improve physics jitter, specially on monitors where refresh rate is different than physics FPS. -.. _class_ProjectSettings_rendering/environment/default_clear_color: +.. _class_ProjectSettings_property_rendering/environment/default_clear_color: - :ref:`Color` **rendering/environment/default_clear_color** -Default background clear color. Overridable per :ref:`Viewport` using its :ref:`Environment`. See :ref:`Environment.background_mode` and :ref:`Environment.background_color` in particular. To change this default color programmatically, use :ref:`VisualServer.set_default_clear_color`. +Default background clear color. Overridable per :ref:`Viewport` using its :ref:`Environment`. See :ref:`Environment.background_mode` and :ref:`Environment.background_color` in particular. To change this default color programmatically, use :ref:`VisualServer.set_default_clear_color`. -.. _class_ProjectSettings_rendering/limits/buffers/blend_shape_max_buffer_size_kb: +.. _class_ProjectSettings_property_rendering/limits/buffers/blend_shape_max_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/blend_shape_max_buffer_size_kb** Max buffer size for blend shapes. Any blend shape bigger than this will not work. -.. _class_ProjectSettings_rendering/limits/buffers/canvas_polygon_buffer_size_kb: +.. _class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/canvas_polygon_buffer_size_kb** Max buffer size for drawing polygons. Any polygon bigger than this will not work. -.. _class_ProjectSettings_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb: +.. _class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/canvas_polygon_index_buffer_size_kb** Max index buffer size for drawing polygons. Any polygon bigger than this will not work. -.. _class_ProjectSettings_rendering/limits/buffers/immediate_buffer_size_kb: +.. _class_ProjectSettings_property_rendering/limits/buffers/immediate_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/immediate_buffer_size_kb** Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. -.. _class_ProjectSettings_rendering/limits/rendering/max_renderable_elements: +.. _class_ProjectSettings_property_rendering/limits/rendering/max_renderable_elements: - :ref:`int` **rendering/limits/rendering/max_renderable_elements** Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not mesh themselves. -.. _class_ProjectSettings_rendering/limits/time/time_rollover_secs: +.. _class_ProjectSettings_property_rendering/limits/time/time_rollover_secs: - :ref:`float` **rendering/limits/time/time_rollover_secs** Shaders have a time variable that constantly increases. At some point it needs to be rolled back to zero to avoid numerical errors on shader animations. This setting specifies when. -.. _class_ProjectSettings_rendering/quality/2d/use_pixel_snap: +.. _class_ProjectSettings_property_rendering/quality/2d/use_pixel_snap: - :ref:`bool` **rendering/quality/2d/use_pixel_snap** Force snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. -.. _class_ProjectSettings_rendering/quality/depth_prepass/disable_for_vendors: +.. _class_ProjectSettings_property_rendering/quality/depth_prepass/disable_for_vendors: - :ref:`String` **rendering/quality/depth_prepass/disable_for_vendors** Disable depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. -.. _class_ProjectSettings_rendering/quality/depth_prepass/enable: +.. _class_ProjectSettings_property_rendering/quality/depth_prepass/enable: - :ref:`bool` **rendering/quality/depth_prepass/enable** Do a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. -.. _class_ProjectSettings_rendering/quality/directional_shadow/size: +.. _class_ProjectSettings_property_rendering/quality/directional_shadow/size: - :ref:`int` **rendering/quality/directional_shadow/size** Size in pixels of the directional shadow. -.. _class_ProjectSettings_rendering/quality/directional_shadow/size.mobile: +.. _class_ProjectSettings_property_rendering/quality/directional_shadow/size.mobile: - :ref:`int` **rendering/quality/directional_shadow/size.mobile** -.. _class_ProjectSettings_rendering/quality/driver/driver_fallback: +.. _class_ProjectSettings_property_rendering/quality/driver/driver_fallback: - :ref:`String` **rendering/quality/driver/driver_fallback** Whether to allow falling back to other graphics drivers if the preferred driver is not available. Best means use the best working driver (this is the default). Never means never fall back to another driver even if it does not work. This means the project will not run if the preferred driver does not function. -.. _class_ProjectSettings_rendering/quality/driver/driver_name: +.. _class_ProjectSettings_property_rendering/quality/driver/driver_name: - :ref:`String` **rendering/quality/driver/driver_name** -.. _class_ProjectSettings_rendering/quality/filters/anisotropic_filter_level: +.. _class_ProjectSettings_property_rendering/quality/filters/anisotropic_filter_level: - :ref:`int` **rendering/quality/filters/anisotropic_filter_level** Maximum Anisotropic filter level used for textures when anisotropy enabled. -.. _class_ProjectSettings_rendering/quality/filters/use_nearest_mipmap_filter: +.. _class_ProjectSettings_property_rendering/quality/filters/use_nearest_mipmap_filter: - :ref:`bool` **rendering/quality/filters/use_nearest_mipmap_filter** Force to use nearest mipmap filtering when using mipmaps. This may increase performance in mobile as less memory bandwidth is used. -.. _class_ProjectSettings_rendering/quality/intended_usage/framebuffer_allocation: +.. _class_ProjectSettings_property_rendering/quality/intended_usage/framebuffer_allocation: - :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation** Strategy used for framebuffer allocation. The simpler it is, the less memory it uses (but the least features it supports). -.. _class_ProjectSettings_rendering/quality/intended_usage/framebuffer_allocation.mobile: +.. _class_ProjectSettings_property_rendering/quality/intended_usage/framebuffer_allocation.mobile: - :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation.mobile** -.. _class_ProjectSettings_rendering/quality/reflections/high_quality_ggx: +.. _class_ProjectSettings_property_rendering/quality/reflections/high_quality_ggx: - :ref:`bool` **rendering/quality/reflections/high_quality_ggx** For reflection probes and panorama backgrounds (sky), use a high amount of samples to create ggx blurred versions (used for roughness). -.. _class_ProjectSettings_rendering/quality/reflections/high_quality_ggx.mobile: +.. _class_ProjectSettings_property_rendering/quality/reflections/high_quality_ggx.mobile: - :ref:`bool` **rendering/quality/reflections/high_quality_ggx.mobile** -.. _class_ProjectSettings_rendering/quality/reflections/texture_array_reflections: +.. _class_ProjectSettings_property_rendering/quality/reflections/texture_array_reflections: - :ref:`bool` **rendering/quality/reflections/texture_array_reflections** For reflection probes and panorama backgrounds (sky), use a texture array instead of mipmaps. This reduces jitter noise on reflections, but costs more performance and memory. -.. _class_ProjectSettings_rendering/quality/reflections/texture_array_reflections.mobile: +.. _class_ProjectSettings_property_rendering/quality/reflections/texture_array_reflections.mobile: - :ref:`bool` **rendering/quality/reflections/texture_array_reflections.mobile** -.. _class_ProjectSettings_rendering/quality/shading/force_blinn_over_ggx: +.. _class_ProjectSettings_property_rendering/quality/shading/force_blinn_over_ggx: - :ref:`bool` **rendering/quality/shading/force_blinn_over_ggx** -.. _class_ProjectSettings_rendering/quality/shading/force_blinn_over_ggx.mobile: +.. _class_ProjectSettings_property_rendering/quality/shading/force_blinn_over_ggx.mobile: - :ref:`bool` **rendering/quality/shading/force_blinn_over_ggx.mobile** -.. _class_ProjectSettings_rendering/quality/shading/force_lambert_over_burley: +.. _class_ProjectSettings_property_rendering/quality/shading/force_lambert_over_burley: - :ref:`bool` **rendering/quality/shading/force_lambert_over_burley** -.. _class_ProjectSettings_rendering/quality/shading/force_lambert_over_burley.mobile: +.. _class_ProjectSettings_property_rendering/quality/shading/force_lambert_over_burley.mobile: - :ref:`bool` **rendering/quality/shading/force_lambert_over_burley.mobile** -.. _class_ProjectSettings_rendering/quality/shading/force_vertex_shading: +.. _class_ProjectSettings_property_rendering/quality/shading/force_vertex_shading: - :ref:`bool` **rendering/quality/shading/force_vertex_shading** Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can work to optimize on very low end mobile. -.. _class_ProjectSettings_rendering/quality/shading/force_vertex_shading.mobile: +.. _class_ProjectSettings_property_rendering/quality/shading/force_vertex_shading.mobile: - :ref:`bool` **rendering/quality/shading/force_vertex_shading.mobile** -.. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_0_subdiv: +.. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_0_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_0_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. -.. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_1_subdiv: +.. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_1_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_1_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. -.. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_2_subdiv: +.. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_2_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_2_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. -.. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_3_subdiv: +.. _class_ProjectSettings_property_rendering/quality/shadow_atlas/quadrant_3_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_3_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. -.. _class_ProjectSettings_rendering/quality/shadow_atlas/size: +.. _class_ProjectSettings_property_rendering/quality/shadow_atlas/size: - :ref:`int` **rendering/quality/shadow_atlas/size** Size for shadow atlas (used for point and omni lights). See documentation. -.. _class_ProjectSettings_rendering/quality/shadow_atlas/size.mobile: +.. _class_ProjectSettings_property_rendering/quality/shadow_atlas/size.mobile: - :ref:`int` **rendering/quality/shadow_atlas/size.mobile** -.. _class_ProjectSettings_rendering/quality/shadows/filter_mode: +.. _class_ProjectSettings_property_rendering/quality/shadows/filter_mode: - :ref:`int` **rendering/quality/shadows/filter_mode** Shadow filter mode. The more complex the filter, the more memory bandwidth required. -.. _class_ProjectSettings_rendering/quality/shadows/filter_mode.mobile: +.. _class_ProjectSettings_property_rendering/quality/shadows/filter_mode.mobile: - :ref:`int` **rendering/quality/shadows/filter_mode.mobile** -.. _class_ProjectSettings_rendering/quality/subsurface_scattering/follow_surface: +.. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/follow_surface: - :ref:`bool` **rendering/quality/subsurface_scattering/follow_surface** Improves quality of subsurface scattering, but cost significantly increases. -.. _class_ProjectSettings_rendering/quality/subsurface_scattering/quality: +.. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/quality: - :ref:`int` **rendering/quality/subsurface_scattering/quality** Quality setting for subsurface scaterring (samples taken). -.. _class_ProjectSettings_rendering/quality/subsurface_scattering/scale: +.. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/scale: - :ref:`int` **rendering/quality/subsurface_scattering/scale** -.. _class_ProjectSettings_rendering/quality/subsurface_scattering/weight_samples: +.. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/weight_samples: - :ref:`bool` **rendering/quality/subsurface_scattering/weight_samples** Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. -.. _class_ProjectSettings_rendering/quality/voxel_cone_tracing/high_quality: +.. _class_ProjectSettings_property_rendering/quality/voxel_cone_tracing/high_quality: - :ref:`bool` **rendering/quality/voxel_cone_tracing/high_quality** Use high quality voxel cone tracing (looks better, but requires a higher end GPU). -.. _class_ProjectSettings_rendering/threads/thread_model: +.. _class_ProjectSettings_property_rendering/threads/thread_model: - :ref:`int` **rendering/threads/thread_model** Thread model for rendering. Rendering on a thread can vastly improve performance, but syncinc to the main thread can cause a bit more jitter. -.. _class_ProjectSettings_rendering/vram_compression/import_bptc: +.. _class_ProjectSettings_property_rendering/vram_compression/import_bptc: - :ref:`bool` **rendering/vram_compression/import_bptc** -.. _class_ProjectSettings_rendering/vram_compression/import_etc: +.. _class_ProjectSettings_property_rendering/vram_compression/import_etc: - :ref:`bool` **rendering/vram_compression/import_etc** If the project uses this compression (usually low end mobile), texture importer will import these. -.. _class_ProjectSettings_rendering/vram_compression/import_etc2: +.. _class_ProjectSettings_property_rendering/vram_compression/import_etc2: - :ref:`bool` **rendering/vram_compression/import_etc2** If the project uses this compression (usually high end mobile), texture importer will import these. -.. _class_ProjectSettings_rendering/vram_compression/import_pvrtc: +.. _class_ProjectSettings_property_rendering/vram_compression/import_pvrtc: - :ref:`bool` **rendering/vram_compression/import_pvrtc** If the project uses this compression (usually iOS), texture importer will import these. -.. _class_ProjectSettings_rendering/vram_compression/import_s3tc: +.. _class_ProjectSettings_property_rendering/vram_compression/import_s3tc: - :ref:`bool` **rendering/vram_compression/import_s3tc** If the project uses this compression (usually Desktop and Consoles), texture importer will import these. -.. _class_ProjectSettings_script: +.. _class_ProjectSettings_property_script: - :ref:`Script` **script** Method Descriptions ------------------- -.. _class_ProjectSettings_add_property_info: +.. _class_ProjectSettings_method_add_property_info: - void **add_property_info** **(** :ref:`Dictionary` hint **)** @@ -1834,35 +1834,35 @@ Example: ProjectSettings.add_property_info(property_info) -.. _class_ProjectSettings_clear: +.. _class_ProjectSettings_method_clear: - void **clear** **(** :ref:`String` name **)** Clear the whole configuration (not recommended, may break things). -.. _class_ProjectSettings_get_order: +.. _class_ProjectSettings_method_get_order: - :ref:`int` **get_order** **(** :ref:`String` name **)** const Return the order of a configuration value (influences when saved to the config file). -.. _class_ProjectSettings_get_setting: +.. _class_ProjectSettings_method_get_setting: - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const -.. _class_ProjectSettings_globalize_path: +.. _class_ProjectSettings_method_globalize_path: - :ref:`String` **globalize_path** **(** :ref:`String` path **)** const Convert a localized path (res://) to a full native OS path. -.. _class_ProjectSettings_has_setting: +.. _class_ProjectSettings_method_has_setting: - :ref:`bool` **has_setting** **(** :ref:`String` name **)** const Return true if a configuration value is present. -.. _class_ProjectSettings_load_resource_pack: +.. _class_ProjectSettings_method_load_resource_pack: - :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** @@ -1870,47 +1870,47 @@ Loads the contents of the .pck or .zip file specified by ``pack`` into the resou Note: If a file from ``pack`` shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from ``pack``. -.. _class_ProjectSettings_localize_path: +.. _class_ProjectSettings_method_localize_path: - :ref:`String` **localize_path** **(** :ref:`String` path **)** const Convert a path to a localized path (res:// path). -.. _class_ProjectSettings_property_can_revert: +.. _class_ProjectSettings_method_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** Returns true if the specified property exists and its initial value differs from the current value. -.. _class_ProjectSettings_property_get_revert: +.. _class_ProjectSettings_method_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** Returns the initial value of the specified property. Returns null if the property does not exist. -.. _class_ProjectSettings_save: +.. _class_ProjectSettings_method_save: - :ref:`Error` **save** **(** **)** Saves the configuration to the project.godot file. -.. _class_ProjectSettings_save_custom: +.. _class_ProjectSettings_method_save_custom: - :ref:`Error` **save_custom** **(** :ref:`String` file **)** Saves the configuration to a custom file. -.. _class_ProjectSettings_set_initial_value: +.. _class_ProjectSettings_method_set_initial_value: - void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** -.. _class_ProjectSettings_set_order: +.. _class_ProjectSettings_method_set_order: - void **set_order** **(** :ref:`String` name, :ref:`int` position **)** Set the order of a configuration value (influences when saved to the config file). -.. _class_ProjectSettings_set_setting: +.. _class_ProjectSettings_method_set_setting: - void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index ed4758b23..3692e8dcd 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -19,25 +19,25 @@ General purpose proximity-detection node. Properties ---------- -+-------------------------------------------------------+----------------------------------------------------------+ -| :ref:`DispatchMode` | :ref:`dispatch_mode` | -+-------------------------------------------------------+----------------------------------------------------------+ -| :ref:`Vector3` | :ref:`grid_radius` | -+-------------------------------------------------------+----------------------------------------------------------+ -| :ref:`String` | :ref:`group_name` | -+-------------------------------------------------------+----------------------------------------------------------+ ++-------------------------------------------------------+-------------------------------------------------------------------+ +| :ref:`DispatchMode` | :ref:`dispatch_mode` | ++-------------------------------------------------------+-------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`grid_radius` | ++-------------------------------------------------------+-------------------------------------------------------------------+ +| :ref:`String` | :ref:`group_name` | ++-------------------------------------------------------+-------------------------------------------------------------------+ Methods ------- -+-------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`broadcast` **(** :ref:`String` name, :ref:`Variant` parameters **)** | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`broadcast` **(** :ref:`String` name, :ref:`Variant` parameters **)** | ++------+------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_ProximityGroup_broadcast: +.. _class_ProximityGroup_signal_broadcast: - **broadcast** **(** :ref:`String` group_name, :ref:`Array` parameters **)** @@ -46,6 +46,10 @@ Enumerations .. _enum_ProximityGroup_DispatchMode: +.. _class_ProximityGroup_constant_MODE_PROXY: + +.. _class_ProximityGroup_constant_MODE_SIGNAL: + enum **DispatchMode**: - **MODE_PROXY** = **0** @@ -60,7 +64,7 @@ General purpose proximity-detection node. Property Descriptions --------------------- -.. _class_ProximityGroup_dispatch_mode: +.. _class_ProximityGroup_property_dispatch_mode: - :ref:`DispatchMode` **dispatch_mode** @@ -70,7 +74,7 @@ Property Descriptions | *Getter* | get_dispatch_mode() | +----------+--------------------------+ -.. _class_ProximityGroup_grid_radius: +.. _class_ProximityGroup_property_grid_radius: - :ref:`Vector3` **grid_radius** @@ -80,7 +84,7 @@ Property Descriptions | *Getter* | get_grid_radius() | +----------+------------------------+ -.. _class_ProximityGroup_group_name: +.. _class_ProximityGroup_property_group_name: - :ref:`String` **group_name** @@ -93,7 +97,7 @@ Property Descriptions Method Descriptions ------------------- -.. _class_ProximityGroup_broadcast: +.. _class_ProximityGroup_method_broadcast: - void **broadcast** **(** :ref:`String` name, :ref:`Variant` parameters **)** diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index 37fa6be57..3b12fd7f4 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-------------------------------+--------------------------------------+ -| :ref:`Texture` | :ref:`base` | -+-------------------------------+--------------------------------------+ ++-------------------------------+-----------------------------------------------+ +| :ref:`Texture` | :ref:`base` | ++-------------------------------+-----------------------------------------------+ Property Descriptions --------------------- -.. _class_ProxyTexture_base: +.. _class_ProxyTexture_property_base: - :ref:`Texture` **base** diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index 55d6027cb..eaab80acc 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -19,9 +19,9 @@ Class representing a square mesh. Properties ---------- -+-------------------------------+----------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+-------------------------------+----------------------------------+ ++-------------------------------+-------------------------------------------+ +| :ref:`Vector2` | :ref:`size` | ++-------------------------------+-------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Class representing a square mesh with size (2,2,0). Consider using a :ref:`Plane Property Descriptions --------------------- -.. _class_QuadMesh_size: +.. _class_QuadMesh_property_size: - :ref:`Vector2` **size** diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 1ebeab3ca..631180eba 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -17,58 +17,60 @@ Quaternion. Properties ---------- -+---------------------------+------------------------+ -| :ref:`float` | :ref:`w` | -+---------------------------+------------------------+ -| :ref:`float` | :ref:`x` | -+---------------------------+------------------------+ -| :ref:`float` | :ref:`y` | -+---------------------------+------------------------+ -| :ref:`float` | :ref:`z` | -+---------------------------+------------------------+ ++---------------------------+---------------------------------+ +| :ref:`float` | :ref:`w` | ++---------------------------+---------------------------------+ +| :ref:`float` | :ref:`x` | ++---------------------------+---------------------------------+ +| :ref:`float` | :ref:`y` | ++---------------------------+---------------------------------+ +| :ref:`float` | :ref:`z` | ++---------------------------+---------------------------------+ Methods ------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`Basis` from **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` euler **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`cubic_slerp` **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dot` **(** :ref:`Quat` b **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_euler` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`inverse` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_normalized` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length_squared` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`normalized` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_angle` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_euler` **(** :ref:`Vector3` euler **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`slerp` **(** :ref:`Quat` b, :ref:`float` t **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`slerpni` **(** :ref:`Quat` b, :ref:`float` t **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`Quat` **(** :ref:`Basis` from **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` euler **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`Quat` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`cubic_slerp` **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dot` **(** :ref:`Quat` b **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_euler` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`inverse` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_normalized` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length_squared` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`normalized` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_angle` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_euler` **(** :ref:`Vector3` euler **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`slerp` **(** :ref:`Quat` b, :ref:`float` t **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`slerpni` **(** :ref:`Quat` b, :ref:`float` t **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_Quat_constant_IDENTITY: + - **IDENTITY** = **Quat( 0, 0, 0, 1 )** Description @@ -90,25 +92,25 @@ Tutorials Property Descriptions --------------------- -.. _class_Quat_w: +.. _class_Quat_property_w: - :ref:`float` **w** W component of the quaternion. Default value: ``1`` -.. _class_Quat_x: +.. _class_Quat_property_x: - :ref:`float` **x** X component of the quaternion. Default value: ``0`` -.. _class_Quat_y: +.. _class_Quat_property_y: - :ref:`float` **y** Y component of the quaternion. Default value: ``0`` -.. _class_Quat_z: +.. _class_Quat_property_z: - :ref:`float` **z** @@ -117,103 +119,97 @@ Z component of the quaternion. Default value: ``0`` Method Descriptions ------------------- -.. _class_Quat_Quat: +.. _class_Quat_method_Quat: - :ref:`Quat` **Quat** **(** :ref:`Basis` from **)** Returns the rotation matrix corresponding to the given quaternion. -.. _class_Quat_Quat: - - :ref:`Quat` **Quat** **(** :ref:`Vector3` euler **)** Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). -.. _class_Quat_Quat: - - :ref:`Quat` **Quat** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. -.. _class_Quat_Quat: - - :ref:`Quat` **Quat** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** Returns a quaternion defined by these values. -.. _class_Quat_cubic_slerp: +.. _class_Quat_method_cubic_slerp: - :ref:`Quat` **cubic_slerp** **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** Performs a cubic spherical-linear interpolation with another quaternion. -.. _class_Quat_dot: +.. _class_Quat_method_dot: - :ref:`float` **dot** **(** :ref:`Quat` b **)** Returns the dot product of two quaternions. -.. _class_Quat_get_euler: +.. _class_Quat_method_get_euler: - :ref:`Vector3` **get_euler** **(** **)** Return Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). -.. _class_Quat_inverse: +.. _class_Quat_method_inverse: - :ref:`Quat` **inverse** **(** **)** Returns the inverse of the quaternion. -.. _class_Quat_is_normalized: +.. _class_Quat_method_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns whether the quaternion is normalized or not. -.. _class_Quat_length: +.. _class_Quat_method_length: - :ref:`float` **length** **(** **)** Returns the length of the quaternion. -.. _class_Quat_length_squared: +.. _class_Quat_method_length_squared: - :ref:`float` **length_squared** **(** **)** Returns the length of the quaternion, squared. -.. _class_Quat_normalized: +.. _class_Quat_method_normalized: - :ref:`Quat` **normalized** **(** **)** Returns a copy of the quaternion, normalized to unit length. -.. _class_Quat_set_axis_angle: +.. _class_Quat_method_set_axis_angle: - void **set_axis_angle** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. -.. _class_Quat_set_euler: +.. _class_Quat_method_set_euler: - void **set_euler** **(** :ref:`Vector3` euler **)** Set the quaternion to a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). -.. _class_Quat_slerp: +.. _class_Quat_method_slerp: - :ref:`Quat` **slerp** **(** :ref:`Quat` b, :ref:`float` t **)** Performs a spherical-linear interpolation with another quaternion. -.. _class_Quat_slerpni: +.. _class_Quat_method_slerpni: - :ref:`Quat` **slerpni** **(** :ref:`Quat` b, :ref:`float` t **)** Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90°. -.. _class_Quat_xform: +.. _class_Quat_method_xform: - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index f4f00e6a4..4bbd65b72 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -19,29 +19,29 @@ A class for generation pseudo-random numbers. Properties ---------- -+-----------------------+-----------------------------------------------+ -| :ref:`int` | :ref:`seed` | -+-----------------------+-----------------------------------------------+ ++-----------------------+--------------------------------------------------------+ +| :ref:`int` | :ref:`seed` | ++-----------------------+--------------------------------------------------------+ Methods ------- -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randf` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randf_range` **(** :ref:`float` from, :ref:`float` to **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`randi` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`randi_range` **(** :ref:`int` from, :ref:`int` to **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`randomize` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randf` **(** **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randf_range` **(** :ref:`float` from, :ref:`float` to **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`randi` **(** **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`randi_range` **(** :ref:`int` from, :ref:`int` to **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`randomize` **(** **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_RandomNumberGenerator_seed: +.. _class_RandomNumberGenerator_property_seed: - :ref:`int` **seed** @@ -54,31 +54,31 @@ Property Descriptions Method Descriptions ------------------- -.. _class_RandomNumberGenerator_randf: +.. _class_RandomNumberGenerator_method_randf: - :ref:`float` **randf** **(** **)** Generates pseudo-random float between '0.0' and '1.0'. -.. _class_RandomNumberGenerator_randf_range: +.. _class_RandomNumberGenerator_method_randf_range: - :ref:`float` **randf_range** **(** :ref:`float` from, :ref:`float` to **)** Generates pseudo-random float between ``from`` and ``to``. -.. _class_RandomNumberGenerator_randi: +.. _class_RandomNumberGenerator_method_randi: - :ref:`int` **randi** **(** **)** Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295'. -.. _class_RandomNumberGenerator_randi_range: +.. _class_RandomNumberGenerator_method_randi_range: - :ref:`int` **randi_range** **(** :ref:`int` from, :ref:`int` to **)** Generates pseudo-random 32-bit signed integer between ``from`` and ``to``\ (inclusive). -.. _class_RandomNumberGenerator_randomize: +.. _class_RandomNumberGenerator_method_randomize: - void **randomize** **(** **)** diff --git a/classes/class_range.rst b/classes/class_range.rst index 07ce5aefb..1c471372d 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -21,51 +21,51 @@ Abstract base class for range-based controls. Properties ---------- -+---------------------------+-------------------------------------------------+ -| :ref:`bool` | :ref:`allow_greater` | -+---------------------------+-------------------------------------------------+ -| :ref:`bool` | :ref:`allow_lesser` | -+---------------------------+-------------------------------------------------+ -| :ref:`bool` | :ref:`exp_edit` | -+---------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`max_value` | -+---------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`min_value` | -+---------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`page` | -+---------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`ratio` | -+---------------------------+-------------------------------------------------+ -| :ref:`bool` | :ref:`rounded` | -+---------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`step` | -+---------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`value` | -+---------------------------+-------------------------------------------------+ ++---------------------------+----------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_greater` | ++---------------------------+----------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_lesser` | ++---------------------------+----------------------------------------------------------+ +| :ref:`bool` | :ref:`exp_edit` | ++---------------------------+----------------------------------------------------------+ +| :ref:`float` | :ref:`max_value` | ++---------------------------+----------------------------------------------------------+ +| :ref:`float` | :ref:`min_value` | ++---------------------------+----------------------------------------------------------+ +| :ref:`float` | :ref:`page` | ++---------------------------+----------------------------------------------------------+ +| :ref:`float` | :ref:`ratio` | ++---------------------------+----------------------------------------------------------+ +| :ref:`bool` | :ref:`rounded` | ++---------------------------+----------------------------------------------------------+ +| :ref:`float` | :ref:`step` | ++---------------------------+----------------------------------------------------------+ +| :ref:`float` | :ref:`value` | ++---------------------------+----------------------------------------------------------+ Methods ------- -+-------+--------------------------------------------------------------------------+ -| void | :ref:`share` **(** :ref:`Node` with **)** | -+-------+--------------------------------------------------------------------------+ -| void | :ref:`unshare` **(** **)** | -+-------+--------------------------------------------------------------------------+ ++------+---------------------------------------------------------------------------------+ +| void | :ref:`share` **(** :ref:`Node` with **)** | ++------+---------------------------------------------------------------------------------+ +| void | :ref:`unshare` **(** **)** | ++------+---------------------------------------------------------------------------------+ Signals ------- -.. _class_Range_changed: +.. _class_Range_signal_changed: - **changed** **(** **)** -Emitted when :ref:`min_value`, :ref:`max_value`, :ref:`page`, or :ref:`step` change. +Emitted when :ref:`min_value`, :ref:`max_value`, :ref:`page`, or :ref:`step` change. -.. _class_Range_value_changed: +.. _class_Range_signal_value_changed: - **value_changed** **(** :ref:`float` value **)** -Emitted when :ref:`value` changes. +Emitted when :ref:`value` changes. Description ----------- @@ -75,7 +75,7 @@ Range is a base class for :ref:`Control` nodes that change a floa Property Descriptions --------------------- -.. _class_Range_allow_greater: +.. _class_Range_property_allow_greater: - :ref:`bool` **allow_greater** @@ -85,9 +85,9 @@ Property Descriptions | *Getter* | is_greater_allowed() | +----------+--------------------------+ -If ``true``, :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. +If ``true``, :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. -.. _class_Range_allow_lesser: +.. _class_Range_property_allow_lesser: - :ref:`bool` **allow_lesser** @@ -97,9 +97,9 @@ If ``true``, :ref:`value` may be greater than :ref:`max_value | *Getter* | is_lesser_allowed() | +----------+-------------------------+ -If ``true``, :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. +If ``true``, :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. -.. _class_Range_exp_edit: +.. _class_Range_property_exp_edit: - :ref:`bool` **exp_edit** @@ -111,7 +111,7 @@ If ``true``, :ref:`value` may be less than :ref:`min_value` **max_value** @@ -123,7 +123,7 @@ If ``true``, and ``min_value`` is greater than 0, ``value`` will be represented Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Default value: ``100``. -.. _class_Range_min_value: +.. _class_Range_property_min_value: - :ref:`float` **min_value** @@ -135,7 +135,7 @@ Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Defa Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default value: ``0``. -.. _class_Range_page: +.. _class_Range_property_page: - :ref:`float` **page** @@ -147,7 +147,7 @@ Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length is its size multiplied by ``page`` over the difference between ``min_value`` and ``max_value``. -.. _class_Range_ratio: +.. _class_Range_property_ratio: - :ref:`float` **ratio** @@ -159,7 +159,7 @@ Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length The value mapped between 0 and 1. -.. _class_Range_rounded: +.. _class_Range_property_rounded: - :ref:`bool` **rounded** @@ -171,7 +171,7 @@ The value mapped between 0 and 1. If ``true``, ``value`` will always be rounded to the nearest integer. Default value: ``false``. -.. _class_Range_step: +.. _class_Range_property_step: - :ref:`float` **step** @@ -183,7 +183,7 @@ If ``true``, ``value`` will always be rounded to the nearest integer. Default va If greater than 0, ``value`` will always be rounded to a multiple of ``step``. If ``rounded`` is also ``true``, ``value`` will first be rounded to a multiple of ``step`` then rounded to the nearest integer. -.. _class_Range_value: +.. _class_Range_property_value: - :ref:`float` **value** @@ -198,13 +198,13 @@ Range's current value. Method Descriptions ------------------- -.. _class_Range_share: +.. _class_Range_method_share: - void **share** **(** :ref:`Node` with **)** Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. -.. _class_Range_unshare: +.. _class_Range_method_unshare: - void **unshare** **(** **)** diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index e4a36de8d..106a79894 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -19,50 +19,50 @@ Query the closest object intersecting a ray. Properties ---------- -+-------------------------------+---------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cast_to` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_areas` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_bodies` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+-------------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`exclude_parent` | -+-------------------------------+---------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`cast_to` | ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`enabled` | ++-------------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`exclude_parent` | ++-------------------------------+------------------------------------------------------------------------+ Methods ------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception` **(** :ref:`Object` node **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_exceptions` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_raycast_update` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_point` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception` **(** :ref:`Object` node **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_exceptions` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_raycast_update` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_point` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_colliding` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -71,16 +71,16 @@ A RayCast represents a line from its origin to its destination position, ``cast_ RayCast can ignore some objects by adding them to the exception list via ``add_exception``, by setting proper filtering with collision layers, or by filtering object types with type masks. -RayCast can be configured to report collisions with :ref:`Area`\ s (:ref:`collide_with_areas`) and/or :ref:`PhysicsBody`\ s (:ref:`collide_with_bodies`). +RayCast can be configured to report collisions with :ref:`Area`\ s (:ref:`collide_with_areas`) and/or :ref:`PhysicsBody`\ s (:ref:`collide_with_bodies`). Only enabled raycasts will be able to query the space and report collisions. -RayCast calculates intersection every physics frame (see :ref:`Node`), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use :ref:`force_raycast_update` after adjusting the raycast. +RayCast calculates intersection every physics frame (see :ref:`Node`), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use :ref:`force_raycast_update` after adjusting the raycast. Property Descriptions --------------------- -.. _class_RayCast_cast_to: +.. _class_RayCast_property_cast_to: - :ref:`Vector3` **cast_to** @@ -92,7 +92,7 @@ Property Descriptions The ray's destination point, relative to the RayCast's ``position``. -.. _class_RayCast_collide_with_areas: +.. _class_RayCast_property_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -104,7 +104,7 @@ The ray's destination point, relative to the RayCast's ``position``. If ``true``, collision with :ref:`Area`\ s will be reported. Default value: ``false``. -.. _class_RayCast_collide_with_bodies: +.. _class_RayCast_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -116,7 +116,7 @@ If ``true``, collision with :ref:`Area`\ s will be reported. Default If ``true``, collision with :ref:`PhysicsBody`\ s will be reported. Default value: ``true``. -.. _class_RayCast_collision_mask: +.. _class_RayCast_property_collision_mask: - :ref:`int` **collision_mask** @@ -128,7 +128,7 @@ If ``true``, collision with :ref:`PhysicsBody`\ s will be rep The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. -.. _class_RayCast_enabled: +.. _class_RayCast_property_enabled: - :ref:`bool` **enabled** @@ -140,7 +140,7 @@ The ray's collision mask. Only objects in at least one collision layer enabled i If ``true``, collisions will be reported. Default value: ``false``. -.. _class_RayCast_exclude_parent: +.. _class_RayCast_property_exclude_parent: - :ref:`bool` **exclude_parent** @@ -155,25 +155,25 @@ If ``true``, collisions will be ignored for this RayCast's immediate parent. Def Method Descriptions ------------------- -.. _class_RayCast_add_exception: +.. _class_RayCast_method_add_exception: - void **add_exception** **(** :ref:`Object` node **)** Adds a collision exception so the ray does not report collisions with the specified node. -.. _class_RayCast_add_exception_rid: +.. _class_RayCast_method_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. -.. _class_RayCast_clear_exceptions: +.. _class_RayCast_method_clear_exceptions: - void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. -.. _class_RayCast_force_raycast_update: +.. _class_RayCast_method_force_raycast_update: - void **force_raycast_update** **(** **)** @@ -181,55 +181,55 @@ Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the ray or its parent has changed state. Note: ``enabled == true`` is not required for this to work. -.. _class_RayCast_get_collider: +.. _class_RayCast_method_get_collider: - :ref:`Object` **get_collider** **(** **)** const -Return the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). +Return the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). -.. _class_RayCast_get_collider_shape: +.. _class_RayCast_method_get_collider_shape: - :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``). +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``). -.. _class_RayCast_get_collision_mask_bit: +.. _class_RayCast_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns ``true`` if the bit index passed is turned on. Note that bit indexes range from 0-19. -.. _class_RayCast_get_collision_normal: +.. _class_RayCast_method_get_collision_normal: - :ref:`Vector3` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. -.. _class_RayCast_get_collision_point: +.. _class_RayCast_method_get_collision_point: - :ref:`Vector3` **get_collision_point** **(** **)** const Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. -.. _class_RayCast_is_colliding: +.. _class_RayCast_method_is_colliding: - :ref:`bool` **is_colliding** **(** **)** const Return whether any object is intersecting with the ray's vector (considering the vector length). -.. _class_RayCast_remove_exception: +.. _class_RayCast_method_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** Removes a collision exception so the ray does report collisions with the specified node. -.. _class_RayCast_remove_exception_rid: +.. _class_RayCast_method_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. -.. _class_RayCast_set_collision_mask_bit: +.. _class_RayCast_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 7374db2e3..1be3acd82 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -19,50 +19,50 @@ Query the closest object intersecting a ray. Properties ---------- -+-------------------------------+-----------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`cast_to` | -+-------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_areas` | -+-------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_bodies` | -+-------------------------------+-----------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+-------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`enabled` | -+-------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`exclude_parent` | -+-------------------------------+-----------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`cast_to` | ++-------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_areas` | ++-------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_bodies` | ++-------------------------------+--------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`enabled` | ++-------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`exclude_parent` | ++-------------------------------+--------------------------------------------------------------------------+ Methods ------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception` **(** :ref:`Object` node **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_exceptions` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_raycast_update` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception` **(** :ref:`Object` node **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_exceptions` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_raycast_update` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_colliding` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -71,16 +71,16 @@ A RayCast represents a line from its origin to its destination position, ``cast_ RayCast2D can ignore some objects by adding them to the exception list via ``add_exception``, by setting proper filtering with collision layers, or by filtering object types with type masks. -RayCast2D can be configured to report collisions with :ref:`Area2D`\ s (:ref:`collide_with_areas`) and/or :ref:`PhysicsBody2D`\ s (:ref:`collide_with_bodies`). +RayCast2D can be configured to report collisions with :ref:`Area2D`\ s (:ref:`collide_with_areas`) and/or :ref:`PhysicsBody2D`\ s (:ref:`collide_with_bodies`). Only enabled raycasts will be able to query the space and report collisions. -RayCast2D calculates intersection every physics frame (see :ref:`Node`), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use :ref:`force_raycast_update` after adjusting the raycast. +RayCast2D calculates intersection every physics frame (see :ref:`Node`), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use :ref:`force_raycast_update` after adjusting the raycast. Property Descriptions --------------------- -.. _class_RayCast2D_cast_to: +.. _class_RayCast2D_property_cast_to: - :ref:`Vector2` **cast_to** @@ -92,7 +92,7 @@ Property Descriptions The ray's destination point, relative to the RayCast's ``position``. -.. _class_RayCast2D_collide_with_areas: +.. _class_RayCast2D_property_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -104,7 +104,7 @@ The ray's destination point, relative to the RayCast's ``position``. If ``true``, collision with :ref:`Area2D`\ s will be reported. Default value: ``false``. -.. _class_RayCast2D_collide_with_bodies: +.. _class_RayCast2D_property_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -116,7 +116,7 @@ If ``true``, collision with :ref:`Area2D`\ s will be reported. Def If ``true``, collision with :ref:`PhysicsBody2D`\ s will be reported. Default value: ``true``. -.. _class_RayCast2D_collision_mask: +.. _class_RayCast2D_property_collision_mask: - :ref:`int` **collision_mask** @@ -128,7 +128,7 @@ If ``true``, collision with :ref:`PhysicsBody2D`\ s will be The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. -.. _class_RayCast2D_enabled: +.. _class_RayCast2D_property_enabled: - :ref:`bool` **enabled** @@ -140,7 +140,7 @@ The ray's collision mask. Only objects in at least one collision layer enabled i If ``true``, collisions will be reported. Default value: ``false``. -.. _class_RayCast2D_exclude_parent: +.. _class_RayCast2D_property_exclude_parent: - :ref:`bool` **exclude_parent** @@ -155,79 +155,79 @@ If ``true``, the parent node will be excluded from collision detection. Default Method Descriptions ------------------- -.. _class_RayCast2D_add_exception: +.. _class_RayCast2D_method_add_exception: - void **add_exception** **(** :ref:`Object` node **)** Adds a collision exception so the ray does not report collisions with the specified node. -.. _class_RayCast2D_add_exception_rid: +.. _class_RayCast2D_method_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. -.. _class_RayCast2D_clear_exceptions: +.. _class_RayCast2D_method_clear_exceptions: - void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. -.. _class_RayCast2D_force_raycast_update: +.. _class_RayCast2D_method_force_raycast_update: - void **force_raycast_update** **(** **)** Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the ray or its parent has changed state. Note: ``enabled == true`` is not required for this to work. -.. _class_RayCast2D_get_collider: +.. _class_RayCast2D_method_get_collider: - :ref:`Object` **get_collider** **(** **)** const -Return the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). +Return the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). -.. _class_RayCast2D_get_collider_shape: +.. _class_RayCast2D_method_get_collider_shape: - :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``). +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``). -.. _class_RayCast2D_get_collision_mask_bit: +.. _class_RayCast2D_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. -.. _class_RayCast2D_get_collision_normal: +.. _class_RayCast2D_method_get_collision_normal: - :ref:`Vector2` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. -.. _class_RayCast2D_get_collision_point: +.. _class_RayCast2D_method_get_collision_point: - :ref:`Vector2` **get_collision_point** **(** **)** const Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. -.. _class_RayCast2D_is_colliding: +.. _class_RayCast2D_method_is_colliding: - :ref:`bool` **is_colliding** **(** **)** const Return whether any object is intersecting with the ray's vector (considering the vector length). -.. _class_RayCast2D_remove_exception: +.. _class_RayCast2D_method_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** Removes a collision exception so the ray does report collisions with the specified node. -.. _class_RayCast2D_remove_exception_rid: +.. _class_RayCast2D_method_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. -.. _class_RayCast2D_set_collision_mask_bit: +.. _class_RayCast2D_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index abd3cf008..a68443f86 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -19,11 +19,11 @@ Ray shape for 3D collisions. Properties ---------- -+---------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`slips_on_slope` | -+---------------------------+------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`slips_on_slope` | ++---------------------------+---------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Ray shape for 3D collisions, which can be set into a :ref:`PhysicsBody` **length** @@ -45,7 +45,7 @@ Property Descriptions The ray's length. -.. _class_RayShape_slips_on_slope: +.. _class_RayShape_property_slips_on_slope: - :ref:`bool` **slips_on_slope** diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 7dcddbfbc..a6f8f67ce 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -19,11 +19,11 @@ Ray shape for 2D collisions. Properties ---------- -+---------------------------+--------------------------------------------------------+ -| :ref:`float` | :ref:`length` | -+---------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`slips_on_slope` | -+---------------------------+--------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+-----------------------------------------------------------------+ +| :ref:`bool` | :ref:`slips_on_slope` | ++---------------------------+-----------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Ray shape for 2D collisions. A ray is not really a collision body, instead it tr Property Descriptions --------------------- -.. _class_RayShape2D_length: +.. _class_RayShape2D_property_length: - :ref:`float` **length** @@ -45,7 +45,7 @@ Property Descriptions The ray's length. -.. _class_RayShape2D_slips_on_slope: +.. _class_RayShape2D_property_slips_on_slope: - :ref:`bool` **slips_on_slope** diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index d07224314..d9516a726 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -17,46 +17,46 @@ Brief Description Properties ---------- -+-------------------------------+---------------------------------------+ -| :ref:`Vector2` | :ref:`end` | -+-------------------------------+---------------------------------------+ -| :ref:`Vector2` | :ref:`position` | -+-------------------------------+---------------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+-------------------------------+---------------------------------------+ ++-------------------------------+------------------------------------------------+ +| :ref:`Vector2` | :ref:`end` | ++-------------------------------+------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+------------------------------------------------+ +| :ref:`Vector2` | :ref:`size` | ++-------------------------------+------------------------------------------------+ Methods ------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`abs` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_area` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow` **(** :ref:`float` by **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow_individual` **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow_margin` **(** :ref:`int` margin, :ref:`float` by **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_area` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`abs` **(** **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_area` **(** **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`grow` **(** :ref:`float` by **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`grow_individual` **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`grow_margin` **(** :ref:`int` margin, :ref:`float` by **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_area` **(** **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -71,19 +71,19 @@ Tutorials Property Descriptions --------------------- -.. _class_Rect2_end: +.. _class_Rect2_property_end: - :ref:`Vector2` **end** Ending corner. -.. _class_Rect2_position: +.. _class_Rect2_property_position: - :ref:`Vector2` **position** Position (starting corner). -.. _class_Rect2_size: +.. _class_Rect2_property_size: - :ref:`Vector2` **size** @@ -92,85 +92,83 @@ Size from position to end. Method Descriptions ------------------- -.. _class_Rect2_Rect2: +.. _class_Rect2_method_Rect2: - :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** Constructs a ``Rect2`` by position and size. -.. _class_Rect2_Rect2: - - :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** Constructs a ``Rect2`` by x, y, width, and height. -.. _class_Rect2_abs: +.. _class_Rect2_method_abs: - :ref:`Rect2` **abs** **(** **)** Returns a ``Rect2`` with equivalent position and area, modified so that the top-left corner is the origin and ``width`` and ``height`` are positive. -.. _class_Rect2_clip: +.. _class_Rect2_method_clip: - :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** Returns the intersection of this ``Rect2`` and b. -.. _class_Rect2_encloses: +.. _class_Rect2_method_encloses: - :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** Returns ``true`` if this ``Rect2`` completely encloses another one. -.. _class_Rect2_expand: +.. _class_Rect2_method_expand: - :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** Returns this ``Rect2`` expanded to include a given point. -.. _class_Rect2_get_area: +.. _class_Rect2_method_get_area: - :ref:`float` **get_area** **(** **)** Returns the area of the ``Rect2``. -.. _class_Rect2_grow: +.. _class_Rect2_method_grow: - :ref:`Rect2` **grow** **(** :ref:`float` by **)** Returns a copy of the ``Rect2`` grown a given amount of units towards all the sides. -.. _class_Rect2_grow_individual: +.. _class_Rect2_method_grow_individual: - :ref:`Rect2` **grow_individual** **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** Returns a copy of the ``Rect2`` grown a given amount of units towards each direction individually. -.. _class_Rect2_grow_margin: +.. _class_Rect2_method_grow_margin: - :ref:`Rect2` **grow_margin** **(** :ref:`int` margin, :ref:`float` by **)** Returns a copy of the ``Rect2`` grown a given amount of units towards the :ref:`Margin` direction. -.. _class_Rect2_has_no_area: +.. _class_Rect2_method_has_no_area: - :ref:`bool` **has_no_area** **(** **)** Returns ``true`` if the ``Rect2`` is flat or empty. -.. _class_Rect2_has_point: +.. _class_Rect2_method_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** Returns ``true`` if the ``Rect2`` contains a point. -.. _class_Rect2_intersects: +.. _class_Rect2_method_intersects: - :ref:`bool` **intersects** **(** :ref:`Rect2` b **)** Returns ``true`` if the ``Rect2`` overlaps with another. -.. _class_Rect2_merge: +.. _class_Rect2_method_merge: - :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index cba7ff34d..4751de2d9 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -19,9 +19,9 @@ Rectangle shape for 2D collisions. Properties ---------- -+-------------------------------+------------------------------------------------+ -| :ref:`Vector2` | :ref:`extents` | -+-------------------------------+------------------------------------------------+ ++-------------------------------+---------------------------------------------------------+ +| :ref:`Vector2` | :ref:`extents` | ++-------------------------------+---------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D Property Descriptions --------------------- -.. _class_RectangleShape2D_extents: +.. _class_RectangleShape2D_property_extents: - :ref:`Vector2` **extents** diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 945499e39..205e6050c 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -21,13 +21,13 @@ Base class for anything that keeps a reference count. Methods ------- -+--------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`init_ref` **(** **)** | -+--------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`reference` **(** **)** | -+--------------------------+-------------------------------------------------------------+ -| :ref:`bool` | :ref:`unreference` **(** **)** | -+--------------------------+-------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`init_ref` **(** **)** | ++-------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reference` **(** **)** | ++-------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`unreference` **(** **)** | ++-------------------------+--------------------------------------------------------------------+ Description ----------- @@ -37,17 +37,17 @@ Base class for anything that keeps a reference count. Resource and many other he Method Descriptions ------------------- -.. _class_Reference_init_ref: +.. _class_Reference_method_init_ref: - :ref:`bool` **init_ref** **(** **)** -.. _class_Reference_reference: +.. _class_Reference_method_reference: - :ref:`bool` **reference** **(** **)** Increase the internal reference counter. Use this only if you really know what you are doing. -.. _class_Reference_unreference: +.. _class_Reference_method_unreference: - :ref:`bool` **unreference** **(** **)** diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 12ac3a045..6b50734de 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -19,9 +19,9 @@ Reference frame for GUI. Properties ---------- -+---------------------------+-------------------------------------------------------+ -| :ref:`Color` | :ref:`border_color` | -+---------------------------+-------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------+ +| :ref:`Color` | :ref:`border_color` | ++---------------------------+----------------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Reference frame for GUI. It's just like an empty control, except a red box is di Property Descriptions --------------------- -.. _class_ReferenceRect_border_color: +.. _class_ReferenceRect_property_border_color: - :ref:`Color` **border_color** diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 97b283a60..fd0c96b38 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -19,37 +19,41 @@ Brief Description Properties ---------- -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`box_projection` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cull_mask` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`enable_shadows` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`extents` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`intensity` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`interior_ambient_color` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interior_ambient_contrib` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interior_ambient_energy` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interior_enable` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max_distance` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`origin_offset` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ -| :ref:`UpdateMode` | :ref:`update_mode` | -+----------------------------------------------------+---------------------------------------------------------------------------------+ ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`box_projection` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cull_mask` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`enable_shadows` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`extents` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`intensity` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`interior_ambient_color` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interior_ambient_contrib` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interior_ambient_energy` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interior_enable` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max_distance` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`origin_offset` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ +| :ref:`UpdateMode` | :ref:`update_mode` | ++----------------------------------------------------+------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_ReflectionProbe_UpdateMode: +.. _class_ReflectionProbe_constant_UPDATE_ONCE: + +.. _class_ReflectionProbe_constant_UPDATE_ALWAYS: + enum **UpdateMode**: - **UPDATE_ONCE** = **0** @@ -64,7 +68,7 @@ Tutorials Property Descriptions --------------------- -.. _class_ReflectionProbe_box_projection: +.. _class_ReflectionProbe_property_box_projection: - :ref:`bool` **box_projection** @@ -74,7 +78,7 @@ Property Descriptions | *Getter* | is_box_projection_enabled() | +----------+----------------------------------+ -.. _class_ReflectionProbe_cull_mask: +.. _class_ReflectionProbe_property_cull_mask: - :ref:`int` **cull_mask** @@ -84,7 +88,7 @@ Property Descriptions | *Getter* | get_cull_mask() | +----------+----------------------+ -.. _class_ReflectionProbe_enable_shadows: +.. _class_ReflectionProbe_property_enable_shadows: - :ref:`bool` **enable_shadows** @@ -94,7 +98,7 @@ Property Descriptions | *Getter* | are_shadows_enabled() | +----------+---------------------------+ -.. _class_ReflectionProbe_extents: +.. _class_ReflectionProbe_property_extents: - :ref:`Vector3` **extents** @@ -104,7 +108,7 @@ Property Descriptions | *Getter* | get_extents() | +----------+--------------------+ -.. _class_ReflectionProbe_intensity: +.. _class_ReflectionProbe_property_intensity: - :ref:`float` **intensity** @@ -114,7 +118,7 @@ Property Descriptions | *Getter* | get_intensity() | +----------+----------------------+ -.. _class_ReflectionProbe_interior_ambient_color: +.. _class_ReflectionProbe_property_interior_ambient_color: - :ref:`Color` **interior_ambient_color** @@ -124,7 +128,7 @@ Property Descriptions | *Getter* | get_interior_ambient() | +----------+-----------------------------+ -.. _class_ReflectionProbe_interior_ambient_contrib: +.. _class_ReflectionProbe_property_interior_ambient_contrib: - :ref:`float` **interior_ambient_contrib** @@ -134,7 +138,7 @@ Property Descriptions | *Getter* | get_interior_ambient_probe_contribution() | +----------+------------------------------------------------+ -.. _class_ReflectionProbe_interior_ambient_energy: +.. _class_ReflectionProbe_property_interior_ambient_energy: - :ref:`float` **interior_ambient_energy** @@ -144,7 +148,7 @@ Property Descriptions | *Getter* | get_interior_ambient_energy() | +----------+------------------------------------+ -.. _class_ReflectionProbe_interior_enable: +.. _class_ReflectionProbe_property_interior_enable: - :ref:`bool` **interior_enable** @@ -154,7 +158,7 @@ Property Descriptions | *Getter* | is_set_as_interior() | +----------+------------------------+ -.. _class_ReflectionProbe_max_distance: +.. _class_ReflectionProbe_property_max_distance: - :ref:`float` **max_distance** @@ -164,7 +168,7 @@ Property Descriptions | *Getter* | get_max_distance() | +----------+-------------------------+ -.. _class_ReflectionProbe_origin_offset: +.. _class_ReflectionProbe_property_origin_offset: - :ref:`Vector3` **origin_offset** @@ -174,7 +178,7 @@ Property Descriptions | *Getter* | get_origin_offset() | +----------+--------------------------+ -.. _class_ReflectionProbe_update_mode: +.. _class_ReflectionProbe_property_update_mode: - :ref:`UpdateMode` **update_mode** diff --git a/classes/class_regex.rst b/classes/class_regex.rst index c06093eec..de0b1b056 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -19,32 +19,32 @@ Class for searching text for patterns using regular expressions. Methods ------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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 | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- Regular Expression (or regex) is a compact programming language that can be used to recognise strings that follow a specific pattern, such as URLs, email addresses, complete sentences, etc. For instance, a regex of ``ab[0-9]`` would find any string that is ``ab`` followed by any number from ``0`` to ``9``. For a more in-depth look, you can easily find various tutorials and detailed explanations on the Internet. -To begin, the RegEx object needs to be compiled with the search pattern using :ref:`compile` before it can be used. +To begin, the RegEx object needs to be compiled with the search pattern using :ref:`compile` before it can be used. :: @@ -53,7 +53,7 @@ To begin, the RegEx object needs to be compiled with the search pattern using :r The search pattern must be escaped first for gdscript before it is escaped for the expression. For example, ``compile("\\d+")`` would be read by RegEx as ``\d+``. Similarly, ``compile("\"(?:\\\\.|[^\"])*\"")`` would be read as ``"(?:\\.|[^"])*"`` -Using :ref:`search` you can find the pattern within the given text. If a pattern is found, :ref:`RegExMatch` is returned and you can retrieve details of the results using functions such as :ref:`RegExMatch.get_string` and :ref:`RegExMatch.get_start`. +Using :ref:`search` you can find the pattern within the given text. If a pattern is found, :ref:`RegExMatch` is returned and you can retrieve details of the results using functions such as :ref:`RegExMatch.get_string` and :ref:`RegExMatch.get_start`. :: @@ -75,7 +75,7 @@ This version of RegEx also supports named capturing groups, and the names can be if result: print(result.get_string("digit")) # Would print 2f -If you need to process multiple results, :ref:`search_all` generates a list of all non-overlapping results. This can be combined with a for-loop for convenience. +If you need to process multiple results, :ref:`search_all` generates a list of all non-overlapping results. This can be combined with a for-loop for convenience. :: @@ -87,55 +87,55 @@ If you need to process multiple results, :ref:`search_all` **compile** **(** :ref:`String` pattern **)** Compiles and assign the search pattern to use. Returns OK if the compilation is successful. If an error is encountered the details are printed to STDOUT and FAILED is returned. -.. _class_RegEx_get_group_count: +.. _class_RegEx_method_get_group_count: - :ref:`int` **get_group_count** **(** **)** const Returns the number of capturing groups in compiled pattern. -.. _class_RegEx_get_names: +.. _class_RegEx_method_get_names: - :ref:`Array` **get_names** **(** **)** const Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. -.. _class_RegEx_get_pattern: +.. _class_RegEx_method_get_pattern: - :ref:`String` **get_pattern** **(** **)** const Returns the original search pattern that was compiled. -.. _class_RegEx_is_valid: +.. _class_RegEx_method_is_valid: - :ref:`bool` **is_valid** **(** **)** const Returns whether this object has a valid search pattern assigned. -.. _class_RegEx_search: +.. _class_RegEx_method_search: - :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. -.. _class_RegEx_search_all: +.. _class_RegEx_method_search_all: - :ref:`Array` **search_all** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const Searches the text for the compiled pattern. Returns an array of :ref:`RegExMatch` containers for each non-overlapping result. If no results were found an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. -.. _class_RegEx_sub: +.. _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 diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 3d6a462e4..7f3330665 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -19,36 +19,36 @@ Contains the results of a regex search. Properties ---------- -+-------------------------------------+------------------------------------------+ -| :ref:`Dictionary` | :ref:`names` | -+-------------------------------------+------------------------------------------+ -| :ref:`Array` | :ref:`strings` | -+-------------------------------------+------------------------------------------+ -| :ref:`String` | :ref:`subject` | -+-------------------------------------+------------------------------------------+ ++-------------------------------------+---------------------------------------------------+ +| :ref:`Dictionary` | :ref:`names` | ++-------------------------------------+---------------------------------------------------+ +| :ref:`Array` | :ref:`strings` | ++-------------------------------------+---------------------------------------------------+ +| :ref:`String` | :ref:`subject` | ++-------------------------------------+---------------------------------------------------+ 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 | ++-----------------------------+--------------------------------------------------------------------------------------------------------------+ Description ----------- -Contains the results of a single regex match returned by :ref:`RegEx.search` and :ref:`RegEx.search_all`. It can be used to find the position and range of the match and its capturing groups, and it can extract its sub-string for you. +Contains the results of a single regex match returned by :ref:`RegEx.search` and :ref:`RegEx.search_all`. It can be used to find the position and range of the match and its capturing groups, and it can extract its sub-string for you. Property Descriptions --------------------- -.. _class_RegExMatch_names: +.. _class_RegExMatch_property_names: - :ref:`Dictionary` **names** @@ -58,7 +58,7 @@ Property Descriptions A dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. -.. _class_RegExMatch_strings: +.. _class_RegExMatch_property_strings: - :ref:`Array` **strings** @@ -68,7 +68,7 @@ A dictionary of named groups and its corresponding group number. Only groups wit An :ref:`Array` of the match and its capturing groups. -.. _class_RegExMatch_subject: +.. _class_RegExMatch_property_subject: - :ref:`String` **subject** @@ -81,7 +81,7 @@ The source string used with the search pattern to find this matching result. Method Descriptions ------------------- -.. _class_RegExMatch_get_end: +.. _class_RegExMatch_method_get_end: - :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const @@ -89,13 +89,13 @@ Returns the end position of the match within the source string. The end position Returns -1 if the group did not match or doesn't exist. -.. _class_RegExMatch_get_group_count: +.. _class_RegExMatch_method_get_group_count: - :ref:`int` **get_group_count** **(** **)** const Returns the number of capturing groups. -.. _class_RegExMatch_get_start: +.. _class_RegExMatch_method_get_start: - :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const @@ -103,7 +103,7 @@ Returns the starting position of the match within the source string. The startin Returns -1 if the group did not match or doesn't exist. -.. _class_RegExMatch_get_string: +.. _class_RegExMatch_method_get_string: - :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index fcd1a61aa..0519fb8c1 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -19,17 +19,17 @@ RemoteTransform pushes its own :ref:`Transform` to another :ref Properties ---------- -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`remote_path` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_position` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_rotation` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_scale` | -+---------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_global_coordinates` | -+---------------------------------+-----------------------------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`remote_path` | ++---------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`update_position` | ++---------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`update_rotation` | ++---------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`update_scale` | ++---------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_global_coordinates` | ++---------------------------------+--------------------------------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ It can be set to update another Node's position, rotation and/or scale. It can u Property Descriptions --------------------- -.. _class_RemoteTransform_remote_path: +.. _class_RemoteTransform_property_remote_path: - :ref:`NodePath` **remote_path** @@ -53,7 +53,7 @@ Property Descriptions The :ref:`NodePath` to the remote node, relative to the RemoteTransform's position in the scene. -.. _class_RemoteTransform_update_position: +.. _class_RemoteTransform_property_update_position: - :ref:`bool` **update_position** @@ -65,7 +65,7 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr If ``true``, the remote node's position is updated. Default value: ``true``. -.. _class_RemoteTransform_update_rotation: +.. _class_RemoteTransform_property_update_rotation: - :ref:`bool` **update_rotation** @@ -77,7 +77,7 @@ If ``true``, the remote node's position is updated. Default value: ``true``. If ``true``, the remote node's rotation is updated. Default value: ``true``. -.. _class_RemoteTransform_update_scale: +.. _class_RemoteTransform_property_update_scale: - :ref:`bool` **update_scale** @@ -89,7 +89,7 @@ If ``true``, the remote node's rotation is updated. Default value: ``true``. If ``true``, the remote node's scale is updated. Default value: ``true``. -.. _class_RemoteTransform_use_global_coordinates: +.. _class_RemoteTransform_property_use_global_coordinates: - :ref:`bool` **use_global_coordinates** diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index b5201185e..86bb44ed4 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -19,17 +19,17 @@ RemoteTransform2D pushes its own :ref:`Transform2D` to anothe Properties ---------- -+---------------------------------+-------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`remote_path` | -+---------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_position` | -+---------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_rotation` | -+---------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`update_scale` | -+---------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_global_coordinates` | -+---------------------------------+-------------------------------------------------------------------------------+ ++---------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`remote_path` | ++---------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`update_position` | ++---------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`update_rotation` | ++---------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`update_scale` | ++---------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_global_coordinates` | ++---------------------------------+----------------------------------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ It can be set to update another Node's position, rotation and/or scale. It can u Property Descriptions --------------------- -.. _class_RemoteTransform2D_remote_path: +.. _class_RemoteTransform2D_property_remote_path: - :ref:`NodePath` **remote_path** @@ -53,7 +53,7 @@ Property Descriptions The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. -.. _class_RemoteTransform2D_update_position: +.. _class_RemoteTransform2D_property_update_position: - :ref:`bool` **update_position** @@ -65,7 +65,7 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr If ``true``, the remote node's position is updated. Default value: ``true``. -.. _class_RemoteTransform2D_update_rotation: +.. _class_RemoteTransform2D_property_update_rotation: - :ref:`bool` **update_rotation** @@ -77,7 +77,7 @@ If ``true``, the remote node's position is updated. Default value: ``true``. If ``true``, the remote node's rotation is updated. Default value: ``true``. -.. _class_RemoteTransform2D_update_scale: +.. _class_RemoteTransform2D_property_update_scale: - :ref:`bool` **update_scale** @@ -89,7 +89,7 @@ If ``true``, the remote node's rotation is updated. Default value: ``true``. If ``true``, the remote node's scale is updated. Default value: ``true``. -.. _class_RemoteTransform2D_use_global_coordinates: +.. _class_RemoteTransform2D_property_use_global_coordinates: - :ref:`bool` **use_global_coordinates** diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 8f04efc37..f59ac94d9 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -21,35 +21,35 @@ Base class for all resources. Properties ---------- -+-----------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resource_local_to_scene` | -+-----------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resource_name` | -+-----------------------------+------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resource_path` | -+-----------------------------+------------------------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resource_local_to_scene` | ++-----------------------------+---------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resource_name` | ++-----------------------------+---------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resource_path` | ++-----------------------------+---------------------------------------------------------------------------------+ 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 ------- -.. _class_Resource_changed: +.. _class_Resource_signal_changed: - **changed** **(** **)** @@ -61,7 +61,7 @@ Resource is the base class for all resource types. Resources are primarily data Property Descriptions --------------------- -.. _class_Resource_resource_local_to_scene: +.. _class_Resource_property_resource_local_to_scene: - :ref:`bool` **resource_local_to_scene** @@ -71,7 +71,7 @@ Property Descriptions | *Getter* | is_local_to_scene() | +----------+---------------------------+ -.. _class_Resource_resource_name: +.. _class_Resource_property_resource_name: - :ref:`String` **resource_name** @@ -81,7 +81,7 @@ Property Descriptions | *Getter* | get_name() | +----------+-----------------+ -.. _class_Resource_resource_path: +.. _class_Resource_property_resource_path: - :ref:`String` **resource_path** @@ -94,29 +94,29 @@ Property Descriptions Method Descriptions ------------------- -.. _class_Resource__setup_local_to_scene: +.. _class_Resource_method__setup_local_to_scene: - void **_setup_local_to_scene** **(** **)** virtual -.. _class_Resource_duplicate: +.. _class_Resource_method_duplicate: - :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const -.. _class_Resource_get_local_scene: +.. _class_Resource_method_get_local_scene: - :ref:`Node` **get_local_scene** **(** **)** const -.. _class_Resource_get_rid: +.. _class_Resource_method_get_rid: - :ref:`RID` **get_rid** **(** **)** const Return the RID of the resource (or an empty RID). Many resources (such as :ref:`Texture`, :ref:`Mesh`, etc) are high level abstractions of resources stored in a server, so this function will return the original RID. -.. _class_Resource_setup_local_to_scene: +.. _class_Resource_method_setup_local_to_scene: - void **setup_local_to_scene** **(** **)** -.. _class_Resource_take_over_path: +.. _class_Resource_method_take_over_path: - void **take_over_path** **(** :ref:`String` path **)** diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index 647087ca3..37da7caee 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -21,19 +21,19 @@ Loads a specific resource type from a file. 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 | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -47,37 +47,37 @@ Note: You can also extend :ref:`EditorImportPlugin` if Method Descriptions ------------------- -.. _class_ResourceFormatLoader_get_dependencies: +.. _class_ResourceFormatLoader_method_get_dependencies: - 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. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just return ``Resource`` for them. -.. _class_ResourceFormatLoader_get_recognized_extensions: +.. _class_ResourceFormatLoader_method_get_recognized_extensions: - :ref:`PoolStringArray` **get_recognized_extensions** **(** **)** virtual Gets the list of extensions for files this loader is able to read. -.. _class_ResourceFormatLoader_get_resource_type: +.. _class_ResourceFormatLoader_method_get_resource_type: - :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 ``""``. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just return ``"Resource"`` for them. -.. _class_ResourceFormatLoader_handles_type: +.. _class_ResourceFormatLoader_method_handles_type: - :ref:`bool` **handles_type** **(** :ref:`String` typename **)** virtual Tells which resource class this loader can load. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just handle ``"Resource"`` for them. -.. _class_ResourceFormatLoader_load: +.. _class_ResourceFormatLoader_method_load: - :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 resource object if succeeded, or an ``ERR_*`` constant listed in :ref:`@GlobalScope` if it failed. -.. _class_ResourceFormatLoader_rename_dependencies: +.. _class_ResourceFormatLoader_method_rename_dependencies: - :ref:`int` **rename_dependencies** **(** :ref:`String` path, :ref:`String` renames **)** virtual diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index c552f89cd..2a24dc0fb 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -21,37 +21,37 @@ Saves a specific resource type to a file. 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 | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -The engine can save resources when you do it from the editor, or when you call :ref:`ResourceSaver.save`. This is accomplished with multiple ``ResourceFormatSaver``\ s, each handling its own format. +The engine can save resources when you do it from the editor, or when you call :ref:`ResourceSaver.save`. This is accomplished with multiple ``ResourceFormatSaver``\ s, each handling its own format. By default, Godot saves resources as ``.tres``, ``.res`` or another built-in format, but you can choose to create your own format by extending this class. You should give it a global class name with ``class_name`` for it to be registered. You may as well implement a :ref:`ResourceFormatLoader`. Method Descriptions ------------------- -.. _class_ResourceFormatSaver_get_recognized_extensions: +.. _class_ResourceFormatSaver_method_get_recognized_extensions: - :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` resource **)** virtual Gets the list of extensions for files this saver is able to write. -.. _class_ResourceFormatSaver_recognize: +.. _class_ResourceFormatSaver_method_recognize: - :ref:`bool` **recognize** **(** :ref:`Resource` resource **)** virtual Returns true if the given resource object can be saved by this saver. -.. _class_ResourceFormatSaver_save: +.. _class_ResourceFormatSaver_method_save: - :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** virtual diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 20d48995f..12a78099c 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -19,17 +19,17 @@ Interactive Resource Loader. 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` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------+ Description ----------- @@ -39,31 +39,31 @@ Interactive Resource Loader. This object is returned by ResourceLoader when perf Method Descriptions ------------------- -.. _class_ResourceInteractiveLoader_get_resource: +.. _class_ResourceInteractiveLoader_method_get_resource: - :ref:`Resource` **get_resource** **(** **)** Return the loaded resource (only if loaded). Otherwise, returns null. -.. _class_ResourceInteractiveLoader_get_stage: +.. _class_ResourceInteractiveLoader_method_get_stage: - :ref:`int` **get_stage** **(** **)** const -Return the load stage. The total amount of stages can be queried with :ref:`get_stage_count` +Return the load stage. The total amount of stages can be queried with :ref:`get_stage_count` -.. _class_ResourceInteractiveLoader_get_stage_count: +.. _class_ResourceInteractiveLoader_method_get_stage_count: - :ref:`int` **get_stage_count** **(** **)** const -Return the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. +Return the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. -.. _class_ResourceInteractiveLoader_poll: +.. _class_ResourceInteractiveLoader_method_poll: - :ref:`Error` **poll** **(** **)** -Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. +Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. -.. _class_ResourceInteractiveLoader_wait: +.. _class_ResourceInteractiveLoader_method_wait: - :ref:`Error` **wait** **(** **)** diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index b1cc3415f..b6037f58e 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -19,23 +19,23 @@ Resource Loader. Methods ------- -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` no_cache=false **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | -+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` no_cache=false **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | ++-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -45,39 +45,39 @@ Resource Loader. This is a static object accessible as ``ResourceLoader``. GDScr Method Descriptions ------------------- -.. _class_ResourceLoader_exists: +.. _class_ResourceLoader_method_exists: - :ref:`bool` **exists** **(** :ref:`String` path, :ref:`String` type_hint="" **)** -.. _class_ResourceLoader_get_dependencies: +.. _class_ResourceLoader_method_get_dependencies: - :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** -.. _class_ResourceLoader_get_recognized_extensions_for_type: +.. _class_ResourceLoader_method_get_recognized_extensions_for_type: - :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** Return the list of recognized extensions for a resource type. -.. _class_ResourceLoader_has: +.. _class_ResourceLoader_method_has: - :ref:`bool` **has** **(** :ref:`String` path **)** -.. _class_ResourceLoader_has_cached: +.. _class_ResourceLoader_method_has_cached: - :ref:`bool` **has_cached** **(** :ref:`String` path **)** -.. _class_ResourceLoader_load: +.. _class_ResourceLoader_method_load: - :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` no_cache=false **)** -.. _class_ResourceLoader_load_interactive: +.. _class_ResourceLoader_method_load_interactive: - :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** Load a resource interactively, the returned object allows to load with high granularity. -.. _class_ResourceLoader_set_abort_on_missing_resources: +.. _class_ResourceLoader_method_set_abort_on_missing_resources: - void **set_abort_on_missing_resources** **(** :ref:`bool` abort **)** diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index cbb24d19e..4e5b77d75 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -19,19 +19,19 @@ Resource Preloader Node. Methods ------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Resource` resource **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_resource` **(** :ref:`String` name **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Resource` resource **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_resource` **(** :ref:`String` name **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -41,35 +41,35 @@ Resource Preloader Node. This node is used to preload sub-resources inside a sce Method Descriptions ------------------- -.. _class_ResourcePreloader_add_resource: +.. _class_ResourcePreloader_method_add_resource: - void **add_resource** **(** :ref:`String` name, :ref:`Resource` resource **)** -.. _class_ResourcePreloader_get_resource: +.. _class_ResourcePreloader_method_get_resource: - :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const Return the resource given a text-id. -.. _class_ResourcePreloader_get_resource_list: +.. _class_ResourcePreloader_method_get_resource_list: - :ref:`PoolStringArray` **get_resource_list** **(** **)** const Return the list of resources inside the preloader. -.. _class_ResourcePreloader_has_resource: +.. _class_ResourcePreloader_method_has_resource: - :ref:`bool` **has_resource** **(** :ref:`String` name **)** const Return true if the preloader has a given resource. -.. _class_ResourcePreloader_remove_resource: +.. _class_ResourcePreloader_method_remove_resource: - void **remove_resource** **(** :ref:`String` name **)** Remove a resource from the preloader by text id. -.. _class_ResourcePreloader_rename_resource: +.. _class_ResourcePreloader_method_rename_resource: - void **rename_resource** **(** :ref:`String` name, :ref:`String` newname **)** diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index e6cc1eafb..247a1fd2d 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -19,17 +19,31 @@ Resource saving interface. Methods ------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_ResourceSaver_SaverFlags: +.. _class_ResourceSaver_constant_FLAG_RELATIVE_PATHS: + +.. _class_ResourceSaver_constant_FLAG_BUNDLE_RESOURCES: + +.. _class_ResourceSaver_constant_FLAG_CHANGE_PATH: + +.. _class_ResourceSaver_constant_FLAG_OMIT_EDITOR_PROPERTIES: + +.. _class_ResourceSaver_constant_FLAG_SAVE_BIG_ENDIAN: + +.. _class_ResourceSaver_constant_FLAG_COMPRESS: + +.. _class_ResourceSaver_constant_FLAG_REPLACE_SUBRESOURCE_PATHS: + enum **SaverFlags**: - **FLAG_RELATIVE_PATHS** = **1** @@ -54,13 +68,13 @@ Resource saving interface, used for saving resources to disk. Method Descriptions ------------------- -.. _class_ResourceSaver_get_recognized_extensions: +.. _class_ResourceSaver_method_get_recognized_extensions: - :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** Returns the list of extensions available for saving a resource of a given type. -.. _class_ResourceSaver_save: +.. _class_ResourceSaver_method_save: - :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 9027dc5d6..134d36ab3 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -19,140 +19,140 @@ Label that displays rich text. Properties ---------- -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bbcode_enabled` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`bbcode_text` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`meta_underlined` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`override_selected_font_color` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`percent_visible` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_active` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_following` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`selection_enabled` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tab_size` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+-----------------------------+---------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`visible_characters` | -+-----------------------------+---------------------------------------------------------------------------------------+ ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`bbcode_enabled` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`bbcode_text` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`meta_underlined` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`override_selected_font_color` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`percent_visible` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`scroll_active` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`scroll_following` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`selection_enabled` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`tab_size` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`text` | ++-----------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`visible_characters` | ++-----------------------------+------------------------------------------------------------------------------------------------+ Methods ------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_image` **(** :ref:`Texture` image **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_text` **(** :ref:`String` text **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_content_height` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`newline` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pop` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_align` **(** :ref:`Align` align **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_cell` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_color` **(** :ref:`Color` color **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_font` **(** :ref:`Font` font **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_indent` **(** :ref:`int` level **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_list` **(** :ref:`ListType` type **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_strikethrough` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_table` **(** :ref:`int` columns **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_underline` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` line **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_image` **(** :ref:`Texture` image **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_text` **(** :ref:`String` text **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_content_height` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`newline` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_align` **(** :ref:`Align` align **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_cell` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_color` **(** :ref:`Color` color **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_font` **(** :ref:`Font` font **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_indent` **(** :ref:`int` level **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_list` **(** :ref:`ListType` type **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_strikethrough` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_table` **(** :ref:`int` columns **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_underline` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` line **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`Font` | :ref:`bold_font` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`Font` | :ref:`bold_italics_font` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`Color` | :ref:`default_color` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_selected` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_shadow` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`Font` | :ref:`italics_font` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`line_separation` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`Font` | :ref:`mono_font` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`Font` | :ref:`normal_font` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`Color` | :ref:`selection_color` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_as_outline` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_offset_x` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_offset_y` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`table_hseparation` | -+---------------------------------+---------------------------------------------------------------------+ -| :ref:`int` | :ref:`table_vseparation` | -+---------------------------------+---------------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`Font` | bold_font | ++---------------------------------+---------------------+ +| :ref:`Font` | bold_italics_font | ++---------------------------------+---------------------+ +| :ref:`Color` | default_color | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_selected | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_shadow | ++---------------------------------+---------------------+ +| :ref:`Font` | italics_font | ++---------------------------------+---------------------+ +| :ref:`int` | line_separation | ++---------------------------------+---------------------+ +| :ref:`Font` | mono_font | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+---------------------+ +| :ref:`Font` | normal_font | ++---------------------------------+---------------------+ +| :ref:`Color` | selection_color | ++---------------------------------+---------------------+ +| :ref:`int` | shadow_as_outline | ++---------------------------------+---------------------+ +| :ref:`int` | shadow_offset_x | ++---------------------------------+---------------------+ +| :ref:`int` | shadow_offset_y | ++---------------------------------+---------------------+ +| :ref:`int` | table_hseparation | ++---------------------------------+---------------------+ +| :ref:`int` | table_vseparation | ++---------------------------------+---------------------+ Signals ------- -.. _class_RichTextLabel_meta_clicked: +.. _class_RichTextLabel_signal_meta_clicked: - **meta_clicked** **(** :ref:`Nil` meta **)** -Triggered when the user clicks on content between ``[url]`` tags. If the meta is defined in text, e.g. ``[url={"data"="hi"}]hi[/url]``, then the parameter for this signal will be a :ref:`String` type. If a particular type or an object is desired, the :ref:`push_meta` method must be used to manually insert the data into the tag stack. +Triggered when the user clicks on content between ``[url]`` tags. If the meta is defined in text, e.g. ``[url={"data"="hi"}]hi[/url]``, then the parameter for this signal will be a :ref:`String` type. If a particular type or an object is desired, the :ref:`push_meta` method must be used to manually insert the data into the tag stack. -.. _class_RichTextLabel_meta_hover_ended: +.. _class_RichTextLabel_signal_meta_hover_ended: - **meta_hover_ended** **(** :ref:`Nil` meta **)** Triggers when the mouse exits a meta tag. -.. _class_RichTextLabel_meta_hover_started: +.. _class_RichTextLabel_signal_meta_hover_started: - **meta_hover_started** **(** :ref:`Nil` meta **)** @@ -163,6 +163,14 @@ Enumerations .. _enum_RichTextLabel_Align: +.. _class_RichTextLabel_constant_ALIGN_LEFT: + +.. _class_RichTextLabel_constant_ALIGN_CENTER: + +.. _class_RichTextLabel_constant_ALIGN_RIGHT: + +.. _class_RichTextLabel_constant_ALIGN_FILL: + enum **Align**: - **ALIGN_LEFT** = **0** @@ -175,6 +183,12 @@ enum **Align**: .. _enum_RichTextLabel_ListType: +.. _class_RichTextLabel_constant_LIST_NUMBERS: + +.. _class_RichTextLabel_constant_LIST_LETTERS: + +.. _class_RichTextLabel_constant_LIST_DOTS: + enum **ListType**: - **LIST_NUMBERS** = **0** @@ -185,6 +199,32 @@ enum **ListType**: .. _enum_RichTextLabel_ItemType: +.. _class_RichTextLabel_constant_ITEM_FRAME: + +.. _class_RichTextLabel_constant_ITEM_TEXT: + +.. _class_RichTextLabel_constant_ITEM_IMAGE: + +.. _class_RichTextLabel_constant_ITEM_NEWLINE: + +.. _class_RichTextLabel_constant_ITEM_FONT: + +.. _class_RichTextLabel_constant_ITEM_COLOR: + +.. _class_RichTextLabel_constant_ITEM_UNDERLINE: + +.. _class_RichTextLabel_constant_ITEM_STRIKETHROUGH: + +.. _class_RichTextLabel_constant_ITEM_ALIGN: + +.. _class_RichTextLabel_constant_ITEM_INDENT: + +.. _class_RichTextLabel_constant_ITEM_LIST: + +.. _class_RichTextLabel_constant_ITEM_TABLE: + +.. _class_RichTextLabel_constant_ITEM_META: + enum **ItemType**: - **ITEM_FRAME** = **0** @@ -218,7 +258,7 @@ Description Rich text can contain custom text, fonts, images and some basic formatting. The label manages these as an internal tag stack. It also adapts itself to given width/heights. -Note that assignments to :ref:`bbcode_text` clear the tag stack and reconstruct it from the property's contents. Any edits made to :ref:`bbcode_text` will erase previous edits made from other manual sources such as :ref:`append_bbcode` and the ``push_*`` / :ref:`pop` methods. +Note that assignments to :ref:`bbcode_text` clear the tag stack and reconstruct it from the property's contents. Any edits made to :ref:`bbcode_text` will erase previous edits made from other manual sources such as :ref:`append_bbcode` and the ``push_*`` / :ref:`pop` methods. Tutorials --------- @@ -228,7 +268,7 @@ Tutorials Property Descriptions --------------------- -.. _class_RichTextLabel_bbcode_enabled: +.. _class_RichTextLabel_property_bbcode_enabled: - :ref:`bool` **bbcode_enabled** @@ -240,7 +280,7 @@ Property Descriptions If ``true``, the label uses BBCode formatting. Default value: ``false``. -.. _class_RichTextLabel_bbcode_text: +.. _class_RichTextLabel_property_bbcode_text: - :ref:`String` **bbcode_text** @@ -252,7 +292,7 @@ If ``true``, the label uses BBCode formatting. Default value: ``false``. The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. -.. _class_RichTextLabel_meta_underlined: +.. _class_RichTextLabel_property_meta_underlined: - :ref:`bool` **meta_underlined** @@ -264,7 +304,7 @@ The label's text in BBCode format. Is not representative of manual modifications If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. Default value: ``true``. -.. _class_RichTextLabel_override_selected_font_color: +.. _class_RichTextLabel_property_override_selected_font_color: - :ref:`bool` **override_selected_font_color** @@ -276,7 +316,7 @@ If ``true``, the label underlines meta tags such as ``[url]{text}[/url]``. Defau If ``true``, the label uses the custom font color. Default value: ``false``. -.. _class_RichTextLabel_percent_visible: +.. _class_RichTextLabel_property_percent_visible: - :ref:`float` **percent_visible** @@ -288,7 +328,7 @@ If ``true``, the label uses the custom font color. Default value: ``false``. The text's visibility, as a :ref:`float` between 0.0 and 1.0. -.. _class_RichTextLabel_scroll_active: +.. _class_RichTextLabel_property_scroll_active: - :ref:`bool` **scroll_active** @@ -298,9 +338,9 @@ The text's visibility, as a :ref:`float` between 0.0 and 1.0. | *Getter* | is_scroll_active() | +----------+--------------------------+ -If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. Default value: ``true``. +If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. Default value: ``true``. -.. _class_RichTextLabel_scroll_following: +.. _class_RichTextLabel_property_scroll_following: - :ref:`bool` **scroll_following** @@ -312,7 +352,7 @@ If ``true``, the scrollbar is visible. Does not block scrolling completely. See If ``true``, the window scrolls down to display new content automatically. Default value: ``false``. -.. _class_RichTextLabel_selection_enabled: +.. _class_RichTextLabel_property_selection_enabled: - :ref:`bool` **selection_enabled** @@ -324,7 +364,7 @@ If ``true``, the window scrolls down to display new content automatically. Defau If ``true``, the label allows text selection. -.. _class_RichTextLabel_tab_size: +.. _class_RichTextLabel_property_tab_size: - :ref:`int` **tab_size** @@ -336,7 +376,7 @@ If ``true``, the label allows text selection. The number of spaces associated with a single tab length. Does not affect "\\t" in text tags, only indent tags. -.. _class_RichTextLabel_text: +.. _class_RichTextLabel_property_text: - :ref:`String` **text** @@ -348,9 +388,9 @@ The number of spaces associated with a single tab length. Does not affect "\\t" The raw text of the label. -When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify :ref:`bbcode_text`. +When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify :ref:`bbcode_text`. -.. _class_RichTextLabel_visible_characters: +.. _class_RichTextLabel_property_visible_characters: - :ref:`int` **visible_characters** @@ -365,151 +405,151 @@ The restricted number of characters to display in the label. Method Descriptions ------------------- -.. _class_RichTextLabel_add_image: +.. _class_RichTextLabel_method_add_image: - void **add_image** **(** :ref:`Texture` image **)** Adds an image's opening and closing tags to the tag stack. -.. _class_RichTextLabel_add_text: +.. _class_RichTextLabel_method_add_text: - void **add_text** **(** :ref:`String` text **)** Adds raw non-bbcode-parsed text to the tag stack. -.. _class_RichTextLabel_append_bbcode: +.. _class_RichTextLabel_method_append_bbcode: - :ref:`Error` **append_bbcode** **(** :ref:`String` bbcode **)** Parses ``bbcode`` and adds tags to the tag stack as needed. Returns the result of the parsing, ``OK`` if successful. -.. _class_RichTextLabel_clear: +.. _class_RichTextLabel_method_clear: - void **clear** **(** **)** -Clears the tag stack and sets :ref:`bbcode_text` to an empty string. +Clears the tag stack and sets :ref:`bbcode_text` to an empty string. -.. _class_RichTextLabel_get_content_height: +.. _class_RichTextLabel_method_get_content_height: - :ref:`int` **get_content_height** **(** **)** Returns the height of the content. -.. _class_RichTextLabel_get_line_count: +.. _class_RichTextLabel_method_get_line_count: - :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. -.. _class_RichTextLabel_get_total_character_count: +.. _class_RichTextLabel_method_get_total_character_count: - :ref:`int` **get_total_character_count** **(** **)** const Returns the total number of characters from text tags. Does not include bbcodes. -.. _class_RichTextLabel_get_v_scroll: +.. _class_RichTextLabel_method_get_v_scroll: - :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the vertical scrollbar. -.. _class_RichTextLabel_get_visible_line_count: +.. _class_RichTextLabel_method_get_visible_line_count: - :ref:`int` **get_visible_line_count** **(** **)** const Returns the number of visible lines. -.. _class_RichTextLabel_newline: +.. _class_RichTextLabel_method_newline: - void **newline** **(** **)** Adds a newline tag to the tag stack. -.. _class_RichTextLabel_parse_bbcode: +.. _class_RichTextLabel_method_parse_bbcode: - :ref:`Error` **parse_bbcode** **(** :ref:`String` bbcode **)** -The assignment version of :ref:`append_bbcode`. Clears the tag stack and inserts the new content. Returns ``OK`` if parses ``bbcode`` successfully. +The assignment version of :ref:`append_bbcode`. Clears the tag stack and inserts the new content. Returns ``OK`` if parses ``bbcode`` successfully. -.. _class_RichTextLabel_pop: +.. _class_RichTextLabel_method_pop: - void **pop** **(** **)** Terminates the current tag. Use after ``push_*`` methods to close bbcodes manually. Does not need to follow ``add_*`` methods. -.. _class_RichTextLabel_push_align: +.. _class_RichTextLabel_method_push_align: - void **push_align** **(** :ref:`Align` align **)** -Adds an alignment tag based on the given ``align`` value. See :ref:`Align` for possible values. +Adds an alignment tag based on the given ``align`` value. See :ref:`Align` for possible values. -.. _class_RichTextLabel_push_cell: +.. _class_RichTextLabel_method_push_cell: - void **push_cell** **(** **)** -Adds a ``[cell]`` tag to the tag stack. Must be inside a ``[table]`` tag. See :ref:`push_table` for details. +Adds a ``[cell]`` tag to the tag stack. Must be inside a ``[table]`` tag. See :ref:`push_table` for details. -.. _class_RichTextLabel_push_color: +.. _class_RichTextLabel_method_push_color: - void **push_color** **(** :ref:`Color` color **)** Adds a ``[color]`` tag to the tag stack. -.. _class_RichTextLabel_push_font: +.. _class_RichTextLabel_method_push_font: - void **push_font** **(** :ref:`Font` font **)** Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration. -.. _class_RichTextLabel_push_indent: +.. _class_RichTextLabel_method_push_indent: - void **push_indent** **(** :ref:`int` level **)** Adds an ``[indent]`` tag to the tag stack. Multiplies "level" by current tab_size to determine new margin length. -.. _class_RichTextLabel_push_list: +.. _class_RichTextLabel_method_push_list: - void **push_list** **(** :ref:`ListType` type **)** Adds a list tag to the tag stack. Similar to the bbcodes ``[ol]`` or ``[ul]``, but supports more list types. Not fully implemented! -.. _class_RichTextLabel_push_meta: +.. _class_RichTextLabel_method_push_meta: - void **push_meta** **(** :ref:`Variant` data **)** Adds a meta tag to the tag stack. Similar to the bbcode ``[url=something]{text}[/url]``, but supports non-:ref:`String` metadata types. -.. _class_RichTextLabel_push_strikethrough: +.. _class_RichTextLabel_method_push_strikethrough: - void **push_strikethrough** **(** **)** Adds a ``[s]`` tag to the tag stack. -.. _class_RichTextLabel_push_table: +.. _class_RichTextLabel_method_push_table: - void **push_table** **(** :ref:`int` columns **)** Adds a ``[table=columns]`` tag to the tag stack. -.. _class_RichTextLabel_push_underline: +.. _class_RichTextLabel_method_push_underline: - void **push_underline** **(** **)** Adds a ``[u]`` tag to the tag stack. -.. _class_RichTextLabel_remove_line: +.. _class_RichTextLabel_method_remove_line: - :ref:`bool` **remove_line** **(** :ref:`int` line **)** Removes a line of content from the label. Returns ``true`` if the line exists. -.. _class_RichTextLabel_scroll_to_line: +.. _class_RichTextLabel_method_scroll_to_line: - void **scroll_to_line** **(** :ref:`int` line **)** Scrolls the window's top line to match ``line``. -.. _class_RichTextLabel_set_table_column_expand: +.. _class_RichTextLabel_method_set_table_column_expand: - void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** diff --git a/classes/class_rid.rst b/classes/class_rid.rst index e31786d3b..bee609a29 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -17,11 +17,11 @@ Handle for a :ref:`Resource`'s unique ID. Methods ------- -+------------------------+------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`RID` **(** :ref:`Object` from **)** | -+------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_id` **(** **)** | -+------------------------+------------------------------------------------------------------------+ ++-----------------------+-------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`RID` **(** :ref:`Object` from **)** | ++-----------------------+-------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** | ++-----------------------+-------------------------------------------------------------------------------+ Description ----------- @@ -31,13 +31,13 @@ The RID type is used to access the unique integer ID of a resource. They are opa Method Descriptions ------------------- -.. _class_RID_RID: +.. _class_RID_method_RID: - :ref:`RID` **RID** **(** :ref:`Object` from **)** Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0. -.. _class_RID_get_id: +.. _class_RID_method_get_id: - :ref:`int` **get_id** **(** **)** diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 81d429dc3..32d58f0c4 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -21,93 +21,93 @@ Physics Body whose position is determined through physics simulation in 3D space Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_damp` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`angular_velocity` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_angular_x` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_angular_y` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_angular_z` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_linear_x` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_linear_y` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`axis_lock_linear_z` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_sleep` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`contact_monitor` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`contacts_reported` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`continuous_cd` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`custom_integrator` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_scale` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_damp` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`linear_velocity` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mass` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sleeping` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`weight` | -+-----------------------------------------------+-----------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_damp` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`angular_velocity` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`axis_lock_angular_x` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`axis_lock_angular_y` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`axis_lock_angular_z` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`axis_lock_linear_x` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`axis_lock_linear_y` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`axis_lock_linear_z` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bounce` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_sleep` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`contact_monitor` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`contacts_reported` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`continuous_cd` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`custom_integrator` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`friction` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gravity_scale` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_damp` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`linear_velocity` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`mass` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`sleeping` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`weight` | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ 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:`Array` | :ref:`get_colliding_bodies` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`Array` | :ref:`get_colliding_bodies` **(** **)** const | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_RigidBody_body_entered: +.. _class_RigidBody_signal_body_entered: - **body_entered** **(** :ref:`Node` body **)** Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. -.. _class_RigidBody_body_exited: +.. _class_RigidBody_signal_body_exited: - **body_exited** **(** :ref:`Node` body **)** Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. -.. _class_RigidBody_body_shape_entered: +.. _class_RigidBody_signal_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** @@ -115,7 +115,7 @@ Emitted when a body enters into contact with this one. Contact monitor and conta This signal not only receives the body that collided with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. -.. _class_RigidBody_body_shape_exited: +.. _class_RigidBody_signal_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** @@ -123,7 +123,7 @@ Emitted when a body shape exits contact with this one. Contact monitor and conta This signal not only receives the body that stopped colliding with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. -.. _class_RigidBody_sleeping_state_changed: +.. _class_RigidBody_signal_sleeping_state_changed: - **sleeping_state_changed** **(** **)** @@ -134,6 +134,14 @@ Enumerations .. _enum_RigidBody_Mode: +.. _class_RigidBody_constant_MODE_RIGID: + +.. _class_RigidBody_constant_MODE_STATIC: + +.. _class_RigidBody_constant_MODE_CHARACTER: + +.. _class_RigidBody_constant_MODE_KINEMATIC: + enum **Mode**: - **MODE_RIGID** = **0** --- Rigid body mode. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. @@ -149,11 +157,11 @@ Description This is the node that implements full 3D physics. This means that you do not control a RigidBody directly. Instead you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. -A RigidBody has 4 behavior :ref:`mode`\ s: Rigid, Static, Character, and Kinematic. +A RigidBody has 4 behavior :ref:`mode`\ s: Rigid, Static, Character, and Kinematic. -**Note:** Don't change a RigidBody's position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. If you need to directly affect the body's state, use :ref:`_integrate_forces`, which allows you to directly access the physics state. +**Note:** Don't change a RigidBody's position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. If you need to directly affect the body's state, use :ref:`_integrate_forces`, which allows you to directly access the physics state. -If you need to override the default physics behavior, you can write a custom force integration. See :ref:`custom_integrator`. +If you need to override the default physics behavior, you can write a custom force integration. See :ref:`custom_integrator`. Tutorials --------- @@ -163,7 +171,7 @@ Tutorials Property Descriptions --------------------- -.. _class_RigidBody_angular_damp: +.. _class_RigidBody_property_angular_damp: - :ref:`float` **angular_damp** @@ -175,7 +183,7 @@ Property Descriptions Damps RigidBody's rotational forces. -.. _class_RigidBody_angular_velocity: +.. _class_RigidBody_property_angular_velocity: - :ref:`Vector3` **angular_velocity** @@ -187,7 +195,7 @@ Damps RigidBody's rotational forces. RigidBody's rotational velocity. -.. _class_RigidBody_axis_lock_angular_x: +.. _class_RigidBody_property_axis_lock_angular_x: - :ref:`bool` **axis_lock_angular_x** @@ -199,7 +207,7 @@ RigidBody's rotational velocity. Lock the body's rotation in the x-axis. -.. _class_RigidBody_axis_lock_angular_y: +.. _class_RigidBody_property_axis_lock_angular_y: - :ref:`bool` **axis_lock_angular_y** @@ -211,7 +219,7 @@ Lock the body's rotation in the x-axis. Lock the body's rotation in the y-axis. -.. _class_RigidBody_axis_lock_angular_z: +.. _class_RigidBody_property_axis_lock_angular_z: - :ref:`bool` **axis_lock_angular_z** @@ -223,7 +231,7 @@ Lock the body's rotation in the y-axis. Lock the body's rotation in the z-axis. -.. _class_RigidBody_axis_lock_linear_x: +.. _class_RigidBody_property_axis_lock_linear_x: - :ref:`bool` **axis_lock_linear_x** @@ -235,7 +243,7 @@ Lock the body's rotation in the z-axis. Lock the body's movement in the x-axis. -.. _class_RigidBody_axis_lock_linear_y: +.. _class_RigidBody_property_axis_lock_linear_y: - :ref:`bool` **axis_lock_linear_y** @@ -247,7 +255,7 @@ Lock the body's movement in the x-axis. Lock the body's movement in the x-axis. -.. _class_RigidBody_axis_lock_linear_z: +.. _class_RigidBody_property_axis_lock_linear_z: - :ref:`bool` **axis_lock_linear_z** @@ -259,7 +267,7 @@ Lock the body's movement in the x-axis. Lock the body's movement in the x-axis. -.. _class_RigidBody_bounce: +.. _class_RigidBody_property_bounce: - :ref:`float` **bounce** @@ -271,7 +279,7 @@ Lock the body's movement in the x-axis. RigidBody's bounciness. -.. _class_RigidBody_can_sleep: +.. _class_RigidBody_property_can_sleep: - :ref:`bool` **can_sleep** @@ -283,7 +291,7 @@ RigidBody's bounciness. If ``true``, the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the ``apply_impulse`` method is used. -.. _class_RigidBody_contact_monitor: +.. _class_RigidBody_property_contact_monitor: - :ref:`bool` **contact_monitor** @@ -295,7 +303,7 @@ If ``true``, the RigidBody will not calculate forces and will act as a static bo If ``true``, the RigidBody will emit signals when it collides with another RigidBody. -.. _class_RigidBody_contacts_reported: +.. _class_RigidBody_property_contacts_reported: - :ref:`int` **contacts_reported** @@ -307,7 +315,7 @@ If ``true``, the RigidBody will emit signals when it collides with another Rigid The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. -.. _class_RigidBody_continuous_cd: +.. _class_RigidBody_property_continuous_cd: - :ref:`bool` **continuous_cd** @@ -321,7 +329,7 @@ If ``true``, continuous collision detection is used. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses less impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. -.. _class_RigidBody_custom_integrator: +.. _class_RigidBody_property_custom_integrator: - :ref:`bool` **custom_integrator** @@ -331,9 +339,9 @@ Continuous collision detection tries to predict where a moving body will collide | *Getter* | is_using_custom_integrator() | +----------+----------------------------------+ -If ``true``, internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. +If ``true``, internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. -.. _class_RigidBody_friction: +.. _class_RigidBody_property_friction: - :ref:`float` **friction** @@ -345,7 +353,7 @@ If ``true``, internal force integration will be disabled (like gravity or air fr The body's friction, from 0 (frictionless) to 1 (max friction). -.. _class_RigidBody_gravity_scale: +.. _class_RigidBody_property_gravity_scale: - :ref:`float` **gravity_scale** @@ -357,7 +365,7 @@ The body's friction, from 0 (frictionless) to 1 (max friction). This is multiplied by the global 3D gravity setting found in "Project > Project Settings > Physics > 3d" to produce RigidBody's gravity. E.g. a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. -.. _class_RigidBody_linear_damp: +.. _class_RigidBody_property_linear_damp: - :ref:`float` **linear_damp** @@ -369,7 +377,7 @@ This is multiplied by the global 3D gravity setting found in "Project > Project The body's linear damp. Default value: -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. -.. _class_RigidBody_linear_velocity: +.. _class_RigidBody_property_linear_velocity: - :ref:`Vector3` **linear_velocity** @@ -379,9 +387,9 @@ The body's linear damp. Default value: -1, cannot be less than -1. If this value | *Getter* | get_linear_velocity() | +----------+----------------------------+ -The body's linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. +The body's linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. -.. _class_RigidBody_mass: +.. _class_RigidBody_property_mass: - :ref:`float` **mass** @@ -393,7 +401,7 @@ The body's linear velocity. Can be used sporadically, but **DON'T SET THIS IN EV The body's mass. -.. _class_RigidBody_mode: +.. _class_RigidBody_property_mode: - :ref:`Mode` **mode** @@ -405,7 +413,7 @@ The body's mass. The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. -.. _class_RigidBody_physics_material_override: +.. _class_RigidBody_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** @@ -415,7 +423,7 @@ The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC | *Getter* | get_physics_material_override() | +----------+--------------------------------------+ -.. _class_RigidBody_sleeping: +.. _class_RigidBody_property_sleeping: - :ref:`bool` **sleeping** @@ -427,7 +435,7 @@ The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC If ``true``, the body is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. -.. _class_RigidBody_weight: +.. _class_RigidBody_property_weight: - :ref:`float` **weight** @@ -442,13 +450,13 @@ The body's weight based on its mass and the global 3D gravity. Global values are Method Descriptions ------------------- -.. _class_RigidBody__integrate_forces: +.. _class_RigidBody_method__integrate_forces: - 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. +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. -.. _class_RigidBody_add_central_force: +.. _class_RigidBody_method_add_central_force: - void **add_central_force** **(** :ref:`Vector3` force **)** @@ -456,19 +464,19 @@ Adds a constant directional force without affecting rotation. This is equivalent to ``add_force(force, Vector3(0,0,0))``. -.. _class_RigidBody_add_force: +.. _class_RigidBody_method_add_force: - void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** Adds a constant force (i.e. acceleration). -.. _class_RigidBody_add_torque: +.. _class_RigidBody_method_add_torque: - void **add_torque** **(** :ref:`Vector3` torque **)** Adds a constant rotational force (i.e. a motor) without affecting position. -.. _class_RigidBody_apply_central_impulse: +.. _class_RigidBody_method_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** @@ -476,25 +484,25 @@ Applies a directional impulse without affecting rotation. This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``. -.. _class_RigidBody_apply_impulse: +.. _class_RigidBody_method_apply_impulse: - void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** Applies a positioned impulse which will be affected by the body mass and shape. This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the object's origin. -.. _class_RigidBody_apply_torque_impulse: +.. _class_RigidBody_method_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`Vector3` impulse **)** Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the passed in vector. -.. _class_RigidBody_get_colliding_bodies: +.. _class_RigidBody_method_get_colliding_bodies: - :ref:`Array` **get_colliding_bodies** **(** **)** const -Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the :ref:`contacts_reported` property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. +Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0, see the :ref:`contacts_reported` property to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. -.. _class_RigidBody_set_axis_velocity: +.. _class_RigidBody_method_set_axis_velocity: - void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 85b917947..bd5dd0113 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -19,111 +19,119 @@ A body that is controlled by the 2D physics engine. Properties ---------- -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_damp` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`applied_force` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`applied_torque` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_sleep` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`contact_monitor` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`contacts_reported` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`CCDMode` | :ref:`continuous_cd` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`custom_integrator` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gravity_scale` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`inertia` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_damp` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`linear_velocity` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mass` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`sleeping` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`weight` | -+-----------------------------------------------+-------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_damp` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`applied_force` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`applied_torque` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bounce` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_sleep` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`contact_monitor` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`contacts_reported` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`CCDMode` | :ref:`continuous_cd` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`custom_integrator` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`friction` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gravity_scale` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inertia` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_damp` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`linear_velocity` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`mass` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`sleeping` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`weight` | ++-----------------------------------------------+----------------------------------------------------------------------------------------+ Methods ------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_integrate_forces` **(** :ref:`Physics2DDirectBodyState` state **)** virtual | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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` torque **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_motion` **(** :ref:`Vector2` motion, :ref:`bool` infinite_inertia=true, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_integrate_forces` **(** :ref:`Physics2DDirectBodyState` state **)** virtual | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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` torque **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_motion` **(** :ref:`Vector2` motion, :ref:`bool` infinite_inertia=true, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_RigidBody2D_body_entered: +.. _class_RigidBody2D_signal_body_entered: - **body_entered** **(** :ref:`Node` body **)** -Emitted when a body enters into contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. +Emitted when a body enters into contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. -.. _class_RigidBody2D_body_exited: +.. _class_RigidBody2D_signal_body_exited: - **body_exited** **(** :ref:`Node` body **)** -Emitted when a body exits contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. +Emitted when a body exits contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. -.. _class_RigidBody2D_body_shape_entered: +.. _class_RigidBody2D_signal_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** -Emitted when a body enters into contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. +Emitted when a body enters into contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. -.. _class_RigidBody2D_body_shape_exited: +.. _class_RigidBody2D_signal_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** -Emitted when a body shape exits contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. +Emitted when a body shape exits contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. -.. _class_RigidBody2D_sleeping_state_changed: +.. _class_RigidBody2D_signal_sleeping_state_changed: - **sleeping_state_changed** **(** **)** -Emitted when :ref:`sleeping` changes. +Emitted when :ref:`sleeping` changes. Enumerations ------------ .. _enum_RigidBody2D_Mode: +.. _class_RigidBody2D_constant_MODE_RIGID: + +.. _class_RigidBody2D_constant_MODE_STATIC: + +.. _class_RigidBody2D_constant_MODE_CHARACTER: + +.. _class_RigidBody2D_constant_MODE_KINEMATIC: + enum **Mode**: - **MODE_RIGID** = **0** --- Rigid mode. The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode. @@ -136,6 +144,12 @@ enum **Mode**: .. _enum_RigidBody2D_CCDMode: +.. _class_RigidBody2D_constant_CCD_MODE_DISABLED: + +.. _class_RigidBody2D_constant_CCD_MODE_CAST_RAY: + +.. _class_RigidBody2D_constant_CCD_MODE_CAST_SHAPE: + enum **CCDMode**: - **CCD_MODE_DISABLED** = **0** --- Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. @@ -149,16 +163,16 @@ Description This node implements simulated 2D physics. You do not control a RigidBody2D directly. Instead you apply forces to it (gravity, impulses, etc.) and the physics simulation calculates the resulting movement based on its mass, friction, and other physical properties. -A RigidBody2D has 4 behavior :ref:`mode`\ s: Rigid, Static, Character, and Kinematic. +A RigidBody2D has 4 behavior :ref:`mode`\ s: Rigid, Static, Character, and Kinematic. -**Note:** You should not change a RigidBody2D's ``position`` or ``linear_velocity`` every frame or even very often. If you need to directly affect the body's state, use :ref:`_integrate_forces`, which allows you to directly access the physics state. +**Note:** You should not change a RigidBody2D's ``position`` or ``linear_velocity`` every frame or even very often. If you need to directly affect the body's state, use :ref:`_integrate_forces`, which allows you to directly access the physics state. -If you need to override the default physics behavior, you can write a custom force integration. See :ref:`custom_integrator`. +If you need to override the default physics behavior, you can write a custom force integration. See :ref:`custom_integrator`. Property Descriptions --------------------- -.. _class_RigidBody2D_angular_damp: +.. _class_RigidBody2D_property_angular_damp: - :ref:`float` **angular_damp** @@ -168,9 +182,9 @@ Property Descriptions | *Getter* | get_angular_damp() | +----------+-------------------------+ -Damps the body's :ref:`angular_velocity`. If ``-1`` the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. +Damps the body's :ref:`angular_velocity`. If ``-1`` the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. -.. _class_RigidBody2D_angular_velocity: +.. _class_RigidBody2D_property_angular_velocity: - :ref:`float` **angular_velocity** @@ -182,7 +196,7 @@ Damps the body's :ref:`angular_velocity`. If The body's rotational velocity. -.. _class_RigidBody2D_applied_force: +.. _class_RigidBody2D_property_applied_force: - :ref:`Vector2` **applied_force** @@ -194,7 +208,7 @@ The body's rotational velocity. The body's total applied force. -.. _class_RigidBody2D_applied_torque: +.. _class_RigidBody2D_property_applied_torque: - :ref:`float` **applied_torque** @@ -206,7 +220,7 @@ The body's total applied force. The body's total applied torque. -.. _class_RigidBody2D_bounce: +.. _class_RigidBody2D_property_bounce: - :ref:`float` **bounce** @@ -218,7 +232,7 @@ The body's total applied torque. The body's bounciness. Default value: ``0``. -.. _class_RigidBody2D_can_sleep: +.. _class_RigidBody2D_property_can_sleep: - :ref:`bool` **can_sleep** @@ -228,9 +242,9 @@ The body's bounciness. Default value: ``0``. | *Getter* | is_able_to_sleep() | +----------+----------------------+ -If ``true``, the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using :ref:`apply_impulse` or :ref:`add_force`. Default value: ``true``. +If ``true``, the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using :ref:`apply_impulse` or :ref:`add_force`. Default value: ``true``. -.. _class_RigidBody2D_contact_monitor: +.. _class_RigidBody2D_property_contact_monitor: - :ref:`bool` **contact_monitor** @@ -240,9 +254,9 @@ If ``true``, the body will not calculate forces and will act as a static body if | *Getter* | is_contact_monitor_enabled() | +----------+------------------------------+ -If ``true``, the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. Default value: ``false``. +If ``true``, the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. Default value: ``false``. -.. _class_RigidBody2D_contacts_reported: +.. _class_RigidBody2D_property_contacts_reported: - :ref:`int` **contacts_reported** @@ -254,7 +268,7 @@ If ``true``, the body will emit signals when it collides with another RigidBody2 The maximum number of contacts to report. Default value: ``0``. -.. _class_RigidBody2D_continuous_cd: +.. _class_RigidBody2D_property_continuous_cd: - :ref:`CCDMode` **continuous_cd** @@ -268,7 +282,7 @@ Continuous collision detection mode. Default value: ``CCD_MODE_DISABLED``. Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See ``CCD_MODE_`` constants for details. -.. _class_RigidBody2D_custom_integrator: +.. _class_RigidBody2D_property_custom_integrator: - :ref:`bool` **custom_integrator** @@ -278,9 +292,9 @@ Continuous collision detection tries to predict where a moving body will collide | *Getter* | is_using_custom_integrator() | +----------+----------------------------------+ -If ``true``, internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the :ref:`_integrate_forces` function. +If ``true``, internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the :ref:`_integrate_forces` function. -.. _class_RigidBody2D_friction: +.. _class_RigidBody2D_property_friction: - :ref:`float` **friction** @@ -292,7 +306,7 @@ If ``true``, internal force integration is disabled for this body. Aside from co The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. -.. _class_RigidBody2D_gravity_scale: +.. _class_RigidBody2D_property_gravity_scale: - :ref:`float` **gravity_scale** @@ -304,7 +318,7 @@ The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum fr Multiplies the gravity applied to the body. The body's gravity is calculated from the "Default Gravity" value in "Project > Project Settings > Physics > 2d" and/or any additional gravity vector applied by :ref:`Area2D`\ s. Default value: ``1``. -.. _class_RigidBody2D_inertia: +.. _class_RigidBody2D_property_inertia: - :ref:`float` **inertia** @@ -316,7 +330,7 @@ Multiplies the gravity applied to the body. The body's gravity is calculated fro The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. -.. _class_RigidBody2D_linear_damp: +.. _class_RigidBody2D_property_linear_damp: - :ref:`float` **linear_damp** @@ -326,9 +340,9 @@ The body's moment of inertia. This is like mass, but for rotation: it determines | *Getter* | get_linear_damp() | +----------+------------------------+ -Damps the body's :ref:`linear_velocity`. If ``-1`` the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. +Damps the body's :ref:`linear_velocity`. If ``-1`` the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. -.. _class_RigidBody2D_linear_velocity: +.. _class_RigidBody2D_property_linear_velocity: - :ref:`Vector2` **linear_velocity** @@ -340,7 +354,7 @@ Damps the body's :ref:`linear_velocity`. If ` The body's linear velocity. -.. _class_RigidBody2D_mass: +.. _class_RigidBody2D_property_mass: - :ref:`float` **mass** @@ -352,7 +366,7 @@ The body's linear velocity. The body's mass. Default value: ``1``. -.. _class_RigidBody2D_mode: +.. _class_RigidBody2D_property_mode: - :ref:`Mode` **mode** @@ -364,7 +378,7 @@ The body's mass. Default value: ``1``. The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. -.. _class_RigidBody2D_physics_material_override: +.. _class_RigidBody2D_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** @@ -374,7 +388,7 @@ The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. | *Getter* | get_physics_material_override() | +----------+--------------------------------------+ -.. _class_RigidBody2D_sleeping: +.. _class_RigidBody2D_property_sleeping: - :ref:`bool` **sleeping** @@ -384,9 +398,9 @@ The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. | *Getter* | is_sleeping() | +----------+---------------------+ -If ``true``, the body is sleeping and will not calculate forces until woken up by a collision or by using :ref:`apply_impulse` or :ref:`add_force`. +If ``true``, the body is sleeping and will not calculate forces until woken up by a collision or by using :ref:`apply_impulse` or :ref:`add_force`. -.. _class_RigidBody2D_weight: +.. _class_RigidBody2D_property_weight: - :ref:`float` **weight** @@ -401,61 +415,61 @@ The body's weight based on its mass and the "Default Gravity" value in "Project Method Descriptions ------------------- -.. _class_RigidBody2D__integrate_forces: +.. _class_RigidBody2D_method__integrate_forces: - 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. +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. -.. _class_RigidBody2D_add_central_force: +.. _class_RigidBody2D_method_add_central_force: - void **add_central_force** **(** :ref:`Vector2` force **)** Adds a constant directional force without affecting rotation. -.. _class_RigidBody2D_add_force: +.. _class_RigidBody2D_method_add_force: - void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. -.. _class_RigidBody2D_add_torque: +.. _class_RigidBody2D_method_add_torque: - void **add_torque** **(** :ref:`float` torque **)** Adds a constant rotational force. -.. _class_RigidBody2D_apply_central_impulse: +.. _class_RigidBody2D_method_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** Applies a directional impulse without affecting rotation. -.. _class_RigidBody2D_apply_impulse: +.. _class_RigidBody2D_method_apply_impulse: - void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates. -.. _class_RigidBody2D_apply_torque_impulse: +.. _class_RigidBody2D_method_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`float` torque **)** Applies a rotational impulse to the body. -.. _class_RigidBody2D_get_colliding_bodies: +.. _class_RigidBody2D_method_get_colliding_bodies: - :ref:`Array` **get_colliding_bodies** **(** **)** const -Returns a list of the bodies colliding with this one. Use :ref:`contacts_reported` to set the maximum number reported. You must also set :ref:`contact_monitor` to ``true``. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. +Returns a list of the bodies colliding with this one. Use :ref:`contacts_reported` to set the maximum number reported. You must also set :ref:`contact_monitor` to ``true``. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. -.. _class_RigidBody2D_set_axis_velocity: +.. _class_RigidBody2D_method_set_axis_velocity: - void **set_axis_velocity** **(** :ref:`Vector2` axis_velocity **)** Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. -.. _class_RigidBody2D_test_motion: +.. _class_RigidBody2D_method_test_motion: - :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`bool` infinite_inertia=true, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index 0a4694770..78f707c6c 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -19,22 +19,22 @@ Brief Description Properties ---------- -+---------------------------------+------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`animation_path` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`cell_size` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`zero_y` | -+---------------------------------+------------------------------------------------------------+ ++---------------------------------+---------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`animation_path` | ++---------------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`cell_size` | ++---------------------------------+---------------------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------------+---------------------------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`zero_y` | ++---------------------------------+---------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_RootMotionView_animation_path: +.. _class_RootMotionView_property_animation_path: - :ref:`NodePath` **animation_path** @@ -44,7 +44,7 @@ Property Descriptions | *Getter* | get_animation_path() | +----------+---------------------------+ -.. _class_RootMotionView_cell_size: +.. _class_RootMotionView_property_cell_size: - :ref:`float` **cell_size** @@ -54,7 +54,7 @@ Property Descriptions | *Getter* | get_cell_size() | +----------+----------------------+ -.. _class_RootMotionView_color: +.. _class_RootMotionView_property_color: - :ref:`Color` **color** @@ -64,7 +64,7 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ -.. _class_RootMotionView_radius: +.. _class_RootMotionView_property_radius: - :ref:`float` **radius** @@ -74,7 +74,7 @@ Property Descriptions | *Getter* | get_radius() | +----------+-------------------+ -.. _class_RootMotionView_zero_y: +.. _class_RootMotionView_property_zero_y: - :ref:`bool` **zero_y** diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index b6cd80a82..2f9943723 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -19,60 +19,66 @@ A script interface to a scene file's data. 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 ------------ .. _enum_SceneState_GenEditState: +.. _class_SceneState_constant_GEN_EDIT_STATE_DISABLED: + +.. _class_SceneState_constant_GEN_EDIT_STATE_INSTANCE: + +.. _class_SceneState_constant_GEN_EDIT_STATE_MAIN: + enum **GenEditState**: -- **GEN_EDIT_STATE_DISABLED** = **0** --- If passed to :ref:`PackedScene.instance`, blocks edits to the scene state. +- **GEN_EDIT_STATE_DISABLED** = **0** --- If passed to :ref:`PackedScene.instance`, blocks edits to the scene state. -- **GEN_EDIT_STATE_INSTANCE** = **1** --- If passed to :ref:`PackedScene.instance`, provides inherited scene resources to the local scene. Requires tools compiled. +- **GEN_EDIT_STATE_INSTANCE** = **1** --- If passed to :ref:`PackedScene.instance`, provides inherited scene resources to the local scene. Requires tools compiled. -- **GEN_EDIT_STATE_MAIN** = **2** --- If passed to :ref:`PackedScene.instance`, provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled. +- **GEN_EDIT_STATE_MAIN** = **2** --- If passed to :ref:`PackedScene.instance`, provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled. Description ----------- @@ -82,119 +88,119 @@ Maintains a list of resources, nodes, exported, and overridden properties, and b Method Descriptions ------------------- -.. _class_SceneState_get_connection_binds: +.. _class_SceneState_method_get_connection_binds: - :ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** const Returns the list of bound parameters for the signal at ``idx``. -.. _class_SceneState_get_connection_count: +.. _class_SceneState_method_get_connection_count: - :ref:`int` **get_connection_count** **(** **)** const Returns the number of signal connections in the scene. -.. _class_SceneState_get_connection_flags: +.. _class_SceneState_method_get_connection_flags: - :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** const Returns the flags for the signal at ``idx``. See :ref:`Object`'s ``CONNECT_*`` flags. -.. _class_SceneState_get_connection_method: +.. _class_SceneState_method_get_connection_method: - :ref:`String` **get_connection_method** **(** :ref:`int` idx **)** const Returns the method connected to the signal at ``idx``. -.. _class_SceneState_get_connection_signal: +.. _class_SceneState_method_get_connection_signal: - :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const Returns the name of the signal at ``idx``. -.. _class_SceneState_get_connection_source: +.. _class_SceneState_method_get_connection_source: - :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. -.. _class_SceneState_get_connection_target: +.. _class_SceneState_method_get_connection_target: - :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. -.. _class_SceneState_get_node_count: +.. _class_SceneState_method_get_node_count: - :ref:`int` **get_node_count** **(** **)** const Returns the number of nodes in the scene. -.. _class_SceneState_get_node_groups: +.. _class_SceneState_method_get_node_groups: - :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const Returns the list of group names associated with the node at ``idx``. -.. _class_SceneState_get_node_index: +.. _class_SceneState_method_get_node_index: - :ref:`int` **get_node_index** **(** :ref:`int` idx **)** const -.. _class_SceneState_get_node_instance: +.. _class_SceneState_method_get_node_instance: - :ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** const Returns the scene for the node at ``idx`` or ``null`` if the node is not an instance. -.. _class_SceneState_get_node_instance_placeholder: +.. _class_SceneState_method_get_node_instance_placeholder: - :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`. -.. _class_SceneState_get_node_name: +.. _class_SceneState_method_get_node_name: - :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const Returns the name of the node at ``idx``. -.. _class_SceneState_get_node_owner_path: +.. _class_SceneState_method_get_node_owner_path: - :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. -.. _class_SceneState_get_node_path: +.. _class_SceneState_method_get_node_path: - :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const Returns the path to the node at ``idx``. -.. _class_SceneState_get_node_property_count: +.. _class_SceneState_method_get_node_property_count: - :ref:`int` **get_node_property_count** **(** :ref:`int` idx **)** const Returns the number of exported or overridden properties for the node at ``idx``. -.. _class_SceneState_get_node_property_name: +.. _class_SceneState_method_get_node_property_name: - :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``. -.. _class_SceneState_get_node_property_value: +.. _class_SceneState_method_get_node_property_value: - :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``. -.. _class_SceneState_get_node_type: +.. _class_SceneState_method_get_node_type: - :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const Returns the type of the node at ``idx``. -.. _class_SceneState_is_node_instance_placeholder: +.. _class_SceneState_method_is_node_instance_placeholder: - :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** const diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index eb62c36b0..76fe7e973 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -19,163 +19,163 @@ SceneTree manages a hierarchy of nodes. Properties ---------- -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`current_scene` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug_collisions_hint` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug_navigation_hint` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`edited_scene_root` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`MultiplayerAPI` | :ref:`multiplayer` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`multiplayer_poll` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`paused` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`refuse_new_network_connections` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`root` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_font_oversampling` | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`current_scene` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug_collisions_hint` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug_navigation_hint` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`edited_scene_root` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`MultiplayerAPI` | :ref:`multiplayer` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`multiplayer_poll` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`paused` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`refuse_new_network_connections` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`root` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_font_oversampling` | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------+ Methods ------- -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`Error` | :ref:`change_scene` **(** :ref:`String` path **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_unique_id` **(** **)** 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:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_handled` **(** **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_server` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group` **(** :ref:`String` group, :ref:`int` notification **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`quit` **(** **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`reload_current_scene` **(** **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group` **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_as_handled` **(** **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_quit_on_go_back` **(** :ref:`bool` enabled **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_stretch` **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`Error` | :ref:`change_scene` **(** :ref:`String` path **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** 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:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_handled` **(** **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_server` **(** **)** const | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group` **(** :ref:`String` group, :ref:`int` notification **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`quit` **(** **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`reload_current_scene` **(** **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group` **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_as_handled` **(** **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_quit_on_go_back` **(** :ref:`bool` enabled **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_stretch` **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** | ++---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_SceneTree_connected_to_server: +.. _class_SceneTree_signal_connected_to_server: - **connected_to_server** **(** **)** -Emitted whenever this SceneTree's :ref:`network_peer` successfully connected to a server. Only emitted on clients. +Emitted whenever this SceneTree's :ref:`network_peer` successfully connected to a server. Only emitted on clients. -.. _class_SceneTree_connection_failed: +.. _class_SceneTree_signal_connection_failed: - **connection_failed** **(** **)** -Emitted whenever this SceneTree's :ref:`network_peer` fails to establish a connection to a server. Only emitted on clients. +Emitted whenever this SceneTree's :ref:`network_peer` fails to establish a connection to a server. Only emitted on clients. -.. _class_SceneTree_files_dropped: +.. _class_SceneTree_signal_files_dropped: - **files_dropped** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** Emitted whenever files are drag-and-dropped onto the window. -.. _class_SceneTree_idle_frame: +.. _class_SceneTree_signal_idle_frame: - **idle_frame** **(** **)** -Emitted immediately before :ref:`Node._process` is called on every node in the SceneTree. +Emitted immediately before :ref:`Node._process` is called on every node in the SceneTree. -.. _class_SceneTree_network_peer_connected: +.. _class_SceneTree_signal_network_peer_connected: - **network_peer_connected** **(** :ref:`int` id **)** -Emitted whenever this SceneTree's :ref:`network_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). +Emitted whenever this SceneTree's :ref:`network_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). -.. _class_SceneTree_network_peer_disconnected: +.. _class_SceneTree_signal_network_peer_disconnected: - **network_peer_disconnected** **(** :ref:`int` id **)** -Emitted whenever this SceneTree's :ref:`network_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. +Emitted whenever this SceneTree's :ref:`network_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. -.. _class_SceneTree_node_added: +.. _class_SceneTree_signal_node_added: - **node_added** **(** :ref:`Node` node **)** Emitted whenever a node is added to the SceneTree. -.. _class_SceneTree_node_configuration_warning_changed: +.. _class_SceneTree_signal_node_configuration_warning_changed: - **node_configuration_warning_changed** **(** :ref:`Node` node **)** Emitted when a node's configuration changed. Only emitted in tool mode. -.. _class_SceneTree_node_removed: +.. _class_SceneTree_signal_node_removed: - **node_removed** **(** :ref:`Node` node **)** Emitted whenever a node is removed from the SceneTree. -.. _class_SceneTree_physics_frame: +.. _class_SceneTree_signal_physics_frame: - **physics_frame** **(** **)** -Emitted immediately before :ref:`Node._physics_process` is called on every node in the SceneTree. +Emitted immediately before :ref:`Node._physics_process` is called on every node in the SceneTree. -.. _class_SceneTree_screen_resized: +.. _class_SceneTree_signal_screen_resized: - **screen_resized** **(** **)** Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes. -.. _class_SceneTree_server_disconnected: +.. _class_SceneTree_signal_server_disconnected: - **server_disconnected** **(** **)** -Emitted whenever this SceneTree's :ref:`network_peer` disconnected from server. Only emitted on clients. +Emitted whenever this SceneTree's :ref:`network_peer` disconnected from server. Only emitted on clients. -.. _class_SceneTree_tree_changed: +.. _class_SceneTree_signal_tree_changed: - **tree_changed** **(** **)** @@ -186,6 +186,14 @@ Enumerations .. _enum_SceneTree_GroupCallFlags: +.. _class_SceneTree_constant_GROUP_CALL_DEFAULT: + +.. _class_SceneTree_constant_GROUP_CALL_REVERSE: + +.. _class_SceneTree_constant_GROUP_CALL_REALTIME: + +.. _class_SceneTree_constant_GROUP_CALL_UNIQUE: + enum **GroupCallFlags**: - **GROUP_CALL_DEFAULT** = **0** --- Call a group with no flags (default). @@ -198,6 +206,12 @@ enum **GroupCallFlags**: .. _enum_SceneTree_StretchMode: +.. _class_SceneTree_constant_STRETCH_MODE_DISABLED: + +.. _class_SceneTree_constant_STRETCH_MODE_2D: + +.. _class_SceneTree_constant_STRETCH_MODE_VIEWPORT: + enum **StretchMode**: - **STRETCH_MODE_DISABLED** = **0** --- No stretching. @@ -208,6 +222,16 @@ enum **StretchMode**: .. _enum_SceneTree_StretchAspect: +.. _class_SceneTree_constant_STRETCH_ASPECT_IGNORE: + +.. _class_SceneTree_constant_STRETCH_ASPECT_KEEP: + +.. _class_SceneTree_constant_STRETCH_ASPECT_KEEP_WIDTH: + +.. _class_SceneTree_constant_STRETCH_ASPECT_KEEP_HEIGHT: + +.. _class_SceneTree_constant_STRETCH_ASPECT_EXPAND: + enum **StretchAspect**: - **STRETCH_ASPECT_IGNORE** = **0** --- Fill the window with the content stretched to cover excessive space. Content may appear elongated. @@ -235,7 +259,7 @@ Tutorials Property Descriptions --------------------- -.. _class_SceneTree_current_scene: +.. _class_SceneTree_property_current_scene: - :ref:`Node` **current_scene** @@ -247,7 +271,7 @@ Property Descriptions The current scene. -.. _class_SceneTree_debug_collisions_hint: +.. _class_SceneTree_property_debug_collisions_hint: - :ref:`bool` **debug_collisions_hint** @@ -257,7 +281,7 @@ The current scene. | *Getter* | is_debugging_collisions_hint() | +----------+----------------------------------+ -.. _class_SceneTree_debug_navigation_hint: +.. _class_SceneTree_property_debug_navigation_hint: - :ref:`bool` **debug_navigation_hint** @@ -267,7 +291,7 @@ The current scene. | *Getter* | is_debugging_navigation_hint() | +----------+----------------------------------+ -.. _class_SceneTree_edited_scene_root: +.. _class_SceneTree_property_edited_scene_root: - :ref:`Node` **edited_scene_root** @@ -279,7 +303,7 @@ The current scene. The root of the edited scene. -.. _class_SceneTree_multiplayer: +.. _class_SceneTree_property_multiplayer: - :ref:`MultiplayerAPI` **multiplayer** @@ -291,7 +315,7 @@ The root of the edited scene. The default :ref:`MultiplayerAPI` instance for this SceneTree. -.. _class_SceneTree_multiplayer_poll: +.. _class_SceneTree_property_multiplayer_poll: - :ref:`bool` **multiplayer_poll** @@ -301,11 +325,11 @@ The default :ref:`MultiplayerAPI` instance for this SceneT | *Getter* | is_multiplayer_poll_enabled() | +----------+-------------------------------------+ -If ``true``, (default) enable the automatic polling of the :ref:`MultiplayerAPI` for this SceneTree during :ref:`idle_frame`. +If ``true``, (default) enable the automatic polling of the :ref:`MultiplayerAPI` for this SceneTree during :ref:`idle_frame`. -When ``false`` you need to manually call :ref:`MultiplayerAPI.poll` for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual :ref:`Mutex` protection when accessing the :ref:`MultiplayerAPI` from threads. +When ``false`` you need to manually call :ref:`MultiplayerAPI.poll` for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual :ref:`Mutex` protection when accessing the :ref:`MultiplayerAPI` from threads. -.. _class_SceneTree_network_peer: +.. _class_SceneTree_property_network_peer: - :ref:`NetworkedMultiplayerPeer` **network_peer** @@ -315,9 +339,9 @@ When ``false`` you need to manually call :ref:`MultiplayerAPI.poll`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. +The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with :ref:`is_network_server`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. -.. _class_SceneTree_paused: +.. _class_SceneTree_property_paused: - :ref:`bool` **paused** @@ -337,7 +361,7 @@ Doing so will have the following behavior: \* _input and _input_event will not be called anymore either. -.. _class_SceneTree_refuse_new_network_connections: +.. _class_SceneTree_property_refuse_new_network_connections: - :ref:`bool` **refuse_new_network_connections** @@ -347,9 +371,9 @@ Doing so will have the following behavior: | *Getter* | is_refusing_new_network_connections() | +----------+-------------------------------------------+ -If ``true``, the SceneTree's :ref:`network_peer` refuses new incoming connections. +If ``true``, the SceneTree's :ref:`network_peer` refuses new incoming connections. -.. _class_SceneTree_root: +.. _class_SceneTree_property_root: - :ref:`Viewport` **root** @@ -359,7 +383,7 @@ If ``true``, the SceneTree's :ref:`network_peer` r The SceneTree's :ref:`Viewport`. -.. _class_SceneTree_use_font_oversampling: +.. _class_SceneTree_property_use_font_oversampling: - :ref:`bool` **use_font_oversampling** @@ -374,157 +398,157 @@ If ``true``, font oversampling is used. Method Descriptions ------------------- -.. _class_SceneTree_call_group: +.. _class_SceneTree_method_call_group: - :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method **)** vararg Calls ``method`` on each member of the given group. -.. _class_SceneTree_call_group_flags: +.. _class_SceneTree_method_call_group_flags: - :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`. +Calls ``method`` on each member of the given group, respecting the given :ref:`GroupCallFlags`. -.. _class_SceneTree_change_scene: +.. _class_SceneTree_method_change_scene: - :ref:`Error` **change_scene** **(** :ref:`String` path **)** Changes to the scene at the given ``path``. -.. _class_SceneTree_change_scene_to: +.. _class_SceneTree_method_change_scene_to: - :ref:`Error` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** Changes to the given :ref:`PackedScene`. -.. _class_SceneTree_create_timer: +.. _class_SceneTree_method_create_timer: - :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** -Returns a :ref:`SceneTreeTimer` which will :ref:`SceneTreeTimer.timeout` after the given time in seconds elapsed in this SceneTree. If ``pause_mode_process`` is set to false, pausing the SceneTree will also pause the timer. +Returns a :ref:`SceneTreeTimer` which will :ref:`SceneTreeTimer.timeout` after the given time in seconds elapsed in this SceneTree. If ``pause_mode_process`` is set to false, pausing the SceneTree will also pause the timer. -.. _class_SceneTree_get_frame: +.. _class_SceneTree_method_get_frame: - :ref:`int` **get_frame** **(** **)** const -.. _class_SceneTree_get_network_connected_peers: +.. _class_SceneTree_method_get_network_connected_peers: - :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const -Returns the peer IDs of all connected peers of this SceneTree's :ref:`network_peer`. +Returns the peer IDs of all connected peers of this SceneTree's :ref:`network_peer`. -.. _class_SceneTree_get_network_unique_id: +.. _class_SceneTree_method_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const -Returns the unique peer ID of this SceneTree's :ref:`network_peer`. +Returns the unique peer ID of this SceneTree's :ref:`network_peer`. -.. _class_SceneTree_get_node_count: +.. _class_SceneTree_method_get_node_count: - :ref:`int` **get_node_count** **(** **)** const Returns the number of nodes in this SceneTree. -.. _class_SceneTree_get_nodes_in_group: +.. _class_SceneTree_method_get_nodes_in_group: - :ref:`Array` **get_nodes_in_group** **(** :ref:`String` group **)** Returns all nodes assigned to the given group. -.. _class_SceneTree_get_rpc_sender_id: +.. _class_SceneTree_method_get_rpc_sender_id: - :ref:`int` **get_rpc_sender_id** **(** **)** const Returns the sender's peer ID for the most recently received RPC call. -.. _class_SceneTree_has_group: +.. _class_SceneTree_method_has_group: - :ref:`bool` **has_group** **(** :ref:`String` name **)** const Returns ``true`` if the given group exists. -.. _class_SceneTree_has_network_peer: +.. _class_SceneTree_method_has_network_peer: - :ref:`bool` **has_network_peer** **(** **)** const -Returns ``true`` if there is a :ref:`network_peer` set. +Returns ``true`` if there is a :ref:`network_peer` set. -.. _class_SceneTree_is_input_handled: +.. _class_SceneTree_method_is_input_handled: - :ref:`bool` **is_input_handled** **(** **)** -Returns ``true`` if the most recent InputEvent was marked as handled with :ref:`set_input_as_handled`. +Returns ``true`` if the most recent InputEvent was marked as handled with :ref:`set_input_as_handled`. -.. _class_SceneTree_is_network_server: +.. _class_SceneTree_method_is_network_server: - :ref:`bool` **is_network_server** **(** **)** const -Returns ``true`` if this SceneTree's :ref:`network_peer` is in server mode (listening for connections). +Returns ``true`` if this SceneTree's :ref:`network_peer` is in server mode (listening for connections). -.. _class_SceneTree_notify_group: +.. _class_SceneTree_method_notify_group: - void **notify_group** **(** :ref:`String` group, :ref:`int` notification **)** Sends the given notification to all members of the ``group``. -.. _class_SceneTree_notify_group_flags: +.. _class_SceneTree_method_notify_group_flags: - void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** -Sends the given notification to all members of the ``group``, respecting the given :ref:`GroupCallFlags`. +Sends the given notification to all members of the ``group``, respecting the given :ref:`GroupCallFlags`. -.. _class_SceneTree_queue_delete: +.. _class_SceneTree_method_queue_delete: - void **queue_delete** **(** :ref:`Object` obj **)** -Queues the given object for deletion, delaying the call to :ref:`Object.free` to after the current frame. +Queues the given object for deletion, delaying the call to :ref:`Object.free` to after the current frame. -.. _class_SceneTree_quit: +.. _class_SceneTree_method_quit: - void **quit** **(** **)** Quits the application. -.. _class_SceneTree_reload_current_scene: +.. _class_SceneTree_method_reload_current_scene: - :ref:`Error` **reload_current_scene** **(** **)** Reloads the currently active scene. -.. _class_SceneTree_set_auto_accept_quit: +.. _class_SceneTree_method_set_auto_accept_quit: - void **set_auto_accept_quit** **(** :ref:`bool` enabled **)** If ``true``, the application automatically accepts quitting. -.. _class_SceneTree_set_group: +.. _class_SceneTree_method_set_group: - void **set_group** **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** Sets the given ``property`` to ``value`` on all members of the given group. -.. _class_SceneTree_set_group_flags: +.. _class_SceneTree_method_set_group_flags: - void **set_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** -Sets the given ``property`` to ``value`` on all members of the given group, respecting the given :ref:`GroupCallFlags`. +Sets the given ``property`` to ``value`` on all members of the given group, respecting the given :ref:`GroupCallFlags`. -.. _class_SceneTree_set_input_as_handled: +.. _class_SceneTree_method_set_input_as_handled: - void **set_input_as_handled** **(** **)** Marks the most recent input event as handled. -.. _class_SceneTree_set_quit_on_go_back: +.. _class_SceneTree_method_set_quit_on_go_back: - void **set_quit_on_go_back** **(** :ref:`bool` enabled **)** If ``true``, the application quits automatically on going back (e.g. on Android). -.. _class_SceneTree_set_screen_stretch: +.. _class_SceneTree_method_set_screen_stretch: - void **set_screen_stretch** **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** -Configures screen stretching to the given :ref:`StretchMode`, :ref:`StretchAspect`, minimum size and ``shrink``. +Configures screen stretching to the given :ref:`StretchMode`, :ref:`StretchAspect`, minimum size and ``shrink``. diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index a95fa29f8..286c93a63 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -19,21 +19,21 @@ Brief Description Properties ---------- -+---------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`time_left` | -+---------------------------+--------------------------------------------------+ ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`time_left` | ++---------------------------+-----------------------------------------------------------+ Signals ------- -.. _class_SceneTreeTimer_timeout: +.. _class_SceneTreeTimer_signal_timeout: - **timeout** **(** **)** Property Descriptions --------------------- -.. _class_SceneTreeTimer_time_left: +.. _class_SceneTreeTimer_property_time_left: - :ref:`float` **time_left** diff --git a/classes/class_script.rst b/classes/class_script.rst index 89707b336..7ee36eb62 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -21,37 +21,37 @@ A class stored as a resource. Properties ---------- -+-----------------------------+----------------------------------------------+ -| :ref:`String` | :ref:`source_code` | -+-----------------------------+----------------------------------------------+ ++-----------------------------+-------------------------------------------------------+ +| :ref:`String` | :ref:`source_code` | ++-----------------------------+-------------------------------------------------------+ Methods ------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_base_script` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_instance_base_type` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_source_code` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tool` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_base_script` **(** **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_instance_base_type` **(** **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_source_code` **(** **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tool` **(** **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Description ----------- A class stored as a resource. A script exends the functionality of all objects that instance it. -The ``new`` method of a script subclass creates a new instance. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. +The ``new`` method of a script subclass creates a new instance. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. Tutorials --------- @@ -61,7 +61,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Script_source_code: +.. _class_Script_property_source_code: - :ref:`String` **source_code** @@ -76,49 +76,49 @@ The script source code or an empty string if source code is not available. When Method Descriptions ------------------- -.. _class_Script_can_instance: +.. _class_Script_method_can_instance: - :ref:`bool` **can_instance** **(** **)** const Returns ``true`` if the script can be instanced. -.. _class_Script_get_base_script: +.. _class_Script_method_get_base_script: - :ref:`Script` **get_base_script** **(** **)** const Returns the script directly inherited by this script. -.. _class_Script_get_instance_base_type: +.. _class_Script_method_get_instance_base_type: - :ref:`String` **get_instance_base_type** **(** **)** const Returns the script's base type. -.. _class_Script_has_script_signal: +.. _class_Script_method_has_script_signal: - :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. -.. _class_Script_has_source_code: +.. _class_Script_method_has_source_code: - :ref:`bool` **has_source_code** **(** **)** const Returns ``true`` if the script contains non-empty source code. -.. _class_Script_instance_has: +.. _class_Script_method_instance_has: - :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** const Returns ``true`` if ``base_object`` is an instance of this script. -.. _class_Script_is_tool: +.. _class_Script_method_is_tool: - :ref:`bool` **is_tool** **(** **)** const Returns ``true`` if the script is a tool script. A tool script can run in the editor. -.. _class_Script_reload: +.. _class_Script_method_reload: - :ref:`Error` **reload** **(** :ref:`bool` keep_state=false **)** diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index 934e08dd4..2168682ed 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -19,14 +19,14 @@ The Editor's popup dialog for creating new :ref:`Script` files. Methods ------- -+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`config` **(** :ref:`String` inherits, :ref:`String` path, :ref:`bool` built_in_enabled=true **)** | -+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`config` **(** :ref:`String` inherits, :ref:`String` path, :ref:`bool` built_in_enabled=true **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_ScriptCreateDialog_script_created: +.. _class_ScriptCreateDialog_signal_script_created: - **script_created** **(** :ref:`Script` script **)** @@ -35,7 +35,7 @@ Emitted when the user clicks the OK button. Description ----------- -The ScriptCreateDialog creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling a :ref:`popup`\ () method. +The ScriptCreateDialog creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling a :ref:`popup`\ () method. :: @@ -47,7 +47,7 @@ The ScriptCreateDialog creates script files according to a given template for a Method Descriptions ------------------- -.. _class_ScriptCreateDialog_config: +.. _class_ScriptCreateDialog_method_config: - void **config** **(** :ref:`String` inherits, :ref:`String` path, :ref:`bool` built_in_enabled=true **)** diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 95bf764ab..413641a64 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -19,30 +19,30 @@ Brief 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:`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:`open_script_create_dialog` **(** :ref:`String` base_name, :ref:`String` base_path **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_ScriptEditor_editor_script_changed: +.. _class_ScriptEditor_signal_editor_script_changed: - **editor_script_changed** **(** :ref:`Script` script **)** Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. -.. _class_ScriptEditor_script_close: +.. _class_ScriptEditor_signal_script_close: - **script_close** **(** :ref:`Script` script **)** @@ -51,31 +51,31 @@ Emitted when editor is about to close the active script. Argument is a :ref:`Scr Method Descriptions ------------------- -.. _class_ScriptEditor_can_drop_data_fw: +.. _class_ScriptEditor_method_can_drop_data_fw: - :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** const -.. _class_ScriptEditor_drop_data_fw: +.. _class_ScriptEditor_method_drop_data_fw: - void **drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** -.. _class_ScriptEditor_get_current_script: +.. _class_ScriptEditor_method_get_current_script: - :ref:`Script` **get_current_script** **(** **)** Returns a :ref:`Script` that is currently active in editor. -.. _class_ScriptEditor_get_drag_data_fw: +.. _class_ScriptEditor_method_get_drag_data_fw: - :ref:`Variant` **get_drag_data_fw** **(** :ref:`Vector2` point, :ref:`Control` from **)** -.. _class_ScriptEditor_get_open_scripts: +.. _class_ScriptEditor_method_get_open_scripts: - :ref:`Array` **get_open_scripts** **(** **)** const Returns an array with all :ref:`Script` objects which are currently open in editor. -.. _class_ScriptEditor_open_script_create_dialog: +.. _class_ScriptEditor_method_open_script_create_dialog: - void **open_script_create_dialog** **(** :ref:`String` base_name, :ref:`String` base_path **)** diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 2c6d6d2a6..4a87b33ed 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -21,14 +21,14 @@ Base class for scroll bars. Properties ---------- -+---------------------------+-------------------------------------------------+ -| :ref:`float` | :ref:`custom_step` | -+---------------------------+-------------------------------------------------+ ++---------------------------+----------------------------------------------------------+ +| :ref:`float` | :ref:`custom_step` | ++---------------------------+----------------------------------------------------------+ Signals ------- -.. _class_ScrollBar_scrolling: +.. _class_ScrollBar_signal_scrolling: - **scrolling** **(** **)** @@ -42,7 +42,7 @@ Scrollbars are a :ref:`Range` based :ref:`Control`, Property Descriptions --------------------- -.. _class_ScrollBar_custom_step: +.. _class_ScrollBar_property_custom_step: - :ref:`float` **custom_step** diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 1cac5fd0d..a9bdc2cfb 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -21,44 +21,44 @@ A helper node for displaying scrollable elements (e.g. lists). Properties ---------- -+-------------------------+-----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scroll_deadzone` | -+-------------------------+-----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scroll_horizontal` | -+-------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_horizontal_enabled` | -+-------------------------+-----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scroll_vertical` | -+-------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scroll_vertical_enabled` | -+-------------------------+-----------------------------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`scroll_deadzone` | ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`scroll_horizontal` | ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`scroll_horizontal_enabled` | ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`scroll_vertical` | ++-------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`scroll_vertical_enabled` | ++-------------------------+--------------------------------------------------------------------------------------------+ Methods ------- -+--------------------------------------+---------------------------------------------------------------------------+ -| :ref:`HScrollBar` | :ref:`get_h_scrollbar` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scrollbar` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------+ ++-------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`HScrollBar` | :ref:`get_h_scrollbar` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`VScrollBar` | :ref:`get_v_scrollbar` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | -+---------------------------------+-------------------------------------+ ++---------------------------------+----+ +| :ref:`StyleBox` | bg | ++---------------------------------+----+ Signals ------- -.. _class_ScrollContainer_scroll_ended: +.. _class_ScrollContainer_signal_scroll_ended: - **scroll_ended** **(** **)** Emitted whenever scrolling stops. -.. _class_ScrollContainer_scroll_started: +.. _class_ScrollContainer_signal_scroll_started: - **scroll_started** **(** **)** @@ -72,7 +72,7 @@ A ScrollContainer node with a :ref:`Control` child and scrollbar Property Descriptions --------------------- -.. _class_ScrollContainer_scroll_deadzone: +.. _class_ScrollContainer_property_scroll_deadzone: - :ref:`int` **scroll_deadzone** @@ -82,7 +82,7 @@ Property Descriptions | *Getter* | get_deadzone() | +----------+---------------------+ -.. _class_ScrollContainer_scroll_horizontal: +.. _class_ScrollContainer_property_scroll_horizontal: - :ref:`int` **scroll_horizontal** @@ -94,7 +94,7 @@ Property Descriptions The current horizontal scroll value. -.. _class_ScrollContainer_scroll_horizontal_enabled: +.. _class_ScrollContainer_property_scroll_horizontal_enabled: - :ref:`bool` **scroll_horizontal_enabled** @@ -106,7 +106,7 @@ The current horizontal scroll value. If ``true``, enables horizontal scrolling. -.. _class_ScrollContainer_scroll_vertical: +.. _class_ScrollContainer_property_scroll_vertical: - :ref:`int` **scroll_vertical** @@ -118,7 +118,7 @@ If ``true``, enables horizontal scrolling. The current vertical scroll value. -.. _class_ScrollContainer_scroll_vertical_enabled: +.. _class_ScrollContainer_property_scroll_vertical_enabled: - :ref:`bool` **scroll_vertical_enabled** @@ -133,11 +133,11 @@ If ``true``, enables vertical scrolling. Method Descriptions ------------------- -.. _class_ScrollContainer_get_h_scrollbar: +.. _class_ScrollContainer_method_get_h_scrollbar: - :ref:`HScrollBar` **get_h_scrollbar** **(** **)** -.. _class_ScrollContainer_get_v_scrollbar: +.. _class_ScrollContainer_method_get_v_scrollbar: - :ref:`VScrollBar` **get_v_scrollbar** **(** **)** diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 7402adb50..d87cc8e58 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -19,11 +19,11 @@ Segment shape for 2D collisions. Properties ---------- -+-------------------------------+----------------------------------+ -| :ref:`Vector2` | :ref:`a` | -+-------------------------------+----------------------------------+ -| :ref:`Vector2` | :ref:`b` | -+-------------------------------+----------------------------------+ ++-------------------------------+-------------------------------------------+ +| :ref:`Vector2` | :ref:`a` | ++-------------------------------+-------------------------------------------+ +| :ref:`Vector2` | :ref:`b` | ++-------------------------------+-------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ Segment shape for 2D collisions. Consists of two points, ``a`` and ``b``. Property Descriptions --------------------- -.. _class_SegmentShape2D_a: +.. _class_SegmentShape2D_property_a: - :ref:`Vector2` **a** @@ -45,7 +45,7 @@ Property Descriptions The segment's first point position. -.. _class_SegmentShape2D_b: +.. _class_SegmentShape2D_property_b: - :ref:`Vector2` **b** diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index e09c7d399..461d38151 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -19,11 +19,11 @@ A synchronization Semaphore. Methods ------- -+----------------------------------------+-----------------------------------------------+ -| :ref:`Error` | :ref:`post` **(** **)** | -+----------------------------------------+-----------------------------------------------+ -| :ref:`Error` | :ref:`wait` **(** **)** | -+----------------------------------------+-----------------------------------------------+ ++---------------------------------------+------------------------------------------------------+ +| :ref:`Error` | :ref:`post` **(** **)** | ++---------------------------------------+------------------------------------------------------+ +| :ref:`Error` | :ref:`wait` **(** **)** | ++---------------------------------------+------------------------------------------------------+ Description ----------- @@ -33,13 +33,13 @@ A synchronization Semaphore. Element used to synchronize multiple :ref:`Thread` **post** **(** **)** Lowers the ``Semaphore``, allowing one more thread in. Returns ``OK`` on success, ``ERR_BUSY`` otherwise. -.. _class_Semaphore_wait: +.. _class_Semaphore_method_wait: - :ref:`Error` **wait** **(** **)** diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 8088cca99..cdd3b2c7f 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -21,28 +21,34 @@ A custom shader program. Properties ---------- -+-----------------------------+--------------------------------+ -| :ref:`String` | :ref:`code` | -+-----------------------------+--------------------------------+ ++-----------------------------+-----------------------------------------+ +| :ref:`String` | :ref:`code` | ++-----------------------------+-----------------------------------------+ Methods ------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`get_mode` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`get_mode` **(** **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Shader_Mode: +.. _class_Shader_constant_MODE_SPATIAL: + +.. _class_Shader_constant_MODE_CANVAS_ITEM: + +.. _class_Shader_constant_MODE_PARTICLES: + enum **Mode**: - **MODE_SPATIAL** = **0** @@ -64,7 +70,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Shader_code: +.. _class_Shader_property_code: - :ref:`String` **code** @@ -77,21 +83,21 @@ Property Descriptions Method Descriptions ------------------- -.. _class_Shader_get_default_texture_param: +.. _class_Shader_method_get_default_texture_param: - :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const -.. _class_Shader_get_mode: +.. _class_Shader_method_get_mode: - :ref:`Mode` **get_mode** **(** **)** const Returns the shader mode for the shader, either ``MODE_CANVAS_ITEM``, ``MODE_SPATIAL`` or ``MODE_PARTICLES`` -.. _class_Shader_has_param: +.. _class_Shader_method_has_param: - :ref:`bool` **has_param** **(** :ref:`String` name **)** const -.. _class_Shader_set_default_texture_param: +.. _class_Shader_method_set_default_texture_param: - void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 9f92585b1..726e1a631 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -19,22 +19,22 @@ A material that uses a custom :ref:`Shader` program. Properties ---------- -+-----------------------------+--------------------------------------------+ -| :ref:`Shader` | :ref:`shader` | -+-----------------------------+--------------------------------------------+ ++-----------------------------+-----------------------------------------------------+ +| :ref:`Shader` | :ref:`shader` | ++-----------------------------+-----------------------------------------------------+ Methods ------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -44,7 +44,7 @@ A material that uses a custom :ref:`Shader` program to render eith Property Descriptions --------------------- -.. _class_ShaderMaterial_shader: +.. _class_ShaderMaterial_property_shader: - :ref:`Shader` **shader** @@ -59,21 +59,21 @@ The :ref:`Shader` program used to render this material. Method Descriptions ------------------- -.. _class_ShaderMaterial_get_shader_param: +.. _class_ShaderMaterial_method_get_shader_param: - :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** const Returns the current value set for this material of a uniform in the shader. -.. _class_ShaderMaterial_property_can_revert: +.. _class_ShaderMaterial_method_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** -.. _class_ShaderMaterial_property_get_revert: +.. _class_ShaderMaterial_method_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** -.. _class_ShaderMaterial_set_shader_param: +.. _class_ShaderMaterial_method_set_shader_param: - void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 9e0512df3..40af9c1fd 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -21,9 +21,9 @@ Base class for all 3D shape resources. Properties ---------- -+---------------------------+-----------------------------------+ -| :ref:`float` | :ref:`margin` | -+---------------------------+-----------------------------------+ ++---------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`margin` | ++---------------------------+--------------------------------------------+ Description ----------- @@ -38,7 +38,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Shape_margin: +.. _class_Shape_property_margin: - :ref:`float` **margin** diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 79d1df36a..cc099f9f5 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -21,22 +21,22 @@ Base class for all 2D Shapes. Properties ---------- -+---------------------------+-------------------------------------------------------------+ -| :ref:`float` | :ref:`custom_solver_bias` | -+---------------------------+-------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------+ +| :ref:`float` | :ref:`custom_solver_bias` | ++---------------------------+----------------------------------------------------------------------+ Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collide_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_motion` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`collide_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collide_with_motion` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -51,7 +51,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Shape2D_custom_solver_bias: +.. _class_Shape2D_property_custom_solver_bias: - :ref:`float` **custom_solver_bias** @@ -64,7 +64,7 @@ Property Descriptions Method Descriptions ------------------- -.. _class_Shape2D_collide: +.. _class_Shape2D_method_collide: - :ref:`bool` **collide** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** @@ -72,7 +72,7 @@ Returns ``true`` if this shape is colliding with another. This method needs the transformation matrix for this shape (``local_xform``), the shape to check collisions with (``with_shape``), and the transformation matrix of that shape (``shape_xform``). -.. _class_Shape2D_collide_and_get_contacts: +.. _class_Shape2D_method_collide_and_get_contacts: - :ref:`Variant` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** @@ -80,7 +80,7 @@ Returns a list of the points where this shape touches another. If there are no c This method needs the transformation matrix for this shape (``local_xform``), the shape to check collisions with (``with_shape``), and the transformation matrix of that shape (``shape_xform``). -.. _class_Shape2D_collide_with_motion: +.. _class_Shape2D_method_collide_with_motion: - :ref:`bool` **collide_with_motion** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** @@ -88,7 +88,7 @@ Return whether this shape would collide with another, if a given movement was ap This method needs the transformation matrix for this shape (``local_xform``), the movement to test on this shape (``local_motion``), the shape to check collisions with (``with_shape``), the transformation matrix of that shape (``shape_xform``), and the movement to test onto the other object (``shape_motion``). -.. _class_Shape2D_collide_with_motion_and_get_contacts: +.. _class_Shape2D_method_collide_with_motion_and_get_contacts: - :ref:`Variant` **collide_with_motion_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index a79c7cece..2e3e6ab18 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -19,20 +19,20 @@ A shortcut for binding input. Properties ---------- -+-------------------------------------+------------------------------------------+ -| :ref:`InputEvent` | :ref:`shortcut` | -+-------------------------------------+------------------------------------------+ ++-------------------------------------+---------------------------------------------------+ +| :ref:`InputEvent` | :ref:`shortcut` | ++-------------------------------------+---------------------------------------------------+ 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 | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -44,7 +44,7 @@ Shortcuts are commonly used for interacting with a :ref:`Control` Property Descriptions --------------------- -.. _class_ShortCut_shortcut: +.. _class_ShortCut_property_shortcut: - :ref:`InputEvent` **shortcut** @@ -61,19 +61,19 @@ Generally the :ref:`InputEvent` is a keyboard key, though it c Method Descriptions ------------------- -.. _class_ShortCut_get_as_text: +.. _class_ShortCut_method_get_as_text: - :ref:`String` **get_as_text** **(** **)** const Returns the shortcut's :ref:`InputEvent` as a :ref:`String`. -.. _class_ShortCut_is_shortcut: +.. _class_ShortCut_method_is_shortcut: - :ref:`bool` **is_shortcut** **(** :ref:`InputEvent` event **)** const Returns ``true`` if the shortcut's :ref:`InputEvent` equals ``event``. -.. _class_ShortCut_is_valid: +.. _class_ShortCut_method_is_valid: - :ref:`bool` **is_valid** **(** **)** const diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index 2a0aea462..87a2411ba 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -19,65 +19,67 @@ Skeleton for characters and animated objects. Methods ------- -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bone` **(** :ref:`String` name **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bind_child_node_to_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_bones` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** 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_global_pose` **(** :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:`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_transform` **(** :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 | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_add_collision_exception` **(** :ref:`RID` exception **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_remove_collision_exception` **(** :ref:`RID` exception **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_start_simulation` **(** :ref:`Array` bones=[ ] **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_stop_simulation` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_custom_pose` **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_disable_rest` **(** :ref:`int` bone_idx, :ref:`bool` disable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_global_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_ignore_animation` **(** :ref:`int` bone, :ref:`bool` ignore **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_rest` **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unbind_child_node_from_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unparent_bone_and_rest` **(** :ref:`int` bone_idx **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bone` **(** :ref:`String` name **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bind_child_node_to_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_bones` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** 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_global_pose` **(** :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:`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_transform` **(** :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 | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`physical_bones_add_collision_exception` **(** :ref:`RID` exception **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`physical_bones_remove_collision_exception` **(** :ref:`RID` exception **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`physical_bones_start_simulation` **(** :ref:`Array` bones=[ ] **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`physical_bones_stop_simulation` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_custom_pose` **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_disable_rest` **(** :ref:`int` bone_idx, :ref:`bool` disable **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_global_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_ignore_animation` **(** :ref:`int` bone, :ref:`bool` ignore **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_rest` **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unbind_child_node_from_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unparent_bone_and_rest` **(** :ref:`int` bone_idx **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_Skeleton_constant_NOTIFICATION_UPDATE_SKELETON: + - **NOTIFICATION_UPDATE_SKELETON** = **50** Description @@ -92,145 +94,145 @@ Note that "global pose" below refers to the overall transform of the bone with r Method Descriptions ------------------- -.. _class_Skeleton_add_bone: +.. _class_Skeleton_method_add_bone: - void **add_bone** **(** :ref:`String` name **)** -Add a bone, with name "name". :ref:`get_bone_count` will become the bone index. +Add a bone, with name "name". :ref:`get_bone_count` will become the bone index. -.. _class_Skeleton_bind_child_node_to_bone: +.. _class_Skeleton_method_bind_child_node_to_bone: - void **bind_child_node_to_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. -.. _class_Skeleton_clear_bones: +.. _class_Skeleton_method_clear_bones: - void **clear_bones** **(** **)** Clear all the bones in this skeleton. -.. _class_Skeleton_find_bone: +.. _class_Skeleton_method_find_bone: - :ref:`int` **find_bone** **(** :ref:`String` name **)** const Return the bone index that matches "name" as its name. -.. _class_Skeleton_get_bone_count: +.. _class_Skeleton_method_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const Return the amount of bones in the skeleton. -.. _class_Skeleton_get_bone_custom_pose: +.. _class_Skeleton_method_get_bone_custom_pose: - :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const Return the custom pose of the specified bone. Custom pose is applied on top of the rest pose. -.. _class_Skeleton_get_bone_global_pose: +.. _class_Skeleton_method_get_bone_global_pose: - :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const Return 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. -.. _class_Skeleton_get_bone_name: +.. _class_Skeleton_method_get_bone_name: - :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const Return the name of the bone at index "index". -.. _class_Skeleton_get_bone_parent: +.. _class_Skeleton_method_get_bone_parent: - :ref:`int` **get_bone_parent** **(** :ref:`int` bone_idx **)** const Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". -.. _class_Skeleton_get_bone_pose: +.. _class_Skeleton_method_get_bone_pose: - :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** const Return the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. -.. _class_Skeleton_get_bone_rest: +.. _class_Skeleton_method_get_bone_rest: - :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** const Return the rest transform for a bone "bone_idx". -.. _class_Skeleton_get_bone_transform: +.. _class_Skeleton_method_get_bone_transform: - :ref:`Transform` **get_bone_transform** **(** :ref:`int` bone_idx **)** const Return the combination of custom pose and pose. The returned transform is in skeleton's reference frame. -.. _class_Skeleton_get_bound_child_nodes_to_bone: +.. _class_Skeleton_method_get_bound_child_nodes_to_bone: - :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const Deprecated soon. -.. _class_Skeleton_is_bone_rest_disabled: +.. _class_Skeleton_method_is_bone_rest_disabled: - :ref:`bool` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** const -.. _class_Skeleton_physical_bones_add_collision_exception: +.. _class_Skeleton_method_physical_bones_add_collision_exception: - void **physical_bones_add_collision_exception** **(** :ref:`RID` exception **)** -.. _class_Skeleton_physical_bones_remove_collision_exception: +.. _class_Skeleton_method_physical_bones_remove_collision_exception: - void **physical_bones_remove_collision_exception** **(** :ref:`RID` exception **)** -.. _class_Skeleton_physical_bones_start_simulation: +.. _class_Skeleton_method_physical_bones_start_simulation: - void **physical_bones_start_simulation** **(** :ref:`Array` bones=[ ] **)** -.. _class_Skeleton_physical_bones_stop_simulation: +.. _class_Skeleton_method_physical_bones_stop_simulation: - void **physical_bones_stop_simulation** **(** **)** -.. _class_Skeleton_set_bone_custom_pose: +.. _class_Skeleton_method_set_bone_custom_pose: - void **set_bone_custom_pose** **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** -.. _class_Skeleton_set_bone_disable_rest: +.. _class_Skeleton_method_set_bone_disable_rest: - void **set_bone_disable_rest** **(** :ref:`int` bone_idx, :ref:`bool` disable **)** -.. _class_Skeleton_set_bone_global_pose: +.. _class_Skeleton_method_set_bone_global_pose: - void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** -.. _class_Skeleton_set_bone_ignore_animation: +.. _class_Skeleton_method_set_bone_ignore_animation: - void **set_bone_ignore_animation** **(** :ref:`int` bone, :ref:`bool` ignore **)** -.. _class_Skeleton_set_bone_parent: +.. _class_Skeleton_method_set_bone_parent: - void **set_bone_parent** **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". -.. _class_Skeleton_set_bone_pose: +.. _class_Skeleton_method_set_bone_pose: - void **set_bone_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** Return the pose transform for bone "bone_idx". -.. _class_Skeleton_set_bone_rest: +.. _class_Skeleton_method_set_bone_rest: - void **set_bone_rest** **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** Set the rest transform for bone "bone_idx" -.. _class_Skeleton_unbind_child_node_from_bone: +.. _class_Skeleton_method_unbind_child_node_from_bone: - void **unbind_child_node_from_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. -.. _class_Skeleton_unparent_bone_and_rest: +.. _class_Skeleton_method_unparent_bone_and_rest: - void **unparent_bone_and_rest** **(** :ref:`int` bone_idx **)** diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index f868f770f..681fefaed 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -19,26 +19,26 @@ Brief Description Methods ------- -+------------------------------+----------------------------------------------------------------------------------+ -| :ref:`Bone2D` | :ref:`get_bone` **(** :ref:`int` idx **)** | -+------------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_count` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_skeleton` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`Bone2D` | :ref:`get_bone` **(** :ref:`int` idx **)** | ++-----------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_count` **(** **)** const | ++-----------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_skeleton` **(** **)** const | ++-----------------------------+-----------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_Skeleton2D_get_bone: +.. _class_Skeleton2D_method_get_bone: - :ref:`Bone2D` **get_bone** **(** :ref:`int` idx **)** -.. _class_Skeleton2D_get_bone_count: +.. _class_Skeleton2D_method_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const -.. _class_Skeleton2D_get_skeleton: +.. _class_Skeleton2D_method_get_skeleton: - :ref:`RID` **get_skeleton** **(** **)** const diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index e1e2c3a1b..86a8b19cb 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -19,45 +19,45 @@ Brief Description Properties ---------- -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolation` | -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`magnet` | -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`max_iterations` | -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`min_distance` | -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`override_tip_basis` | -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`String` | :ref:`root_bone` | -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`Transform` | :ref:`target` | -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`target_node` | -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`String` | :ref:`tip_bone` | -+-----------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_magnet` | -+-----------------------------------+----------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolation` | ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`magnet` | ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`int` | :ref:`max_iterations` | ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`float` | :ref:`min_distance` | ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`override_tip_basis` | ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`String` | :ref:`root_bone` | ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`target` | ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`target_node` | ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tip_bone` | ++-----------------------------------+-------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_magnet` | ++-----------------------------------+-------------------------------------------------------------------------+ Methods ------- -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Skeleton` | :ref:`get_parent_skeleton` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_running` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| void | :ref:`start` **(** :ref:`bool` one_time=false **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------+ ++---------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`Skeleton` | :ref:`get_parent_skeleton` **(** **)** const | ++---------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_running` **(** **)** | ++---------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`start` **(** :ref:`bool` one_time=false **)** | ++---------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++---------------------------------+------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_SkeletonIK_interpolation: +.. _class_SkeletonIK_property_interpolation: - :ref:`float` **interpolation** @@ -67,7 +67,7 @@ Property Descriptions | *Getter* | get_interpolation() | +----------+--------------------------+ -.. _class_SkeletonIK_magnet: +.. _class_SkeletonIK_property_magnet: - :ref:`Vector3` **magnet** @@ -77,7 +77,7 @@ Property Descriptions | *Getter* | get_magnet_position() | +----------+----------------------------+ -.. _class_SkeletonIK_max_iterations: +.. _class_SkeletonIK_property_max_iterations: - :ref:`int` **max_iterations** @@ -87,7 +87,7 @@ Property Descriptions | *Getter* | get_max_iterations() | +----------+---------------------------+ -.. _class_SkeletonIK_min_distance: +.. _class_SkeletonIK_property_min_distance: - :ref:`float` **min_distance** @@ -97,7 +97,7 @@ Property Descriptions | *Getter* | get_min_distance() | +----------+-------------------------+ -.. _class_SkeletonIK_override_tip_basis: +.. _class_SkeletonIK_property_override_tip_basis: - :ref:`bool` **override_tip_basis** @@ -107,7 +107,7 @@ Property Descriptions | *Getter* | is_override_tip_basis() | +----------+-------------------------------+ -.. _class_SkeletonIK_root_bone: +.. _class_SkeletonIK_property_root_bone: - :ref:`String` **root_bone** @@ -117,7 +117,7 @@ Property Descriptions | *Getter* | get_root_bone() | +----------+----------------------+ -.. _class_SkeletonIK_target: +.. _class_SkeletonIK_property_target: - :ref:`Transform` **target** @@ -127,7 +127,7 @@ Property Descriptions | *Getter* | get_target_transform() | +----------+-----------------------------+ -.. _class_SkeletonIK_target_node: +.. _class_SkeletonIK_property_target_node: - :ref:`NodePath` **target_node** @@ -137,7 +137,7 @@ Property Descriptions | *Getter* | get_target_node() | +----------+------------------------+ -.. _class_SkeletonIK_tip_bone: +.. _class_SkeletonIK_property_tip_bone: - :ref:`String` **tip_bone** @@ -147,7 +147,7 @@ Property Descriptions | *Getter* | get_tip_bone() | +----------+---------------------+ -.. _class_SkeletonIK_use_magnet: +.. _class_SkeletonIK_property_use_magnet: - :ref:`bool` **use_magnet** @@ -160,19 +160,19 @@ Property Descriptions Method Descriptions ------------------- -.. _class_SkeletonIK_get_parent_skeleton: +.. _class_SkeletonIK_method_get_parent_skeleton: - :ref:`Skeleton` **get_parent_skeleton** **(** **)** const -.. _class_SkeletonIK_is_running: +.. _class_SkeletonIK_method_is_running: - :ref:`bool` **is_running** **(** **)** -.. _class_SkeletonIK_start: +.. _class_SkeletonIK_method_start: - void **start** **(** :ref:`bool` one_time=false **)** -.. _class_SkeletonIK_stop: +.. _class_SkeletonIK_method_stop: - void **stop** **(** **)** diff --git a/classes/class_sky.rst b/classes/class_sky.rst index cff994e74..c449bd463 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -21,15 +21,31 @@ The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky Properties ---------- -+--------------------------------------------+-----------------------------------------------+ -| :ref:`RadianceSize` | :ref:`radiance_size` | -+--------------------------------------------+-----------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------+ +| :ref:`RadianceSize` | :ref:`radiance_size` | ++--------------------------------------------+--------------------------------------------------------+ Enumerations ------------ .. _enum_Sky_RadianceSize: +.. _class_Sky_constant_RADIANCE_SIZE_32: + +.. _class_Sky_constant_RADIANCE_SIZE_64: + +.. _class_Sky_constant_RADIANCE_SIZE_128: + +.. _class_Sky_constant_RADIANCE_SIZE_256: + +.. _class_Sky_constant_RADIANCE_SIZE_512: + +.. _class_Sky_constant_RADIANCE_SIZE_1024: + +.. _class_Sky_constant_RADIANCE_SIZE_2048: + +.. _class_Sky_constant_RADIANCE_SIZE_MAX: + enum **RadianceSize**: - **RADIANCE_SIZE_32** = **0** --- Radiance texture size is 32x32 pixels. @@ -56,7 +72,7 @@ The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky Property Descriptions --------------------- -.. _class_Sky_radiance_size: +.. _class_Sky_property_radiance_size: - :ref:`RadianceSize` **radiance_size** diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 3beafc36e..71f7ba8f8 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -21,17 +21,17 @@ Base class for GUI Sliders. Properties ---------- -+------------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`editable` | -+------------------------------------------+--------------------------------------------------------+ -| :ref:`FocusMode` | :ref:`focus_mode` | -+------------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`scrollable` | -+------------------------------------------+--------------------------------------------------------+ -| :ref:`int` | :ref:`tick_count` | -+------------------------------------------+--------------------------------------------------------+ -| :ref:`bool` | :ref:`ticks_on_borders` | -+------------------------------------------+--------------------------------------------------------+ ++------------------------------------------+-----------------------------------------------------------------+ +| :ref:`bool` | :ref:`editable` | ++------------------------------------------+-----------------------------------------------------------------+ +| :ref:`FocusMode` | :ref:`focus_mode` | ++------------------------------------------+-----------------------------------------------------------------+ +| :ref:`bool` | :ref:`scrollable` | ++------------------------------------------+-----------------------------------------------------------------+ +| :ref:`int` | :ref:`tick_count` | ++------------------------------------------+-----------------------------------------------------------------+ +| :ref:`bool` | :ref:`ticks_on_borders` | ++------------------------------------------+-----------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ Base class for GUI Sliders. Property Descriptions --------------------- -.. _class_Slider_editable: +.. _class_Slider_property_editable: - :ref:`bool` **editable** @@ -51,7 +51,7 @@ Property Descriptions | *Getter* | is_editable() | +----------+---------------------+ -.. _class_Slider_focus_mode: +.. _class_Slider_property_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -61,7 +61,7 @@ Property Descriptions | *Getter* | get_focus_mode() | +----------+-----------------------+ -.. _class_Slider_scrollable: +.. _class_Slider_property_scrollable: - :ref:`bool` **scrollable** @@ -71,7 +71,7 @@ Property Descriptions | *Getter* | is_scrollable() | +----------+-----------------------+ -.. _class_Slider_tick_count: +.. _class_Slider_property_tick_count: - :ref:`int` **tick_count** @@ -81,7 +81,7 @@ Property Descriptions | *Getter* | get_ticks() | +----------+------------------+ -.. _class_Slider_ticks_on_borders: +.. _class_Slider_property_ticks_on_borders: - :ref:`bool` **ticks_on_borders** diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 62d354ec8..94473db04 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -19,57 +19,103 @@ Piston kind of slider between two bodies in 3D. Properties ---------- -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/damping` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/lower_angle` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/restitution` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/softness` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_limit/upper_angle` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motion/damping` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motion/restitution` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_motion/softness` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_ortho/damping` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_ortho/restitution` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angular_ortho/softness` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/damping` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/lower_distance` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/restitution` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/softness` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_limit/upper_distance` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motion/damping` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motion/restitution` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_motion/softness` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_ortho/damping` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_ortho/restitution` | -+---------------------------+-----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_ortho/softness` | -+---------------------------+-----------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/damping` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/lower_angle` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/restitution` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/softness` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_limit/upper_angle` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_motion/damping` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_motion/restitution` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_motion/softness` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_ortho/damping` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_ortho/restitution` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_ortho/softness` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit/damping` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit/lower_distance` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit/restitution` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit/softness` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_limit/upper_distance` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_motion/damping` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_motion/restitution` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_motion/softness` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_ortho/damping` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_ortho/restitution` | ++---------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_ortho/softness` | ++---------------------------+--------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_SliderJoint_Param: +.. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_UPPER: + +.. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_LOWER: + +.. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_SOFTNESS: + +.. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_RESTITUTION: + +.. _class_SliderJoint_constant_PARAM_LINEAR_LIMIT_DAMPING: + +.. _class_SliderJoint_constant_PARAM_LINEAR_MOTION_SOFTNESS: + +.. _class_SliderJoint_constant_PARAM_LINEAR_MOTION_RESTITUTION: + +.. _class_SliderJoint_constant_PARAM_LINEAR_MOTION_DAMPING: + +.. _class_SliderJoint_constant_PARAM_LINEAR_ORTHOGONAL_SOFTNESS: + +.. _class_SliderJoint_constant_PARAM_LINEAR_ORTHOGONAL_RESTITUTION: + +.. _class_SliderJoint_constant_PARAM_LINEAR_ORTHOGONAL_DAMPING: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_UPPER: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_LOWER: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_SOFTNESS: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_RESTITUTION: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_LIMIT_DAMPING: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_MOTION_SOFTNESS: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_MOTION_RESTITUTION: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_MOTION_DAMPING: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_ORTHOGONAL_SOFTNESS: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_ORTHOGONAL_RESTITUTION: + +.. _class_SliderJoint_constant_PARAM_ANGULAR_ORTHOGONAL_DAMPING: + +.. _class_SliderJoint_constant_PARAM_MAX: + enum **Param**: - **PARAM_LINEAR_LIMIT_UPPER** = **0** --- The maximum difference between the pivot points on their x-axis before damping happens. @@ -126,7 +172,7 @@ Slides across the x-axis of the pivot object. Property Descriptions --------------------- -.. _class_SliderJoint_angular_limit/damping: +.. _class_SliderJoint_property_angular_limit/damping: - :ref:`float` **angular_limit/damping** @@ -140,13 +186,13 @@ The amount of damping of the rotation when the limit is surpassed. A lower damping value allows a rotation initiated by body A to travel to body B slower. -.. _class_SliderJoint_angular_limit/lower_angle: +.. _class_SliderJoint_property_angular_limit/lower_angle: - :ref:`float` **angular_limit/lower_angle** The lower limit of rotation in the slider. -.. _class_SliderJoint_angular_limit/restitution: +.. _class_SliderJoint_property_angular_limit/restitution: - :ref:`float` **angular_limit/restitution** @@ -160,7 +206,7 @@ The amount of restitution of the rotation when the limit is surpassed. Does not affect damping. -.. _class_SliderJoint_angular_limit/softness: +.. _class_SliderJoint_property_angular_limit/softness: - :ref:`float` **angular_limit/softness** @@ -174,13 +220,13 @@ A factor applied to the all rotation once the limit is surpassed. Makes all rotation slower when between 0 and 1. -.. _class_SliderJoint_angular_limit/upper_angle: +.. _class_SliderJoint_property_angular_limit/upper_angle: - :ref:`float` **angular_limit/upper_angle** The upper limit of rotation in the slider. -.. _class_SliderJoint_angular_motion/damping: +.. _class_SliderJoint_property_angular_motion/damping: - :ref:`float` **angular_motion/damping** @@ -192,7 +238,7 @@ The upper limit of rotation in the slider. The amount of damping of the rotation in the limits. -.. _class_SliderJoint_angular_motion/restitution: +.. _class_SliderJoint_property_angular_motion/restitution: - :ref:`float` **angular_motion/restitution** @@ -204,7 +250,7 @@ The amount of damping of the rotation in the limits. The amount of restitution of the rotation in the limits. -.. _class_SliderJoint_angular_motion/softness: +.. _class_SliderJoint_property_angular_motion/softness: - :ref:`float` **angular_motion/softness** @@ -216,7 +262,7 @@ The amount of restitution of the rotation in the limits. A factor applied to the all rotation in the limits. -.. _class_SliderJoint_angular_ortho/damping: +.. _class_SliderJoint_property_angular_ortho/damping: - :ref:`float` **angular_ortho/damping** @@ -228,7 +274,7 @@ A factor applied to the all rotation in the limits. The amount of damping of the rotation across axes orthogonal to the slider. -.. _class_SliderJoint_angular_ortho/restitution: +.. _class_SliderJoint_property_angular_ortho/restitution: - :ref:`float` **angular_ortho/restitution** @@ -240,7 +286,7 @@ The amount of damping of the rotation across axes orthogonal to the slider. The amount of restitution of the rotation across axes orthogonal to the slider. -.. _class_SliderJoint_angular_ortho/softness: +.. _class_SliderJoint_property_angular_ortho/softness: - :ref:`float` **angular_ortho/softness** @@ -252,7 +298,7 @@ The amount of restitution of the rotation across axes orthogonal to the slider. A factor applied to the all rotation across axes orthogonal to the slider. -.. _class_SliderJoint_linear_limit/damping: +.. _class_SliderJoint_property_linear_limit/damping: - :ref:`float` **linear_limit/damping** @@ -262,9 +308,9 @@ A factor applied to the all rotation across axes orthogonal to the slider. | *Getter* | get_param() | +----------+------------------+ -The amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance` and :ref:`linear_limit/upper_distance` is surpassed. +The amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance` and :ref:`linear_limit/upper_distance` is surpassed. -.. _class_SliderJoint_linear_limit/lower_distance: +.. _class_SliderJoint_property_linear_limit/lower_distance: - :ref:`float` **linear_limit/lower_distance** @@ -276,7 +322,7 @@ The amount of damping that happens once the limit defined by :ref:`linear_limit/ The minimum difference between the pivot points on their x-axis before damping happens. -.. _class_SliderJoint_linear_limit/restitution: +.. _class_SliderJoint_property_linear_limit/restitution: - :ref:`float` **linear_limit/restitution** @@ -288,7 +334,7 @@ The minimum difference between the pivot points on their x-axis before damping h The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. -.. _class_SliderJoint_linear_limit/softness: +.. _class_SliderJoint_property_linear_limit/softness: - :ref:`float` **linear_limit/softness** @@ -300,7 +346,7 @@ The amount of restitution once the limits are surpassed. The lower, the more vel A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. -.. _class_SliderJoint_linear_limit/upper_distance: +.. _class_SliderJoint_property_linear_limit/upper_distance: - :ref:`float` **linear_limit/upper_distance** @@ -312,7 +358,7 @@ A factor applied to the movement across the slider axis once the limits get surp The maximum difference between the pivot points on their x-axis before damping happens. -.. _class_SliderJoint_linear_motion/damping: +.. _class_SliderJoint_property_linear_motion/damping: - :ref:`float` **linear_motion/damping** @@ -324,7 +370,7 @@ The maximum difference between the pivot points on their x-axis before damping h The amount of damping inside the slider limits. -.. _class_SliderJoint_linear_motion/restitution: +.. _class_SliderJoint_property_linear_motion/restitution: - :ref:`float` **linear_motion/restitution** @@ -336,7 +382,7 @@ The amount of damping inside the slider limits. The amount of restitution inside the slider limits. -.. _class_SliderJoint_linear_motion/softness: +.. _class_SliderJoint_property_linear_motion/softness: - :ref:`float` **linear_motion/softness** @@ -348,7 +394,7 @@ The amount of restitution inside the slider limits. A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. -.. _class_SliderJoint_linear_ortho/damping: +.. _class_SliderJoint_property_linear_ortho/damping: - :ref:`float` **linear_ortho/damping** @@ -360,7 +406,7 @@ A factor applied to the movement across the slider axis as long as the slider is The amount of damping when movement is across axes orthogonal to the slider. -.. _class_SliderJoint_linear_ortho/restitution: +.. _class_SliderJoint_property_linear_ortho/restitution: - :ref:`float` **linear_ortho/restitution** @@ -372,7 +418,7 @@ The amount of damping when movement is across axes orthogonal to the slider. The amount of restitution when movement is across axes orthogonal to the slider. -.. _class_SliderJoint_linear_ortho/softness: +.. _class_SliderJoint_property_linear_ortho/softness: - :ref:`float` **linear_ortho/softness** diff --git a/classes/class_softbody.rst b/classes/class_softbody.rst index a1b66e7ac..ecf8edcfa 100644 --- a/classes/class_softbody.rst +++ b/classes/class_softbody.rst @@ -19,54 +19,54 @@ A soft mesh physics body. Properties ---------- -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`areaAngular_stiffness` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_coefficient` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`drag_coefficient` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear_stiffness` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`parent_collision_ignore` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pose_matching_coefficient` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pressure_coefficient` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`simulation_precision` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`total_mass` | -+---------------------------------+----------------------------------------------------------------------------+ -| :ref:`float` | :ref:`volume_stiffness` | -+---------------------------------+----------------------------------------------------------------------------+ ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`areaAngular_stiffness` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping_coefficient` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`drag_coefficient` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear_stiffness` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`parent_collision_ignore` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pose_matching_coefficient` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pressure_coefficient` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`simulation_precision` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_mass` | ++---------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`volume_stiffness` | ++---------------------------------+-------------------------------------------------------------------------------------+ Methods ------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`is_ray_pickable` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`is_ray_pickable` **(** **)** const | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -76,7 +76,7 @@ A deformable physics body. Used to create elastic or deformable objects such as Property Descriptions --------------------- -.. _class_SoftBody_areaAngular_stiffness: +.. _class_SoftBody_property_areaAngular_stiffness: - :ref:`float` **areaAngular_stiffness** @@ -86,7 +86,7 @@ Property Descriptions | *Getter* | get_areaAngular_stiffness() | +----------+----------------------------------+ -.. _class_SoftBody_collision_layer: +.. _class_SoftBody_property_collision_layer: - :ref:`int` **collision_layer** @@ -102,7 +102,7 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. -.. _class_SoftBody_collision_mask: +.. _class_SoftBody_property_collision_mask: - :ref:`int` **collision_mask** @@ -114,7 +114,7 @@ A contact is detected if object A is in any of the layers that object B scans, o The physics layers this area scans for collisions. -.. _class_SoftBody_damping_coefficient: +.. _class_SoftBody_property_damping_coefficient: - :ref:`float` **damping_coefficient** @@ -124,7 +124,7 @@ The physics layers this area scans for collisions. | *Getter* | get_damping_coefficient() | +----------+--------------------------------+ -.. _class_SoftBody_drag_coefficient: +.. _class_SoftBody_property_drag_coefficient: - :ref:`float` **drag_coefficient** @@ -134,7 +134,7 @@ The physics layers this area scans for collisions. | *Getter* | get_drag_coefficient() | +----------+-----------------------------+ -.. _class_SoftBody_linear_stiffness: +.. _class_SoftBody_property_linear_stiffness: - :ref:`float` **linear_stiffness** @@ -144,7 +144,7 @@ The physics layers this area scans for collisions. | *Getter* | get_linear_stiffness() | +----------+-----------------------------+ -.. _class_SoftBody_parent_collision_ignore: +.. _class_SoftBody_property_parent_collision_ignore: - :ref:`NodePath` **parent_collision_ignore** @@ -154,7 +154,7 @@ The physics layers this area scans for collisions. | *Getter* | get_parent_collision_ignore() | +----------+------------------------------------+ -.. _class_SoftBody_pose_matching_coefficient: +.. _class_SoftBody_property_pose_matching_coefficient: - :ref:`float` **pose_matching_coefficient** @@ -164,7 +164,7 @@ The physics layers this area scans for collisions. | *Getter* | get_pose_matching_coefficient() | +----------+--------------------------------------+ -.. _class_SoftBody_pressure_coefficient: +.. _class_SoftBody_property_pressure_coefficient: - :ref:`float` **pressure_coefficient** @@ -174,7 +174,7 @@ The physics layers this area scans for collisions. | *Getter* | get_pressure_coefficient() | +----------+---------------------------------+ -.. _class_SoftBody_simulation_precision: +.. _class_SoftBody_property_simulation_precision: - :ref:`int` **simulation_precision** @@ -186,7 +186,7 @@ The physics layers this area scans for collisions. Increasing this value will improve the resulting simulation, but can affect performance. Use with care. -.. _class_SoftBody_total_mass: +.. _class_SoftBody_property_total_mass: - :ref:`float` **total_mass** @@ -196,7 +196,7 @@ Increasing this value will improve the resulting simulation, but can affect perf | *Getter* | get_total_mass() | +----------+-----------------------+ -.. _class_SoftBody_volume_stiffness: +.. _class_SoftBody_property_volume_stiffness: - :ref:`float` **volume_stiffness** @@ -209,53 +209,53 @@ Increasing this value will improve the resulting simulation, but can affect perf Method Descriptions ------------------- -.. _class_SoftBody_add_collision_exception_with: +.. _class_SoftBody_method_add_collision_exception_with: - void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. -.. _class_SoftBody_get_collision_exceptions: +.. _class_SoftBody_method_get_collision_exceptions: - :ref:`Array` **get_collision_exceptions** **(** **)** Returns an array of nodes that were added as collision exceptions for this body. -.. _class_SoftBody_get_collision_layer_bit: +.. _class_SoftBody_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. -.. _class_SoftBody_get_collision_mask_bit: +.. _class_SoftBody_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. -.. _class_SoftBody_is_ray_pickable: +.. _class_SoftBody_method_is_ray_pickable: - :ref:`bool` **is_ray_pickable** **(** **)** const -.. _class_SoftBody_remove_collision_exception_with: +.. _class_SoftBody_method_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. -.. _class_SoftBody_set_collision_layer_bit: +.. _class_SoftBody_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. -.. _class_SoftBody_set_collision_mask_bit: +.. _class_SoftBody_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the collision mask. Use this if you only need to change one layer's value. -.. _class_SoftBody_set_ray_pickable: +.. _class_SoftBody_method_set_ray_pickable: - void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 97915febf..f2784ca9c 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -21,99 +21,99 @@ Most basic 3D game object, parent of all 3D related nodes. Properties ---------- -+-----------------------------------------+---------------------------------------------------------+ -| :ref:`SpatialGizmo` | :ref:`gizmo` | -+-----------------------------------------+---------------------------------------------------------+ -| :ref:`Transform` | :ref:`global_transform` | -+-----------------------------------------+---------------------------------------------------------+ -| :ref:`Vector3` | :ref:`rotation` | -+-----------------------------------------+---------------------------------------------------------+ -| :ref:`Vector3` | :ref:`rotation_degrees` | -+-----------------------------------------+---------------------------------------------------------+ -| :ref:`Vector3` | :ref:`scale` | -+-----------------------------------------+---------------------------------------------------------+ -| :ref:`Transform` | :ref:`transform` | -+-----------------------------------------+---------------------------------------------------------+ -| :ref:`Vector3` | :ref:`translation` | -+-----------------------------------------+---------------------------------------------------------+ -| :ref:`bool` | :ref:`visible` | -+-----------------------------------------+---------------------------------------------------------+ ++-----------------------------------------+------------------------------------------------------------------+ +| :ref:`SpatialGizmo` | :ref:`gizmo` | ++-----------------------------------------+------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`global_transform` | ++-----------------------------------------+------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`rotation` | ++-----------------------------------------+------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`rotation_degrees` | ++-----------------------------------------+------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`scale` | ++-----------------------------------------+------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`transform` | ++-----------------------------------------+------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`translation` | ++-----------------------------------------+------------------------------------------------------------------+ +| :ref:`bool` | :ref:`visible` | ++-----------------------------------------+------------------------------------------------------------------+ Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_update_transform` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_scale` **(** :ref:`Vector3` scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_translate` **(** :ref:`Vector3` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scale_disabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at_from_position` **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`orthonormalize` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_object_local` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_x` **(** :ref:`float` angle **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_y` **(** :ref:`float` angle **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_z` **(** :ref:`float` angle **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scale_object_local` **(** :ref:`Vector3` scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_scale` **(** :ref:`bool` disable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_identity` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate` **(** :ref:`Vector3` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate_object_local` **(** :ref:`Vector3` offset **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_gizmo` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_update_transform` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`get_world` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_scale` **(** :ref:`Vector3` scale **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_translate` **(** :ref:`Vector3` offset **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scale_disabled` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at_from_position` **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`orthonormalize` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_object_local` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_x` **(** :ref:`float` angle **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_y` **(** :ref:`float` angle **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_z` **(** :ref:`float` angle **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scale_object_local` **(** :ref:`Vector3` scale **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_scale` **(** :ref:`bool` disable **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_identity` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`translate` **(** :ref:`Vector3` offset **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`translate_object_local` **(** :ref:`Vector3` offset **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_gizmo` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Spatial_visibility_changed: +.. _class_Spatial_signal_visibility_changed: - **visibility_changed** **(** **)** @@ -122,9 +122,17 @@ Emitted when node visibility changes. Constants --------- +.. _class_Spatial_constant_NOTIFICATION_TRANSFORM_CHANGED: + +.. _class_Spatial_constant_NOTIFICATION_ENTER_WORLD: + +.. _class_Spatial_constant_NOTIFICATION_EXIT_WORLD: + +.. _class_Spatial_constant_NOTIFICATION_VISIBILITY_CHANGED: + - **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform. -In order for ``NOTIFICATION_TRANSFORM_CHANGED`` to work, users first need to ask for it, with :ref:`set_notify_transform`. +In order for ``NOTIFICATION_TRANSFORM_CHANGED`` to work, users first need to ask for it, with :ref:`set_notify_transform`. - **NOTIFICATION_ENTER_WORLD** = **41** --- Spatial nodes receives this notification when they are registered to new :ref:`World` resource. @@ -147,7 +155,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Spatial_gizmo: +.. _class_Spatial_property_gizmo: - :ref:`SpatialGizmo` **gizmo** @@ -159,7 +167,7 @@ Property Descriptions The :ref:`SpatialGizmo` for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. -.. _class_Spatial_global_transform: +.. _class_Spatial_property_global_transform: - :ref:`Transform` **global_transform** @@ -171,7 +179,7 @@ The :ref:`SpatialGizmo` for this node. Used for example in : World space (global) :ref:`Transform` of this node. -.. _class_Spatial_rotation: +.. _class_Spatial_property_rotation: - :ref:`Vector3` **rotation** @@ -185,7 +193,7 @@ Rotation part of the local transformation in radians, specified in terms of YXZ- Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3` data structure not because the rotation is a vector, but only because :ref:`Vector3` exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. -.. _class_Spatial_rotation_degrees: +.. _class_Spatial_property_rotation_degrees: - :ref:`Vector3` **rotation_degrees** @@ -197,7 +205,7 @@ Note that in the mathematical sense, rotation is a matrix and not a vector. The Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). -.. _class_Spatial_scale: +.. _class_Spatial_property_scale: - :ref:`Vector3` **scale** @@ -209,7 +217,7 @@ Rotation part of the local transformation in degrees, specified in terms of YXZ- Scale part of the local transformation. -.. _class_Spatial_transform: +.. _class_Spatial_property_transform: - :ref:`Transform` **transform** @@ -221,7 +229,7 @@ Scale part of the local transformation. Local space :ref:`Transform` of this node, with respect to the parent node. -.. _class_Spatial_translation: +.. _class_Spatial_property_translation: - :ref:`Vector3` **translation** @@ -233,7 +241,7 @@ Local space :ref:`Transform` of this node, with respect to the Local translation of this node. -.. _class_Spatial_visible: +.. _class_Spatial_property_visible: - :ref:`bool` **visible** @@ -248,73 +256,73 @@ If ``true``, this node is drawn. Default value: ``true``. Method Descriptions ------------------- -.. _class_Spatial_force_update_transform: +.. _class_Spatial_method_force_update_transform: - void **force_update_transform** **(** **)** -.. _class_Spatial_get_parent_spatial: +.. _class_Spatial_method_get_parent_spatial: - :ref:`Spatial` **get_parent_spatial** **(** **)** const Returns the parent ``Spatial``, or an empty :ref:`Object` if no parent exists or parent is not of type ``Spatial``. -.. _class_Spatial_get_world: +.. _class_Spatial_method_get_world: - :ref:`World` **get_world** **(** **)** const Returns the current :ref:`World` resource this ``Spatial`` node is registered to. -.. _class_Spatial_global_rotate: +.. _class_Spatial_method_global_rotate: - void **global_rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Rotates the global (world) transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in global coordinate system. -.. _class_Spatial_global_scale: +.. _class_Spatial_method_global_scale: - void **global_scale** **(** :ref:`Vector3` scale **)** -.. _class_Spatial_global_translate: +.. _class_Spatial_method_global_translate: - void **global_translate** **(** :ref:`Vector3` offset **)** Moves the global (world) transformation by :ref:`Vector3` offset. The offset is in global coordinate system. -.. _class_Spatial_hide: +.. _class_Spatial_method_hide: - void **hide** **(** **)** -Disables rendering of this node. Changes :ref:`visible` to ``false``. +Disables rendering of this node. Changes :ref:`visible` to ``false``. -.. _class_Spatial_is_local_transform_notification_enabled: +.. _class_Spatial_method_is_local_transform_notification_enabled: - :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const Returns whether node notifies about its local transformation changes. ``Spatial`` will not propagate this by default. -.. _class_Spatial_is_scale_disabled: +.. _class_Spatial_method_is_scale_disabled: - :ref:`bool` **is_scale_disabled** **(** **)** const -.. _class_Spatial_is_set_as_toplevel: +.. _class_Spatial_method_is_set_as_toplevel: - :ref:`bool` **is_set_as_toplevel** **(** **)** const Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations. -.. _class_Spatial_is_transform_notification_enabled: +.. _class_Spatial_method_is_transform_notification_enabled: - :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. -.. _class_Spatial_is_visible_in_tree: +.. _class_Spatial_method_is_visible_in_tree: - :ref:`bool` **is_visible_in_tree** **(** **)** const Returns whether the node is visible, taking into consideration that its parents visibility. -.. _class_Spatial_look_at: +.. _class_Spatial_method_look_at: - void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** @@ -324,117 +332,117 @@ The transform will first be rotated around the given ``up`` vector, and then ful Operations take place in global space. -.. _class_Spatial_look_at_from_position: +.. _class_Spatial_method_look_at_from_position: - void **look_at_from_position** **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** -Moves the node to the specified ``position``, and then rotates itself to point toward the ``target`` as per :ref:`look_at`. Operations take place in global space. +Moves the node to the specified ``position``, and then rotates itself to point toward the ``target`` as per :ref:`look_at`. Operations take place in global space. -.. _class_Spatial_orthonormalize: +.. _class_Spatial_method_orthonormalize: - void **orthonormalize** **(** **)** Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's :ref:`Transform`. -.. _class_Spatial_rotate: +.. _class_Spatial_method_rotate: - void **rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. -.. _class_Spatial_rotate_object_local: +.. _class_Spatial_method_rotate_object_local: - void **rotate_object_local** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in object-local coordinate system. -.. _class_Spatial_rotate_x: +.. _class_Spatial_method_rotate_x: - void **rotate_x** **(** :ref:`float` angle **)** Rotates the local transformation around the X axis by angle in radians -.. _class_Spatial_rotate_y: +.. _class_Spatial_method_rotate_y: - void **rotate_y** **(** :ref:`float` angle **)** Rotates the local transformation around the Y axis by angle in radians. -.. _class_Spatial_rotate_z: +.. _class_Spatial_method_rotate_z: - void **rotate_z** **(** :ref:`float` angle **)** Rotates the local transformation around the Z axis by angle in radians. -.. _class_Spatial_scale_object_local: +.. _class_Spatial_method_scale_object_local: - void **scale_object_local** **(** :ref:`Vector3` scale **)** Scales the local transformation by given 3D scale factors in object-local coordinate system. -.. _class_Spatial_set_as_toplevel: +.. _class_Spatial_method_set_as_toplevel: - void **set_as_toplevel** **(** :ref:`bool` enable **)** Makes the node ignore its parents transformations. Node transformations are only in global space. -.. _class_Spatial_set_disable_scale: +.. _class_Spatial_method_set_disable_scale: - void **set_disable_scale** **(** :ref:`bool` disable **)** -.. _class_Spatial_set_identity: +.. _class_Spatial_method_set_identity: - void **set_identity** **(** **)** Reset all transformations for this node. Set its :ref:`Transform` to identity matrix. -.. _class_Spatial_set_ignore_transform_notification: +.. _class_Spatial_method_set_ignore_transform_notification: - void **set_ignore_transform_notification** **(** :ref:`bool` enabled **)** Set whether the node ignores notification that its transformation (global or local) changed. -.. _class_Spatial_set_notify_local_transform: +.. _class_Spatial_method_set_notify_local_transform: - void **set_notify_local_transform** **(** :ref:`bool` enable **)** Set whether the node notifies about its local transformation changes. ``Spatial`` will not propagate this by default. -.. _class_Spatial_set_notify_transform: +.. _class_Spatial_method_set_notify_transform: - void **set_notify_transform** **(** :ref:`bool` enable **)** Set whether the node notifies about its global and local transformation changes. ``Spatial`` will not propagate this by default. -.. _class_Spatial_show: +.. _class_Spatial_method_show: - void **show** **(** **)** -Enables rendering of this node. Changes :ref:`visible` to ``true``. +Enables rendering of this node. Changes :ref:`visible` to ``true``. -.. _class_Spatial_to_global: +.. _class_Spatial_method_to_global: - :ref:`Vector3` **to_global** **(** :ref:`Vector3` local_point **)** const Transforms :ref:`Vector3` "local_point" from this node's local space to world space. -.. _class_Spatial_to_local: +.. _class_Spatial_method_to_local: - :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** const Transforms :ref:`Vector3` "global_point" from world space to this node's local space. -.. _class_Spatial_translate: +.. _class_Spatial_method_translate: - void **translate** **(** :ref:`Vector3` offset **)** Changes the node's position by given offset :ref:`Vector3`. -.. _class_Spatial_translate_object_local: +.. _class_Spatial_method_translate_object_local: - void **translate_object_local** **(** :ref:`Vector3` offset **)** -.. _class_Spatial_update_gizmo: +.. _class_Spatial_method_update_gizmo: - void **update_gizmo** **(** **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 64bfc1928..6039a45a6 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -19,213 +19,247 @@ Default 3D rendering material. Properties ---------- -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`albedo_color` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`albedo_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`anisotropy` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`anisotropy_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`anisotropy_flowmap` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ao_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ao_light_affect` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ao_on_uv2` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`ao_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`TextureChannel` | :ref:`ao_texture_channel` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`clearcoat` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`clearcoat_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`clearcoat_gloss` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`clearcoat_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`depth_deep_parallax` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`depth_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`depth_flip_binormal` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`depth_flip_tangent` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`depth_max_layers` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`depth_min_layers` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`depth_scale` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`depth_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`detail_albedo` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`BlendMode` | :ref:`detail_blend_mode` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`detail_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`detail_mask` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`detail_normal` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`DetailUV` | :ref:`detail_uv_layer` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_fade_max_distance` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_fade_min_distance` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`DistanceFadeMode` | :ref:`distance_fade_mode` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`emission` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emission_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`emission_energy` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`emission_on_uv2` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`EmissionOperator` | :ref:`emission_operator` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`emission_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_albedo_tex_force_srgb` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_disable_ambient_light` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_do_not_receive_shadows` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_ensure_correct_normals` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_fixed_size` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_no_depth_test` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_transparent` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_unshaded` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_use_point_size` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_vertex_lighting` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flags_world_triplanar` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`metallic` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`metallic_specular` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`metallic_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`TextureChannel` | :ref:`metallic_texture_channel` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`normal_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`normal_scale` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params_alpha_scissor_threshold` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`params_billboard_keep_scale` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`BillboardMode` | :ref:`params_billboard_mode` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`BlendMode` | :ref:`params_blend_mode` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`CullMode` | :ref:`params_cull_mode` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`DepthDrawMode` | :ref:`params_depth_draw_mode` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`DiffuseMode` | :ref:`params_diffuse_mode` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`params_grow` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params_grow_amount` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params_line_width` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`params_point_size` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`SpecularMode` | :ref:`params_specular_mode` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`params_use_alpha_scissor` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_anim_h_frames` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_anim_loop` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`particles_anim_v_frames` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`proximity_fade_distance` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`proximity_fade_enable` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`refraction_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`refraction_scale` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`refraction_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`TextureChannel` | :ref:`refraction_texture_channel` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rim` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rim_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`rim_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rim_tint` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`roughness` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`roughness_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`TextureChannel` | :ref:`roughness_texture_channel` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`subsurf_scatter_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`subsurf_scatter_strength` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`subsurf_scatter_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`transmission` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`transmission_enabled` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`transmission_texture` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`uv1_offset` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`uv1_scale` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`uv1_triplanar` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`uv1_triplanar_sharpness` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`uv2_offset` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`uv2_scale` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`uv2_triplanar` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`uv2_triplanar_sharpness` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`vertex_color_is_srgb` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`vertex_color_use_as_albedo` | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`albedo_color` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`albedo_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`anisotropy` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`anisotropy_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`anisotropy_flowmap` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ao_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ao_light_affect` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ao_on_uv2` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`ao_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`TextureChannel` | :ref:`ao_texture_channel` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`clearcoat` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`clearcoat_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`clearcoat_gloss` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`clearcoat_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`depth_deep_parallax` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`depth_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`depth_flip_binormal` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`depth_flip_tangent` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`depth_max_layers` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`depth_min_layers` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`depth_scale` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`depth_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`detail_albedo` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`BlendMode` | :ref:`detail_blend_mode` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`detail_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`detail_mask` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`detail_normal` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`DetailUV` | :ref:`detail_uv_layer` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_fade_max_distance` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_fade_min_distance` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`DistanceFadeMode` | :ref:`distance_fade_mode` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`emission` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`emission_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`emission_energy` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`emission_on_uv2` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`EmissionOperator` | :ref:`emission_operator` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`emission_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_albedo_tex_force_srgb` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_disable_ambient_light` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_do_not_receive_shadows` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_ensure_correct_normals` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_fixed_size` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_no_depth_test` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_transparent` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_unshaded` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_use_point_size` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_vertex_lighting` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flags_world_triplanar` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`metallic` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`metallic_specular` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`metallic_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`TextureChannel` | :ref:`metallic_texture_channel` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`normal_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`normal_scale` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`normal_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`params_alpha_scissor_threshold` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`params_billboard_keep_scale` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`BillboardMode` | :ref:`params_billboard_mode` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`BlendMode` | :ref:`params_blend_mode` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`CullMode` | :ref:`params_cull_mode` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`DepthDrawMode` | :ref:`params_depth_draw_mode` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`DiffuseMode` | :ref:`params_diffuse_mode` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`params_grow` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`params_grow_amount` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`params_line_width` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`params_point_size` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`SpecularMode` | :ref:`params_specular_mode` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`params_use_alpha_scissor` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`particles_anim_h_frames` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_anim_loop` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`particles_anim_v_frames` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`proximity_fade_distance` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`proximity_fade_enable` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`refraction_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`refraction_scale` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`refraction_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`TextureChannel` | :ref:`refraction_texture_channel` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rim` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rim_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`rim_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rim_tint` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`roughness` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`roughness_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`TextureChannel` | :ref:`roughness_texture_channel` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`subsurf_scatter_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`subsurf_scatter_strength` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`subsurf_scatter_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`transmission` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`transmission_enabled` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`transmission_texture` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`uv1_offset` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`uv1_scale` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`uv1_triplanar` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`uv1_triplanar_sharpness` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`uv2_offset` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`uv2_scale` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`uv2_triplanar` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`uv2_triplanar_sharpness` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`vertex_color_is_srgb` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`vertex_color_use_as_albedo` | ++----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_SpatialMaterial_TextureParam: +.. _class_SpatialMaterial_constant_TEXTURE_ALBEDO: + +.. _class_SpatialMaterial_constant_TEXTURE_METALLIC: + +.. _class_SpatialMaterial_constant_TEXTURE_ROUGHNESS: + +.. _class_SpatialMaterial_constant_TEXTURE_EMISSION: + +.. _class_SpatialMaterial_constant_TEXTURE_NORMAL: + +.. _class_SpatialMaterial_constant_TEXTURE_RIM: + +.. _class_SpatialMaterial_constant_TEXTURE_CLEARCOAT: + +.. _class_SpatialMaterial_constant_TEXTURE_FLOWMAP: + +.. _class_SpatialMaterial_constant_TEXTURE_AMBIENT_OCCLUSION: + +.. _class_SpatialMaterial_constant_TEXTURE_DEPTH: + +.. _class_SpatialMaterial_constant_TEXTURE_SUBSURFACE_SCATTERING: + +.. _class_SpatialMaterial_constant_TEXTURE_TRANSMISSION: + +.. _class_SpatialMaterial_constant_TEXTURE_REFRACTION: + +.. _class_SpatialMaterial_constant_TEXTURE_DETAIL_MASK: + +.. _class_SpatialMaterial_constant_TEXTURE_DETAIL_ALBEDO: + +.. _class_SpatialMaterial_constant_TEXTURE_DETAIL_NORMAL: + +.. _class_SpatialMaterial_constant_TEXTURE_MAX: + enum **TextureParam**: - **TEXTURE_ALBEDO** = **0** @@ -264,6 +298,10 @@ enum **TextureParam**: .. _enum_SpatialMaterial_DetailUV: +.. _class_SpatialMaterial_constant_DETAIL_UV_1: + +.. _class_SpatialMaterial_constant_DETAIL_UV_2: + enum **DetailUV**: - **DETAIL_UV_1** = **0** @@ -272,6 +310,32 @@ enum **DetailUV**: .. _enum_SpatialMaterial_Feature: +.. _class_SpatialMaterial_constant_FEATURE_TRANSPARENT: + +.. _class_SpatialMaterial_constant_FEATURE_EMISSION: + +.. _class_SpatialMaterial_constant_FEATURE_NORMAL_MAPPING: + +.. _class_SpatialMaterial_constant_FEATURE_RIM: + +.. _class_SpatialMaterial_constant_FEATURE_CLEARCOAT: + +.. _class_SpatialMaterial_constant_FEATURE_ANISOTROPY: + +.. _class_SpatialMaterial_constant_FEATURE_AMBIENT_OCCLUSION: + +.. _class_SpatialMaterial_constant_FEATURE_DEPTH_MAPPING: + +.. _class_SpatialMaterial_constant_FEATURE_SUBSURACE_SCATTERING: + +.. _class_SpatialMaterial_constant_FEATURE_TRANSMISSION: + +.. _class_SpatialMaterial_constant_FEATURE_REFRACTION: + +.. _class_SpatialMaterial_constant_FEATURE_DETAIL: + +.. _class_SpatialMaterial_constant_FEATURE_MAX: + enum **Feature**: - **FEATURE_TRANSPARENT** = **0** @@ -302,6 +366,14 @@ enum **Feature**: .. _enum_SpatialMaterial_BlendMode: +.. _class_SpatialMaterial_constant_BLEND_MODE_MIX: + +.. _class_SpatialMaterial_constant_BLEND_MODE_ADD: + +.. _class_SpatialMaterial_constant_BLEND_MODE_SUB: + +.. _class_SpatialMaterial_constant_BLEND_MODE_MUL: + enum **BlendMode**: - **BLEND_MODE_MIX** = **0** --- Default blend mode. @@ -314,6 +386,14 @@ enum **BlendMode**: .. _enum_SpatialMaterial_DepthDrawMode: +.. _class_SpatialMaterial_constant_DEPTH_DRAW_OPAQUE_ONLY: + +.. _class_SpatialMaterial_constant_DEPTH_DRAW_ALWAYS: + +.. _class_SpatialMaterial_constant_DEPTH_DRAW_DISABLED: + +.. _class_SpatialMaterial_constant_DEPTH_DRAW_ALPHA_OPAQUE_PREPASS: + enum **DepthDrawMode**: - **DEPTH_DRAW_OPAQUE_ONLY** = **0** --- Default depth draw mode. Depth is drawn only for opaque objects. @@ -326,6 +406,12 @@ enum **DepthDrawMode**: .. _enum_SpatialMaterial_CullMode: +.. _class_SpatialMaterial_constant_CULL_BACK: + +.. _class_SpatialMaterial_constant_CULL_FRONT: + +.. _class_SpatialMaterial_constant_CULL_DISABLED: + enum **CullMode**: - **CULL_BACK** = **0** --- Default cull mode. The back of the object is culled when not visible. @@ -336,6 +422,44 @@ enum **CullMode**: .. _enum_SpatialMaterial_Flags: +.. _class_SpatialMaterial_constant_FLAG_UNSHADED: + +.. _class_SpatialMaterial_constant_FLAG_USE_VERTEX_LIGHTING: + +.. _class_SpatialMaterial_constant_FLAG_DISABLE_DEPTH_TEST: + +.. _class_SpatialMaterial_constant_FLAG_ALBEDO_FROM_VERTEX_COLOR: + +.. _class_SpatialMaterial_constant_FLAG_SRGB_VERTEX_COLOR: + +.. _class_SpatialMaterial_constant_FLAG_USE_POINT_SIZE: + +.. _class_SpatialMaterial_constant_FLAG_FIXED_SIZE: + +.. _class_SpatialMaterial_constant_FLAG_BILLBOARD_KEEP_SCALE: + +.. _class_SpatialMaterial_constant_FLAG_UV1_USE_TRIPLANAR: + +.. _class_SpatialMaterial_constant_FLAG_UV2_USE_TRIPLANAR: + +.. _class_SpatialMaterial_constant_FLAG_AO_ON_UV2: + +.. _class_SpatialMaterial_constant_FLAG_EMISSION_ON_UV2: + +.. _class_SpatialMaterial_constant_FLAG_USE_ALPHA_SCISSOR: + +.. _class_SpatialMaterial_constant_FLAG_TRIPLANAR_USE_WORLD: + +.. _class_SpatialMaterial_constant_FLAG_ALBEDO_TEXTURE_FORCE_SRGB: + +.. _class_SpatialMaterial_constant_FLAG_DONT_RECEIVE_SHADOWS: + +.. _class_SpatialMaterial_constant_FLAG_DISABLE_AMBIENT_LIGHT: + +.. _class_SpatialMaterial_constant_FLAG_ENSURE_CORRECT_NORMALS: + +.. _class_SpatialMaterial_constant_FLAG_MAX: + enum **Flags**: - **FLAG_UNSHADED** = **0** @@ -378,6 +502,16 @@ enum **Flags**: .. _enum_SpatialMaterial_DiffuseMode: +.. _class_SpatialMaterial_constant_DIFFUSE_BURLEY: + +.. _class_SpatialMaterial_constant_DIFFUSE_LAMBERT: + +.. _class_SpatialMaterial_constant_DIFFUSE_LAMBERT_WRAP: + +.. _class_SpatialMaterial_constant_DIFFUSE_OREN_NAYAR: + +.. _class_SpatialMaterial_constant_DIFFUSE_TOON: + enum **DiffuseMode**: - **DIFFUSE_BURLEY** = **0** --- Default diffuse scattering algorithm. @@ -392,6 +526,16 @@ enum **DiffuseMode**: .. _enum_SpatialMaterial_SpecularMode: +.. _class_SpatialMaterial_constant_SPECULAR_SCHLICK_GGX: + +.. _class_SpatialMaterial_constant_SPECULAR_BLINN: + +.. _class_SpatialMaterial_constant_SPECULAR_PHONG: + +.. _class_SpatialMaterial_constant_SPECULAR_TOON: + +.. _class_SpatialMaterial_constant_SPECULAR_DISABLED: + enum **SpecularMode**: - **SPECULAR_SCHLICK_GGX** = **0** --- Default specular blob. @@ -406,6 +550,14 @@ enum **SpecularMode**: .. _enum_SpatialMaterial_BillboardMode: +.. _class_SpatialMaterial_constant_BILLBOARD_DISABLED: + +.. _class_SpatialMaterial_constant_BILLBOARD_ENABLED: + +.. _class_SpatialMaterial_constant_BILLBOARD_FIXED_Y: + +.. _class_SpatialMaterial_constant_BILLBOARD_PARTICLES: + enum **BillboardMode**: - **BILLBOARD_DISABLED** = **0** --- Default value. @@ -418,6 +570,16 @@ enum **BillboardMode**: .. _enum_SpatialMaterial_TextureChannel: +.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_RED: + +.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_GREEN: + +.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_BLUE: + +.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_ALPHA: + +.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_GRAYSCALE: + enum **TextureChannel**: - **TEXTURE_CHANNEL_RED** = **0** @@ -432,6 +594,10 @@ enum **TextureChannel**: .. _enum_SpatialMaterial_EmissionOperator: +.. _class_SpatialMaterial_constant_EMISSION_OP_ADD: + +.. _class_SpatialMaterial_constant_EMISSION_OP_MULTIPLY: + enum **EmissionOperator**: - **EMISSION_OP_ADD** = **0** @@ -440,6 +606,14 @@ enum **EmissionOperator**: .. _enum_SpatialMaterial_DistanceFadeMode: +.. _class_SpatialMaterial_constant_DISTANCE_FADE_DISABLED: + +.. _class_SpatialMaterial_constant_DISTANCE_FADE_PIXEL_ALPHA: + +.. _class_SpatialMaterial_constant_DISTANCE_FADE_PIXEL_DITHER: + +.. _class_SpatialMaterial_constant_DISTANCE_FADE_OBJECT_DITHER: + enum **DistanceFadeMode**: - **DISTANCE_FADE_DISABLED** = **0** @@ -463,7 +637,7 @@ Tutorials Property Descriptions --------------------- -.. _class_SpatialMaterial_albedo_color: +.. _class_SpatialMaterial_property_albedo_color: - :ref:`Color` **albedo_color** @@ -475,7 +649,7 @@ Property Descriptions The material's base color. -.. _class_SpatialMaterial_albedo_texture: +.. _class_SpatialMaterial_property_albedo_texture: - :ref:`Texture` **albedo_texture** @@ -485,7 +659,7 @@ The material's base color. | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_anisotropy: +.. _class_SpatialMaterial_property_anisotropy: - :ref:`float` **anisotropy** @@ -497,7 +671,7 @@ The material's base color. The strength of the anisotropy effect. -.. _class_SpatialMaterial_anisotropy_enabled: +.. _class_SpatialMaterial_property_anisotropy_enabled: - :ref:`bool` **anisotropy_enabled** @@ -509,7 +683,7 @@ The strength of the anisotropy effect. If ``true``, anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. Default value: ``false``. -.. _class_SpatialMaterial_anisotropy_flowmap: +.. _class_SpatialMaterial_property_anisotropy_flowmap: - :ref:`Texture` **anisotropy_flowmap** @@ -519,7 +693,7 @@ If ``true``, anisotropy is enabled. Changes the shape of the specular blob and a | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_ao_enabled: +.. _class_SpatialMaterial_property_ao_enabled: - :ref:`bool` **ao_enabled** @@ -531,7 +705,7 @@ If ``true``, anisotropy is enabled. Changes the shape of the specular blob and a If ``true``, ambient occlusion is enabled. -.. _class_SpatialMaterial_ao_light_affect: +.. _class_SpatialMaterial_property_ao_light_affect: - :ref:`float` **ao_light_affect** @@ -541,7 +715,7 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_ao_light_affect() | +----------+----------------------------+ -.. _class_SpatialMaterial_ao_on_uv2: +.. _class_SpatialMaterial_property_ao_on_uv2: - :ref:`bool` **ao_on_uv2** @@ -551,7 +725,7 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_flag() | +----------+-----------------+ -.. _class_SpatialMaterial_ao_texture: +.. _class_SpatialMaterial_property_ao_texture: - :ref:`Texture` **ao_texture** @@ -561,7 +735,7 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_ao_texture_channel: +.. _class_SpatialMaterial_property_ao_texture_channel: - :ref:`TextureChannel` **ao_texture_channel** @@ -571,7 +745,7 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_ao_texture_channel() | +----------+-------------------------------+ -.. _class_SpatialMaterial_clearcoat: +.. _class_SpatialMaterial_property_clearcoat: - :ref:`float` **clearcoat** @@ -581,7 +755,7 @@ If ``true``, ambient occlusion is enabled. | *Getter* | get_clearcoat() | +----------+----------------------+ -.. _class_SpatialMaterial_clearcoat_enabled: +.. _class_SpatialMaterial_property_clearcoat_enabled: - :ref:`bool` **clearcoat_enabled** @@ -593,7 +767,7 @@ If ``true``, ambient occlusion is enabled. If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass to the material. Default value: ``false``. -.. _class_SpatialMaterial_clearcoat_gloss: +.. _class_SpatialMaterial_property_clearcoat_gloss: - :ref:`float` **clearcoat_gloss** @@ -603,7 +777,7 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t | *Getter* | get_clearcoat_gloss() | +----------+----------------------------+ -.. _class_SpatialMaterial_clearcoat_texture: +.. _class_SpatialMaterial_property_clearcoat_texture: - :ref:`Texture` **clearcoat_texture** @@ -613,7 +787,7 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_depth_deep_parallax: +.. _class_SpatialMaterial_property_depth_deep_parallax: - :ref:`bool` **depth_deep_parallax** @@ -623,7 +797,7 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t | *Getter* | is_depth_deep_parallax_enabled() | +----------+----------------------------------+ -.. _class_SpatialMaterial_depth_enabled: +.. _class_SpatialMaterial_property_depth_enabled: - :ref:`bool` **depth_enabled** @@ -633,9 +807,9 @@ If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass t | *Getter* | get_feature() | +----------+--------------------+ -If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled`. +If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled`. -.. _class_SpatialMaterial_depth_flip_binormal: +.. _class_SpatialMaterial_property_depth_flip_binormal: - :ref:`bool` **depth_flip_binormal** @@ -645,7 +819,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_flip_tangent** @@ -655,7 +829,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_max_layers** @@ -665,7 +839,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_min_layers** @@ -675,7 +849,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_scale** @@ -685,7 +859,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **depth_texture** @@ -695,7 +869,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_albedo** @@ -705,7 +879,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_blend_mode** @@ -715,7 +889,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_enabled** @@ -725,7 +899,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_mask** @@ -735,7 +909,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_normal** @@ -745,7 +919,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **detail_uv_layer** @@ -755,7 +929,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **distance_fade_max_distance** @@ -765,7 +939,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **distance_fade_min_distance** @@ -775,7 +949,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **distance_fade_mode** @@ -785,7 +959,7 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled` **emission** @@ -795,9 +969,9 @@ If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled`. +The emitted light's color. See :ref:`emission_enabled`. -.. _class_SpatialMaterial_emission_enabled: +.. _class_SpatialMaterial_property_emission_enabled: - :ref:`bool` **emission_enabled** @@ -809,7 +983,7 @@ The emitted light's color. See :ref:`emission_enabled` **emission_energy** @@ -819,9 +993,9 @@ If ``true``, the body emits light. | *Getter* | get_emission_energy() | +----------+----------------------------+ -The emitted light's strength. See :ref:`emission_enabled`. +The emitted light's strength. See :ref:`emission_enabled`. -.. _class_SpatialMaterial_emission_on_uv2: +.. _class_SpatialMaterial_property_emission_on_uv2: - :ref:`bool` **emission_on_uv2** @@ -831,7 +1005,7 @@ The emitted light's strength. See :ref:`emission_enabled` **emission_operator** @@ -841,7 +1015,7 @@ The emitted light's strength. See :ref:`emission_enabled` **emission_texture** @@ -851,7 +1025,7 @@ The emitted light's strength. See :ref:`emission_enabled` **flags_albedo_tex_force_srgb** @@ -861,7 +1035,7 @@ The emitted light's strength. See :ref:`emission_enabled` **flags_disable_ambient_light** @@ -873,7 +1047,7 @@ The emitted light's strength. See :ref:`emission_enabled` **flags_do_not_receive_shadows** @@ -885,7 +1059,7 @@ If ``true``, the object receives no ambient light. Default value: ``false``. If ``true``, the object receives no shadow that would otherwise be cast onto it. Default value: ``false``. -.. _class_SpatialMaterial_flags_ensure_correct_normals: +.. _class_SpatialMaterial_property_flags_ensure_correct_normals: - :ref:`bool` **flags_ensure_correct_normals** @@ -895,7 +1069,7 @@ If ``true``, the object receives no shadow that would otherwise be cast onto it. | *Getter* | get_flag() | +----------+-----------------+ -.. _class_SpatialMaterial_flags_fixed_size: +.. _class_SpatialMaterial_property_flags_fixed_size: - :ref:`bool` **flags_fixed_size** @@ -907,7 +1081,7 @@ If ``true``, the object receives no shadow that would otherwise be cast onto it. If ``true``, the object is rendered at the same size regardless of distance. Default value: ``false``. -.. _class_SpatialMaterial_flags_no_depth_test: +.. _class_SpatialMaterial_property_flags_no_depth_test: - :ref:`bool` **flags_no_depth_test** @@ -919,7 +1093,7 @@ If ``true``, the object is rendered at the same size regardless of distance. Def If ``true``, depth testing is disabled and the object will be drawn in render order. -.. _class_SpatialMaterial_flags_transparent: +.. _class_SpatialMaterial_property_flags_transparent: - :ref:`bool` **flags_transparent** @@ -929,9 +1103,9 @@ If ``true``, depth testing is disabled and the object will be drawn in render or | *Getter* | get_feature() | +----------+--------------------+ -If ``true``, transparency is enabled on the body. Default value: ``false``. See also :ref:`params_blend_mode`. +If ``true``, transparency is enabled on the body. Default value: ``false``. See also :ref:`params_blend_mode`. -.. _class_SpatialMaterial_flags_unshaded: +.. _class_SpatialMaterial_property_flags_unshaded: - :ref:`bool` **flags_unshaded** @@ -943,7 +1117,7 @@ If ``true``, transparency is enabled on the body. Default value: ``false``. See If ``true``, the object is unaffected by lighting. Default value: ``false``. -.. _class_SpatialMaterial_flags_use_point_size: +.. _class_SpatialMaterial_property_flags_use_point_size: - :ref:`bool` **flags_use_point_size** @@ -953,9 +1127,9 @@ If ``true``, the object is unaffected by lighting. Default value: ``false``. | *Getter* | get_flag() | +----------+-----------------+ -If ``true``, render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also :ref:`params_point_size`. +If ``true``, render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also :ref:`params_point_size`. -.. _class_SpatialMaterial_flags_vertex_lighting: +.. _class_SpatialMaterial_property_flags_vertex_lighting: - :ref:`bool` **flags_vertex_lighting** @@ -967,7 +1141,7 @@ If ``true``, render point size can be changed. Note: this is only effective for If ``true``, lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. Default value: ``false``. -.. _class_SpatialMaterial_flags_world_triplanar: +.. _class_SpatialMaterial_property_flags_world_triplanar: - :ref:`bool` **flags_world_triplanar** @@ -977,9 +1151,9 @@ If ``true``, lighting is calculated per vertex rather than per pixel. This may i | *Getter* | get_flag() | +----------+-----------------+ -If ``true``, triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. Default value: ``false``. +If ``true``, triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. Default value: ``false``. -.. _class_SpatialMaterial_metallic: +.. _class_SpatialMaterial_property_metallic: - :ref:`float` **metallic** @@ -991,7 +1165,7 @@ If ``true``, triplanar mapping is calculated in world space rather than object l The reflectivity of the object's surface. The higher the value the more light is reflected. -.. _class_SpatialMaterial_metallic_specular: +.. _class_SpatialMaterial_property_metallic_specular: - :ref:`float` **metallic_specular** @@ -1001,9 +1175,9 @@ The reflectivity of the object's surface. The higher the value the more light is | *Getter* | get_specular() | +----------+---------------------+ -General reflectivity amount. Note: unlike :ref:`metallic`, this is not energy-conserving, so it should be left at ``0.5`` in most cases. See also :ref:`roughness`. +General reflectivity amount. Note: unlike :ref:`metallic`, this is not energy-conserving, so it should be left at ``0.5`` in most cases. See also :ref:`roughness`. -.. _class_SpatialMaterial_metallic_texture: +.. _class_SpatialMaterial_property_metallic_texture: - :ref:`Texture` **metallic_texture** @@ -1013,7 +1187,7 @@ General reflectivity amount. Note: unlike :ref:`metallic` **metallic_texture_channel** @@ -1023,7 +1197,7 @@ General reflectivity amount. Note: unlike :ref:`metallic` **normal_enabled** @@ -1035,7 +1209,7 @@ General reflectivity amount. Note: unlike :ref:`metallic` **normal_scale** @@ -1047,7 +1221,7 @@ If ``true``, normal mapping is enabled. The strength of the normal map's effect. -.. _class_SpatialMaterial_normal_texture: +.. _class_SpatialMaterial_property_normal_texture: - :ref:`Texture` **normal_texture** @@ -1057,7 +1231,7 @@ The strength of the normal map's effect. | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_params_alpha_scissor_threshold: +.. _class_SpatialMaterial_property_params_alpha_scissor_threshold: - :ref:`float` **params_alpha_scissor_threshold** @@ -1067,7 +1241,7 @@ The strength of the normal map's effect. | *Getter* | get_alpha_scissor_threshold() | +----------+------------------------------------+ -.. _class_SpatialMaterial_params_billboard_keep_scale: +.. _class_SpatialMaterial_property_params_billboard_keep_scale: - :ref:`bool` **params_billboard_keep_scale** @@ -1077,7 +1251,7 @@ The strength of the normal map's effect. | *Getter* | get_flag() | +----------+-----------------+ -.. _class_SpatialMaterial_params_billboard_mode: +.. _class_SpatialMaterial_property_params_billboard_mode: - :ref:`BillboardMode` **params_billboard_mode** @@ -1087,9 +1261,9 @@ The strength of the normal map's effect. | *Getter* | get_billboard_mode() | +----------+---------------------------+ -Controls how the object faces the camera. See :ref:`BillboardMode`. +Controls how the object faces the camera. See :ref:`BillboardMode`. -.. _class_SpatialMaterial_params_blend_mode: +.. _class_SpatialMaterial_property_params_blend_mode: - :ref:`BlendMode` **params_blend_mode** @@ -1099,9 +1273,9 @@ Controls how the object faces the camera. See :ref:`BillboardMode`. +The material's blend mode. Note that values other than ``Mix`` force the object into the transparent pipeline. See :ref:`BlendMode`. -.. _class_SpatialMaterial_params_cull_mode: +.. _class_SpatialMaterial_property_params_cull_mode: - :ref:`CullMode` **params_cull_mode** @@ -1111,9 +1285,9 @@ The material's blend mode. Note that values other than ``Mix`` force the object | *Getter* | get_cull_mode() | +----------+----------------------+ -Which side of the object is not drawn when backfaces are rendered. See :ref:`CullMode`. +Which side of the object is not drawn when backfaces are rendered. See :ref:`CullMode`. -.. _class_SpatialMaterial_params_depth_draw_mode: +.. _class_SpatialMaterial_property_params_depth_draw_mode: - :ref:`DepthDrawMode` **params_depth_draw_mode** @@ -1123,9 +1297,9 @@ Which side of the object is not drawn when backfaces are rendered. See :ref:`Cul | *Getter* | get_depth_draw_mode() | +----------+----------------------------+ -Determines when depth rendering takes place. See :ref:`DepthDrawMode`. See also :ref:`flags_transparent`. +Determines when depth rendering takes place. See :ref:`DepthDrawMode`. See also :ref:`flags_transparent`. -.. _class_SpatialMaterial_params_diffuse_mode: +.. _class_SpatialMaterial_property_params_diffuse_mode: - :ref:`DiffuseMode` **params_diffuse_mode** @@ -1135,9 +1309,9 @@ Determines when depth rendering takes place. See :ref:`DepthDrawMode`. +The algorithm used for diffuse light scattering. See :ref:`DiffuseMode`. -.. _class_SpatialMaterial_params_grow: +.. _class_SpatialMaterial_property_params_grow: - :ref:`bool` **params_grow** @@ -1147,9 +1321,9 @@ The algorithm used for diffuse light scattering. See :ref:`DiffuseMode`. +If ``true``, enables the vertex grow setting. See :ref:`params_grow_amount`. -.. _class_SpatialMaterial_params_grow_amount: +.. _class_SpatialMaterial_property_params_grow_amount: - :ref:`float` **params_grow_amount** @@ -1161,7 +1335,7 @@ If ``true``, enables the vertex grow setting. See :ref:`params_grow_amount` **params_line_width** @@ -1171,7 +1345,7 @@ Grows object vertices in the direction of their normals. | *Getter* | get_line_width() | +----------+-----------------------+ -.. _class_SpatialMaterial_params_point_size: +.. _class_SpatialMaterial_property_params_point_size: - :ref:`float` **params_point_size** @@ -1181,9 +1355,9 @@ Grows object vertices in the direction of their normals. | *Getter* | get_point_size() | +----------+-----------------------+ -The point size in pixels. See :ref:`flags_use_point_size`. +The point size in pixels. See :ref:`flags_use_point_size`. -.. _class_SpatialMaterial_params_specular_mode: +.. _class_SpatialMaterial_property_params_specular_mode: - :ref:`SpecularMode` **params_specular_mode** @@ -1193,9 +1367,9 @@ The point size in pixels. See :ref:`flags_use_point_size`. +The method for rendering the specular blob. See :ref:`SpecularMode`. -.. _class_SpatialMaterial_params_use_alpha_scissor: +.. _class_SpatialMaterial_property_params_use_alpha_scissor: - :ref:`bool` **params_use_alpha_scissor** @@ -1205,7 +1379,7 @@ The method for rendering the specular blob. See :ref:`SpecularMode` **particles_anim_h_frames** @@ -1215,9 +1389,9 @@ The method for rendering the specular blob. See :ref:`SpecularMode`. +The number of horizontal frames in the particle spritesheet. Only enabled when using ``BillboardMode.BILLBOARD_PARTICLES``. See :ref:`params_billboard_mode`. -.. _class_SpatialMaterial_particles_anim_loop: +.. _class_SpatialMaterial_property_particles_anim_loop: - :ref:`bool` **particles_anim_loop** @@ -1227,9 +1401,9 @@ The number of horizontal frames in the particle spritesheet. Only enabled when u | *Getter* | get_particles_anim_loop() | +----------+--------------------------------+ -If ``true``, particle animations are looped. Only enabled when using ``BillboardMode.BILLBOARD_PARTICLES``. See :ref:`params_billboard_mode`. +If ``true``, particle animations are looped. Only enabled when using ``BillboardMode.BILLBOARD_PARTICLES``. See :ref:`params_billboard_mode`. -.. _class_SpatialMaterial_particles_anim_v_frames: +.. _class_SpatialMaterial_property_particles_anim_v_frames: - :ref:`int` **particles_anim_v_frames** @@ -1239,9 +1413,9 @@ If ``true``, particle animations are looped. Only enabled when using ``Billboard | *Getter* | get_particles_anim_v_frames() | +----------+------------------------------------+ -The number of vertical frames in the particle spritesheet. Only enabled when using ``BillboardMode.BILLBOARD_PARTICLES``. See :ref:`params_billboard_mode`. +The number of vertical frames in the particle spritesheet. Only enabled when using ``BillboardMode.BILLBOARD_PARTICLES``. See :ref:`params_billboard_mode`. -.. _class_SpatialMaterial_proximity_fade_distance: +.. _class_SpatialMaterial_property_proximity_fade_distance: - :ref:`float` **proximity_fade_distance** @@ -1251,7 +1425,7 @@ The number of vertical frames in the particle spritesheet. Only enabled when usi | *Getter* | get_proximity_fade_distance() | +----------+------------------------------------+ -.. _class_SpatialMaterial_proximity_fade_enable: +.. _class_SpatialMaterial_property_proximity_fade_enable: - :ref:`bool` **proximity_fade_enable** @@ -1263,7 +1437,7 @@ The number of vertical frames in the particle spritesheet. Only enabled when usi If ``true``, the proximity and distance fade effect is enabled. Default value: ``false``. -.. _class_SpatialMaterial_refraction_enabled: +.. _class_SpatialMaterial_property_refraction_enabled: - :ref:`bool` **refraction_enabled** @@ -1275,7 +1449,7 @@ If ``true``, the proximity and distance fade effect is enabled. Default value: ` If ``true``, the refraction effect is enabled. Distorts transparency based on light from behind the object. Default value: ``false``. -.. _class_SpatialMaterial_refraction_scale: +.. _class_SpatialMaterial_property_refraction_scale: - :ref:`float` **refraction_scale** @@ -1287,7 +1461,7 @@ If ``true``, the refraction effect is enabled. Distorts transparency based on li The strength of the refraction effect. -.. _class_SpatialMaterial_refraction_texture: +.. _class_SpatialMaterial_property_refraction_texture: - :ref:`Texture` **refraction_texture** @@ -1297,7 +1471,7 @@ The strength of the refraction effect. | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_refraction_texture_channel: +.. _class_SpatialMaterial_property_refraction_texture_channel: - :ref:`TextureChannel` **refraction_texture_channel** @@ -1307,7 +1481,7 @@ The strength of the refraction effect. | *Getter* | get_refraction_texture_channel() | +----------+---------------------------------------+ -.. _class_SpatialMaterial_rim: +.. _class_SpatialMaterial_property_rim: - :ref:`float` **rim** @@ -1317,7 +1491,7 @@ The strength of the refraction effect. | *Getter* | get_rim() | +----------+----------------+ -.. _class_SpatialMaterial_rim_enabled: +.. _class_SpatialMaterial_property_rim_enabled: - :ref:`bool` **rim_enabled** @@ -1329,7 +1503,7 @@ The strength of the refraction effect. If ``true``, rim effect is enabled. Default value: ``false``. -.. _class_SpatialMaterial_rim_texture: +.. _class_SpatialMaterial_property_rim_texture: - :ref:`Texture` **rim_texture** @@ -1339,7 +1513,7 @@ If ``true``, rim effect is enabled. Default value: ``false``. | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_rim_tint: +.. _class_SpatialMaterial_property_rim_tint: - :ref:`float` **rim_tint** @@ -1351,7 +1525,7 @@ If ``true``, rim effect is enabled. Default value: ``false``. The amount of to blend light and albedo color when rendering rim effect. If ``0`` the light color is used, while ``1`` means albedo color is used. An intermediate value generally works best. -.. _class_SpatialMaterial_roughness: +.. _class_SpatialMaterial_property_roughness: - :ref:`float` **roughness** @@ -1361,9 +1535,9 @@ The amount of to blend light and albedo color when rendering rim effect. If ``0` | *Getter* | get_roughness() | +----------+----------------------+ -Surface reflection. A value of ``0`` represents a perfect mirror while a value of ``1`` completely blurs the reflection. See also :ref:`metallic`. +Surface reflection. A value of ``0`` represents a perfect mirror while a value of ``1`` completely blurs the reflection. See also :ref:`metallic`. -.. _class_SpatialMaterial_roughness_texture: +.. _class_SpatialMaterial_property_roughness_texture: - :ref:`Texture` **roughness_texture** @@ -1373,7 +1547,7 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_roughness_texture_channel: +.. _class_SpatialMaterial_property_roughness_texture_channel: - :ref:`TextureChannel` **roughness_texture_channel** @@ -1383,7 +1557,7 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o | *Getter* | get_roughness_texture_channel() | +----------+--------------------------------------+ -.. _class_SpatialMaterial_subsurf_scatter_enabled: +.. _class_SpatialMaterial_property_subsurf_scatter_enabled: - :ref:`bool` **subsurf_scatter_enabled** @@ -1395,7 +1569,7 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. -.. _class_SpatialMaterial_subsurf_scatter_strength: +.. _class_SpatialMaterial_property_subsurf_scatter_strength: - :ref:`float` **subsurf_scatter_strength** @@ -1407,7 +1581,7 @@ If ``true``, subsurface scattering is enabled. Emulates light that penetrates an The strength of the subsurface scattering effect. -.. _class_SpatialMaterial_subsurf_scatter_texture: +.. _class_SpatialMaterial_property_subsurf_scatter_texture: - :ref:`Texture` **subsurf_scatter_texture** @@ -1417,7 +1591,7 @@ The strength of the subsurface scattering effect. | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_transmission: +.. _class_SpatialMaterial_property_transmission: - :ref:`Color` **transmission** @@ -1429,7 +1603,7 @@ The strength of the subsurface scattering effect. The color used by the transmission effect. Represents the light passing through an object. -.. _class_SpatialMaterial_transmission_enabled: +.. _class_SpatialMaterial_property_transmission_enabled: - :ref:`bool` **transmission_enabled** @@ -1441,7 +1615,7 @@ The color used by the transmission effect. Represents the light passing through If ``true``, the transmission effect is enabled. Default value: ``false``. -.. _class_SpatialMaterial_transmission_texture: +.. _class_SpatialMaterial_property_transmission_texture: - :ref:`Texture` **transmission_texture** @@ -1451,7 +1625,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_texture() | +----------+--------------------+ -.. _class_SpatialMaterial_uv1_offset: +.. _class_SpatialMaterial_property_uv1_offset: - :ref:`Vector3` **uv1_offset** @@ -1461,7 +1635,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv1_offset() | +----------+-----------------------+ -.. _class_SpatialMaterial_uv1_scale: +.. _class_SpatialMaterial_property_uv1_scale: - :ref:`Vector3` **uv1_scale** @@ -1471,7 +1645,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv1_scale() | +----------+----------------------+ -.. _class_SpatialMaterial_uv1_triplanar: +.. _class_SpatialMaterial_property_uv1_triplanar: - :ref:`bool` **uv1_triplanar** @@ -1481,7 +1655,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_flag() | +----------+-----------------+ -.. _class_SpatialMaterial_uv1_triplanar_sharpness: +.. _class_SpatialMaterial_property_uv1_triplanar_sharpness: - :ref:`float` **uv1_triplanar_sharpness** @@ -1491,7 +1665,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv1_triplanar_blend_sharpness() | +----------+------------------------------------------+ -.. _class_SpatialMaterial_uv2_offset: +.. _class_SpatialMaterial_property_uv2_offset: - :ref:`Vector3` **uv2_offset** @@ -1501,7 +1675,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv2_offset() | +----------+-----------------------+ -.. _class_SpatialMaterial_uv2_scale: +.. _class_SpatialMaterial_property_uv2_scale: - :ref:`Vector3` **uv2_scale** @@ -1511,7 +1685,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv2_scale() | +----------+----------------------+ -.. _class_SpatialMaterial_uv2_triplanar: +.. _class_SpatialMaterial_property_uv2_triplanar: - :ref:`bool` **uv2_triplanar** @@ -1521,7 +1695,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_flag() | +----------+-----------------+ -.. _class_SpatialMaterial_uv2_triplanar_sharpness: +.. _class_SpatialMaterial_property_uv2_triplanar_sharpness: - :ref:`float` **uv2_triplanar_sharpness** @@ -1531,7 +1705,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. | *Getter* | get_uv2_triplanar_blend_sharpness() | +----------+------------------------------------------+ -.. _class_SpatialMaterial_vertex_color_is_srgb: +.. _class_SpatialMaterial_property_vertex_color_is_srgb: - :ref:`bool` **vertex_color_is_srgb** @@ -1543,7 +1717,7 @@ If ``true``, the transmission effect is enabled. Default value: ``false``. If ``true``, the model's vertex colors are processed as sRGB mode. Default value: ``false``. -.. _class_SpatialMaterial_vertex_color_use_as_albedo: +.. _class_SpatialMaterial_property_vertex_color_use_as_albedo: - :ref:`bool` **vertex_color_use_as_albedo** diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst index eb0365ff9..b81dd996d 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -19,25 +19,25 @@ Brief Description Properties ---------- -+-------------------------+----------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_physics_step` | -+-------------------------+----------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_physics_step` | ++-------------------------+-------------------------------------------------------------------------------------+ Methods ------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_tracked_linear_velocity` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset` **(** :ref:`Vector3` position **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_position` **(** :ref:`Vector3` position **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_tracked_linear_velocity` **(** **)** const | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset` **(** :ref:`Vector3` position **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_position` **(** :ref:`Vector3` position **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_SpatialVelocityTracker_track_physics_step: +.. _class_SpatialVelocityTracker_property_track_physics_step: - :ref:`bool` **track_physics_step** @@ -50,15 +50,15 @@ Property Descriptions Method Descriptions ------------------- -.. _class_SpatialVelocityTracker_get_tracked_linear_velocity: +.. _class_SpatialVelocityTracker_method_get_tracked_linear_velocity: - :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const -.. _class_SpatialVelocityTracker_reset: +.. _class_SpatialVelocityTracker_method_reset: - void **reset** **(** :ref:`Vector3` position **)** -.. _class_SpatialVelocityTracker_update_position: +.. _class_SpatialVelocityTracker_method_update_position: - void **update_position** **(** :ref:`Vector3` position **)** diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index 7789e53b9..36286807c 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -19,17 +19,17 @@ Class representing a spherical :ref:`PrimitiveMesh`. Properties ---------- -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`height` | -+---------------------------+----------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hemisphere` | -+---------------------------+----------------------------------------------------------+ -| :ref:`int` | :ref:`radial_segments` | -+---------------------------+----------------------------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+----------------------------------------------------------+ -| :ref:`int` | :ref:`rings` | -+---------------------------+----------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------+-------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hemisphere` | ++---------------------------+-------------------------------------------------------------------+ +| :ref:`int` | :ref:`radial_segments` | ++---------------------------+-------------------------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+-------------------------------------------------------------------+ +| :ref:`int` | :ref:`rings` | ++---------------------------+-------------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ Class representing a spherical :ref:`PrimitiveMesh`. Property Descriptions --------------------- -.. _class_SphereMesh_height: +.. _class_SphereMesh_property_height: - :ref:`float` **height** @@ -51,7 +51,7 @@ Property Descriptions Full height of the sphere. Defaults to 2.0. -.. _class_SphereMesh_is_hemisphere: +.. _class_SphereMesh_property_is_hemisphere: - :ref:`bool` **is_hemisphere** @@ -63,7 +63,7 @@ Full height of the sphere. Defaults to 2.0. Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere the height and radius of the sphere have to equal. Defaults to false. -.. _class_SphereMesh_radial_segments: +.. _class_SphereMesh_property_radial_segments: - :ref:`int` **radial_segments** @@ -75,7 +75,7 @@ Determines whether a full sphere or a hemisphere is created. Attention: To get a Number of radial segments on the sphere. Defaults to 64. -.. _class_SphereMesh_radius: +.. _class_SphereMesh_property_radius: - :ref:`float` **radius** @@ -87,7 +87,7 @@ Number of radial segments on the sphere. Defaults to 64. Radius of sphere. Defaults to 1.0. -.. _class_SphereMesh_rings: +.. _class_SphereMesh_property_rings: - :ref:`int` **rings** diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 63d52cbdc..fb739aae8 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -19,9 +19,9 @@ Sphere shape for 3D collisions. Properties ---------- -+---------------------------+-----------------------------------------+ -| :ref:`float` | :ref:`radius` | -+---------------------------+-----------------------------------------+ ++---------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+--------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Sphere shape for 3D collisions, which can be set into a :ref:`PhysicsBody` **radius** diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index f55676c11..973afbe1a 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -19,29 +19,29 @@ Numerical input text field. Properties ---------- -+-----------------------------------+-----------------------------------------+ -| :ref:`Align` | :ref:`align` | -+-----------------------------------+-----------------------------------------+ -| :ref:`bool` | :ref:`editable` | -+-----------------------------------+-----------------------------------------+ -| :ref:`String` | :ref:`prefix` | -+-----------------------------------+-----------------------------------------+ -| :ref:`String` | :ref:`suffix` | -+-----------------------------------+-----------------------------------------+ ++-----------------------------------+--------------------------------------------------+ +| :ref:`Align` | :ref:`align` | ++-----------------------------------+--------------------------------------------------+ +| :ref:`bool` | :ref:`editable` | ++-----------------------------------+--------------------------------------------------+ +| :ref:`String` | :ref:`prefix` | ++-----------------------------------+--------------------------------------------------+ +| :ref:`String` | :ref:`suffix` | ++-----------------------------------+--------------------------------------------------+ Methods ------- -+----------------------------------+---------------------------------------------------------------+ -| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | -+----------------------------------+---------------------------------------------------------------+ ++---------------------------------+----------------------------------------------------------------------+ +| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | ++---------------------------------+----------------------------------------------------------------------+ Theme Properties ---------------- -+-------------------------------+-------------------------------------+ -| :ref:`Texture` | :ref:`updown` | -+-------------------------------+-------------------------------------+ ++-------------------------------+--------+ +| :ref:`Texture` | updown | ++-------------------------------+--------+ Description ----------- @@ -51,7 +51,7 @@ SpinBox is a numerical input text field. It allows entering integers and floats. Property Descriptions --------------------- -.. _class_SpinBox_align: +.. _class_SpinBox_property_align: - :ref:`Align` **align** @@ -61,7 +61,7 @@ Property Descriptions | *Getter* | get_align() | +----------+------------------+ -.. _class_SpinBox_editable: +.. _class_SpinBox_property_editable: - :ref:`bool` **editable** @@ -71,7 +71,7 @@ Property Descriptions | *Getter* | is_editable() | +----------+---------------------+ -.. _class_SpinBox_prefix: +.. _class_SpinBox_property_prefix: - :ref:`String` **prefix** @@ -81,7 +81,7 @@ Property Descriptions | *Getter* | get_prefix() | +----------+-------------------+ -.. _class_SpinBox_suffix: +.. _class_SpinBox_property_suffix: - :ref:`String` **suffix** @@ -94,7 +94,7 @@ Property Descriptions Method Descriptions ------------------- -.. _class_SpinBox_get_line_edit: +.. _class_SpinBox_method_get_line_edit: - :ref:`LineEdit` **get_line_edit** **(** **)** diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 3fa512fc2..c1d018338 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -21,25 +21,25 @@ Container for splitting and adjusting. Properties ---------- -+-----------------------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collapsed` | -+-----------------------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`DraggerVisibility` | :ref:`dragger_visibility` | -+-----------------------------------------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`split_offset` | -+-----------------------------------------------------------------+--------------------------------------------------------------------+ ++-----------------------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collapsed` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`DraggerVisibility` | :ref:`dragger_visibility` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`int` | :ref:`split_offset` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------+ Methods ------- -+-------+--------------------------------------------------------------------------------+ -| void | :ref:`clamp_split_offset` **(** **)** | -+-------+--------------------------------------------------------------------------------+ ++------+---------------------------------------------------------------------------------------+ +| void | :ref:`clamp_split_offset` **(** **)** | ++------+---------------------------------------------------------------------------------------+ Signals ------- -.. _class_SplitContainer_dragged: +.. _class_SplitContainer_signal_dragged: - **dragged** **(** :ref:`int` offset **)** @@ -50,6 +50,12 @@ Enumerations .. _enum_SplitContainer_DraggerVisibility: +.. _class_SplitContainer_constant_DRAGGER_VISIBLE: + +.. _class_SplitContainer_constant_DRAGGER_HIDDEN: + +.. _class_SplitContainer_constant_DRAGGER_HIDDEN_COLLAPSED: + enum **DraggerVisibility**: - **DRAGGER_VISIBLE** = **0** --- The split dragger is visible. @@ -66,7 +72,7 @@ Container for splitting two controls vertically or horizontally, with a grabber Property Descriptions --------------------- -.. _class_SplitContainer_collapsed: +.. _class_SplitContainer_property_collapsed: - :ref:`bool` **collapsed** @@ -76,7 +82,7 @@ Property Descriptions | *Getter* | is_collapsed() | +----------+----------------------+ -.. _class_SplitContainer_dragger_visibility: +.. _class_SplitContainer_property_dragger_visibility: - :ref:`DraggerVisibility` **dragger_visibility** @@ -88,7 +94,7 @@ Property Descriptions Determines whether the dragger is visible. -.. _class_SplitContainer_split_offset: +.. _class_SplitContainer_property_split_offset: - :ref:`int` **split_offset** @@ -101,7 +107,7 @@ Determines whether the dragger is visible. Method Descriptions ------------------- -.. _class_SplitContainer_clamp_split_offset: +.. _class_SplitContainer_method_clamp_split_offset: - void **clamp_split_offset** **(** **)** diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index 4019b621e..5ae5d7476 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -19,15 +19,15 @@ Spotlight :ref:`Light`, such as a reflector spotlight or a lantern. Properties ---------- -+---------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`spot_angle` | -+---------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`spot_angle_attenuation` | -+---------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`spot_attenuation` | -+---------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`spot_range` | -+---------------------------+-----------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`spot_angle` | ++---------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`spot_angle_attenuation` | ++---------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`spot_attenuation` | ++---------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`spot_range` | ++---------------------------+--------------------------------------------------------------------------------+ Description ----------- @@ -42,7 +42,7 @@ Tutorials Property Descriptions --------------------- -.. _class_SpotLight_spot_angle: +.. _class_SpotLight_property_spot_angle: - :ref:`float` **spot_angle** @@ -52,7 +52,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_SpotLight_spot_angle_attenuation: +.. _class_SpotLight_property_spot_angle_attenuation: - :ref:`float` **spot_angle_attenuation** @@ -62,7 +62,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_SpotLight_spot_attenuation: +.. _class_SpotLight_property_spot_attenuation: - :ref:`float` **spot_attenuation** @@ -72,7 +72,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ -.. _class_SpotLight_spot_range: +.. _class_SpotLight_property_spot_range: - :ref:`float` **spot_range** diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst index bfe215877..672b9d7dc 100644 --- a/classes/class_springarm.rst +++ b/classes/class_springarm.rst @@ -19,33 +19,33 @@ Brief Description Properties ---------- -+---------------------------+-------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+---------------------------+-------------------------------------------------------+ -| :ref:`float` | :ref:`margin` | -+---------------------------+-------------------------------------------------------+ -| :ref:`Shape` | :ref:`shape` | -+---------------------------+-------------------------------------------------------+ -| :ref:`float` | :ref:`spring_length` | -+---------------------------+-------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++---------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`margin` | ++---------------------------+----------------------------------------------------------------+ +| :ref:`Shape` | :ref:`shape` | ++---------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`spring_length` | ++---------------------------+----------------------------------------------------------------+ Methods ------- -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_excluded_object` **(** :ref:`RID` RID **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_excluded_objects` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_hit_length` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_excluded_object` **(** :ref:`RID` RID **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_excluded_object` **(** :ref:`RID` RID **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_excluded_objects` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_hit_length` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_excluded_object` **(** :ref:`RID` RID **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_SpringArm_collision_mask: +.. _class_SpringArm_property_collision_mask: - :ref:`int` **collision_mask** @@ -55,7 +55,7 @@ Property Descriptions | *Getter* | get_collision_mask() | +----------+---------------------------+ -.. _class_SpringArm_margin: +.. _class_SpringArm_property_margin: - :ref:`float` **margin** @@ -65,7 +65,7 @@ Property Descriptions | *Getter* | get_margin() | +----------+-------------------+ -.. _class_SpringArm_shape: +.. _class_SpringArm_property_shape: - :ref:`Shape` **shape** @@ -75,7 +75,7 @@ Property Descriptions | *Getter* | get_shape() | +----------+------------------+ -.. _class_SpringArm_spring_length: +.. _class_SpringArm_property_spring_length: - :ref:`float` **spring_length** @@ -88,19 +88,19 @@ Property Descriptions Method Descriptions ------------------- -.. _class_SpringArm_add_excluded_object: +.. _class_SpringArm_method_add_excluded_object: - void **add_excluded_object** **(** :ref:`RID` RID **)** -.. _class_SpringArm_clear_excluded_objects: +.. _class_SpringArm_method_clear_excluded_objects: - void **clear_excluded_objects** **(** **)** -.. _class_SpringArm_get_hit_length: +.. _class_SpringArm_method_get_hit_length: - :ref:`float` **get_hit_length** **(** **)** -.. _class_SpringArm_remove_excluded_object: +.. _class_SpringArm_method_remove_excluded_object: - :ref:`bool` **remove_excluded_object** **(** :ref:`RID` RID **)** diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 603c45c8e..a7c5ef4f5 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -19,55 +19,55 @@ General purpose Sprite node. Properties ---------- -+-------------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`centered` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_h` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_v` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`frame` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`hframes` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`region_enabled` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`bool` | :ref:`region_filter_clip` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-------------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`vframes` | -+-------------------------------+------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`centered` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flip_h` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flip_v` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`int` | :ref:`frame` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`int` | :ref:`hframes` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`normal_map` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`offset` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`region_enabled` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`region_filter_clip` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`region_rect` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++-------------------------------+---------------------------------------------------------------------+ +| :ref:`int` | :ref:`vframes` | ++-------------------------------+---------------------------------------------------------------------+ 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 ------- -.. _class_Sprite_frame_changed: +.. _class_Sprite_signal_frame_changed: - **frame_changed** **(** **)** -Emitted when the :ref:`frame` changes. +Emitted when the :ref:`frame` changes. -.. _class_Sprite_texture_changed: +.. _class_Sprite_signal_texture_changed: - **texture_changed** **(** **)** -Emitted when the :ref:`texture` changes. +Emitted when the :ref:`texture` changes. Description ----------- @@ -77,7 +77,7 @@ A node that displays a 2D texture. The texture displayed can be a region from a Property Descriptions --------------------- -.. _class_Sprite_centered: +.. _class_Sprite_property_centered: - :ref:`bool` **centered** @@ -89,7 +89,7 @@ Property Descriptions If ``true``, texture is centered. Default value: ``true``. -.. _class_Sprite_flip_h: +.. _class_Sprite_property_flip_h: - :ref:`bool` **flip_h** @@ -101,7 +101,7 @@ If ``true``, texture is centered. Default value: ``true``. If ``true``, texture is flipped horizontally. Default value: ``false``. -.. _class_Sprite_flip_v: +.. _class_Sprite_property_flip_v: - :ref:`bool` **flip_v** @@ -113,7 +113,7 @@ If ``true``, texture is flipped horizontally. Default value: ``false``. If ``true``, texture is flipped vertically. Default value: ``false``. -.. _class_Sprite_frame: +.. _class_Sprite_property_frame: - :ref:`int` **frame** @@ -123,9 +123,9 @@ If ``true``, texture is flipped vertically. Default value: ``false``. | *Getter* | get_frame() | +----------+------------------+ -Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. +Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. -.. _class_Sprite_hframes: +.. _class_Sprite_property_hframes: - :ref:`int` **hframes** @@ -137,7 +137,7 @@ Current frame to display from sprite sheet. :ref:`vframes` The number of columns in the sprite sheet. -.. _class_Sprite_normal_map: +.. _class_Sprite_property_normal_map: - :ref:`Texture` **normal_map** @@ -149,7 +149,7 @@ The number of columns in the sprite sheet. The normal map gives depth to the Sprite. -.. _class_Sprite_offset: +.. _class_Sprite_property_offset: - :ref:`Vector2` **offset** @@ -161,7 +161,7 @@ The normal map gives depth to the Sprite. The texture's drawing offset. -.. _class_Sprite_region_enabled: +.. _class_Sprite_property_region_enabled: - :ref:`bool` **region_enabled** @@ -173,7 +173,7 @@ The texture's drawing offset. If ``true``, texture is cut from a larger atlas texture. See ``region_rect``. Default value: ``false``. -.. _class_Sprite_region_filter_clip: +.. _class_Sprite_property_region_filter_clip: - :ref:`bool` **region_filter_clip** @@ -185,7 +185,7 @@ If ``true``, texture is cut from a larger atlas texture. See ``region_rect``. De If ``true``, the outermost pixels get blurred out. -.. _class_Sprite_region_rect: +.. _class_Sprite_property_region_rect: - :ref:`Rect2` **region_rect** @@ -195,9 +195,9 @@ If ``true``, the outermost pixels get blurred out. | *Getter* | get_region_rect() | +----------+------------------------+ -The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. +The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. -.. _class_Sprite_texture: +.. _class_Sprite_property_texture: - :ref:`Texture` **texture** @@ -209,7 +209,7 @@ The region of the atlas texture to display. :ref:`region_enabled` object to draw. -.. _class_Sprite_vframes: +.. _class_Sprite_property_vframes: - :ref:`int` **vframes** @@ -224,13 +224,13 @@ The number of rows in the sprite sheet. Method Descriptions ------------------- -.. _class_Sprite_get_rect: +.. _class_Sprite_method_get_rect: - :ref:`Rect2` **get_rect** **(** **)** const Returns a Rect2 representing the Sprite's boundary relative to its local coordinates. -.. _class_Sprite_is_pixel_opaque: +.. _class_Sprite_method_is_pixel_opaque: - :ref:`bool` **is_pixel_opaque** **(** :ref:`Vector2` pos **)** const diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 829f56557..f1a985f7c 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -19,28 +19,28 @@ Brief Description Properties ---------- -+-------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`frame` | -+-------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`hframes` | -+-------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`region_enabled` | -+-------------------------------+------------------------------------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | -+-------------------------------+------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`vframes` | -+-------------------------------+------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`frame` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`hframes` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`region_enabled` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`region_rect` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`vframes` | ++-------------------------------+---------------------------------------------------------------+ Signals ------- -.. _class_Sprite3D_frame_changed: +.. _class_Sprite3D_signal_frame_changed: - **frame_changed** **(** **)** -Emitted when the :ref:`frame` changes. +Emitted when the :ref:`frame` changes. Description ----------- @@ -50,7 +50,7 @@ A node that displays a 2D texture in a 3D environment. The texture displayed can Property Descriptions --------------------- -.. _class_Sprite3D_frame: +.. _class_Sprite3D_property_frame: - :ref:`int` **frame** @@ -60,9 +60,9 @@ Property Descriptions | *Getter* | get_frame() | +----------+------------------+ -Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. +Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. -.. _class_Sprite3D_hframes: +.. _class_Sprite3D_property_hframes: - :ref:`int` **hframes** @@ -74,7 +74,7 @@ Current frame to display from sprite sheet. :ref:`vframes` **region_enabled** @@ -84,9 +84,9 @@ The number of columns in the sprite sheet. | *Getter* | is_region() | +----------+-------------------+ -If ``true``, texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. +If ``true``, texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. -.. _class_Sprite3D_region_rect: +.. _class_Sprite3D_property_region_rect: - :ref:`Rect2` **region_rect** @@ -96,9 +96,9 @@ If ``true``, texture will be cut from a larger atlas texture. See :ref:`region_r | *Getter* | get_region_rect() | +----------+------------------------+ -The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. +The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. -.. _class_Sprite3D_texture: +.. _class_Sprite3D_property_texture: - :ref:`Texture` **texture** @@ -110,7 +110,7 @@ The region of the atlas texture to display. :ref:`region_enabled` object to draw. -.. _class_Sprite3D_vframes: +.. _class_Sprite3D_property_vframes: - :ref:`int` **vframes** diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 96ada5cc8..dd3def361 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -21,46 +21,54 @@ Brief Description Properties ---------- -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`AlphaCutMode` | :ref:`alpha_cut` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`Axis` | :ref:`axis` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`centered` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`double_sided` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_h` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`flip_v` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`Color` | :ref:`modulate` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`opacity` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`float` | :ref:`pixel_size` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`shaded` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`transparent` | -+-----------------------------------------------------+------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`AlphaCutMode` | :ref:`alpha_cut` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| Vector3.Axis | :ref:`axis` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`centered` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`double_sided` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`flip_h` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`flip_v` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Color` | :ref:`modulate` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`offset` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`opacity` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`float` | :ref:`pixel_size` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaded` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`transparent` | ++-----------------------------------------------------+---------------------------------------------------------------+ Methods ------- -+------------------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+------------------------------------------+--------------------------------------------------------------------------------------------+ ++-----------------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | ++-----------------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | ++-----------------------------------------+---------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_SpriteBase3D_DrawFlags: +.. _class_SpriteBase3D_constant_FLAG_TRANSPARENT: + +.. _class_SpriteBase3D_constant_FLAG_SHADED: + +.. _class_SpriteBase3D_constant_FLAG_DOUBLE_SIDED: + +.. _class_SpriteBase3D_constant_FLAG_MAX: + enum **DrawFlags**: - **FLAG_TRANSPARENT** = **0** --- If set, the texture's transparency and the opacity are used to make those parts of the Sprite invisible. @@ -73,6 +81,12 @@ enum **DrawFlags**: .. _enum_SpriteBase3D_AlphaCutMode: +.. _class_SpriteBase3D_constant_ALPHA_CUT_DISABLED: + +.. _class_SpriteBase3D_constant_ALPHA_CUT_DISCARD: + +.. _class_SpriteBase3D_constant_ALPHA_CUT_OPAQUE_PREPASS: + enum **AlphaCutMode**: - **ALPHA_CUT_DISABLED** = **0** @@ -89,7 +103,7 @@ A node that displays 2D texture information in a 3D environment. Property Descriptions --------------------- -.. _class_SpriteBase3D_alpha_cut: +.. _class_SpriteBase3D_property_alpha_cut: - :ref:`AlphaCutMode` **alpha_cut** @@ -99,9 +113,9 @@ Property Descriptions | *Getter* | get_alpha_cut_mode() | +----------+---------------------------+ -.. _class_SpriteBase3D_axis: +.. _class_SpriteBase3D_property_axis: -- :ref:`Axis` **axis** +- Vector3.Axis **axis** +----------+-----------------+ | *Setter* | set_axis(value) | @@ -111,7 +125,7 @@ Property Descriptions The direction in which the front of the texture faces. -.. _class_SpriteBase3D_centered: +.. _class_SpriteBase3D_property_centered: - :ref:`bool` **centered** @@ -123,7 +137,7 @@ The direction in which the front of the texture faces. If ``true``, texture will be centered. Default value: ``true``. -.. _class_SpriteBase3D_double_sided: +.. _class_SpriteBase3D_property_double_sided: - :ref:`bool` **double_sided** @@ -135,7 +149,7 @@ If ``true``, texture will be centered. Default value: ``true``. If ``true``, texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. Default value: ``true``. -.. _class_SpriteBase3D_flip_h: +.. _class_SpriteBase3D_property_flip_h: - :ref:`bool` **flip_h** @@ -147,7 +161,7 @@ If ``true``, texture can be seen from the back as well, if ``false``, it is invi If ``true``, texture is flipped horizontally. Default value: ``false``. -.. _class_SpriteBase3D_flip_v: +.. _class_SpriteBase3D_property_flip_v: - :ref:`bool` **flip_v** @@ -159,7 +173,7 @@ If ``true``, texture is flipped horizontally. Default value: ``false``. If ``true``, texture is flipped vertically. Default value: ``false``. -.. _class_SpriteBase3D_modulate: +.. _class_SpriteBase3D_property_modulate: - :ref:`Color` **modulate** @@ -171,7 +185,7 @@ If ``true``, texture is flipped vertically. Default value: ``false``. A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. -.. _class_SpriteBase3D_offset: +.. _class_SpriteBase3D_property_offset: - :ref:`Vector2` **offset** @@ -183,7 +197,7 @@ A color value that gets multiplied on, could be used for mood-coloring or to sim The texture's drawing offset. -.. _class_SpriteBase3D_opacity: +.. _class_SpriteBase3D_property_opacity: - :ref:`float` **opacity** @@ -195,7 +209,7 @@ The texture's drawing offset. The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visible. -.. _class_SpriteBase3D_pixel_size: +.. _class_SpriteBase3D_property_pixel_size: - :ref:`float` **pixel_size** @@ -207,7 +221,7 @@ The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visi The size of one pixel's width on the Sprite to scale it in 3D. -.. _class_SpriteBase3D_shaded: +.. _class_SpriteBase3D_property_shaded: - :ref:`bool` **shaded** @@ -219,7 +233,7 @@ The size of one pixel's width on the Sprite to scale it in 3D. If ``true``, the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. -.. _class_SpriteBase3D_transparent: +.. _class_SpriteBase3D_property_transparent: - :ref:`bool` **transparent** @@ -234,11 +248,11 @@ If ``true``, the texture's transparency and the opacity are used to make those p Method Descriptions ------------------- -.. _class_SpriteBase3D_generate_triangle_mesh: +.. _class_SpriteBase3D_method_generate_triangle_mesh: - :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const -.. _class_SpriteBase3D_get_item_rect: +.. _class_SpriteBase3D_method_get_item_rect: - :ref:`Rect2` **get_item_rect** **(** **)** const diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 5dabb93d3..21767fb0f 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -19,46 +19,46 @@ Sprite frame library for AnimatedSprite. Properties ---------- -+---------------------------+------------------------------------------+ -| :ref:`Array` | :ref:`frames` | -+---------------------------+------------------------------------------+ ++---------------------------+---------------------------------------------------+ +| :ref:`Array` | :ref:`frames` | ++---------------------------+---------------------------------------------------+ Methods ------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_animation` **(** :ref:`String` anim **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` anim **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_animation_names` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_animation` **(** :ref:`String` anim **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` anim **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_animation_names` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -68,104 +68,104 @@ Sprite frame library for :ref:`AnimatedSprite`. Contains f Property Descriptions --------------------- -.. _class_SpriteFrames_frames: +.. _class_SpriteFrames_property_frames: - :ref:`Array` **frames** Method Descriptions ------------------- -.. _class_SpriteFrames_add_animation: +.. _class_SpriteFrames_method_add_animation: - void **add_animation** **(** :ref:`String` anim **)** Adds a new animation to the library. -.. _class_SpriteFrames_add_frame: +.. _class_SpriteFrames_method_add_frame: - void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** Adds a frame to the given animation. -.. _class_SpriteFrames_clear: +.. _class_SpriteFrames_method_clear: - void **clear** **(** :ref:`String` anim **)** Removes all frames from the given animation. -.. _class_SpriteFrames_clear_all: +.. _class_SpriteFrames_method_clear_all: - void **clear_all** **(** **)** Removes all animations. A "default" animation will be created. -.. _class_SpriteFrames_get_animation_loop: +.. _class_SpriteFrames_method_get_animation_loop: - :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** const If ``true``, the given animation will loop. -.. _class_SpriteFrames_get_animation_names: +.. _class_SpriteFrames_method_get_animation_names: - :ref:`PoolStringArray` **get_animation_names** **(** **)** const Returns an array containing the names associated to each animation. Values are placed in alphabetical order. -.. _class_SpriteFrames_get_animation_speed: +.. _class_SpriteFrames_method_get_animation_speed: - :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const The animation's speed in frames per second. -.. _class_SpriteFrames_get_frame: +.. _class_SpriteFrames_method_get_frame: - :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const Returns the animation's selected frame. -.. _class_SpriteFrames_get_frame_count: +.. _class_SpriteFrames_method_get_frame_count: - :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** const Returns the number of frames in the animation. -.. _class_SpriteFrames_has_animation: +.. _class_SpriteFrames_method_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const If ``true``, the named animation exists. -.. _class_SpriteFrames_remove_animation: +.. _class_SpriteFrames_method_remove_animation: - void **remove_animation** **(** :ref:`String` anim **)** Removes the given animation. -.. _class_SpriteFrames_remove_frame: +.. _class_SpriteFrames_method_remove_frame: - void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** Removes the animation's selected frame. -.. _class_SpriteFrames_rename_animation: +.. _class_SpriteFrames_method_rename_animation: - void **rename_animation** **(** :ref:`String` anim, :ref:`String` newname **)** Changes the animation's name to ``newname``. -.. _class_SpriteFrames_set_animation_loop: +.. _class_SpriteFrames_method_set_animation_loop: - void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** If ``true``, the animation will loop. -.. _class_SpriteFrames_set_animation_speed: +.. _class_SpriteFrames_method_set_animation_speed: - void **set_animation_speed** **(** :ref:`String` anim, :ref:`float` speed **)** The animation's speed in frames per second. -.. _class_SpriteFrames_set_frame: +.. _class_SpriteFrames_method_set_frame: - void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index cdae67f8f..3ac1dcc38 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -19,17 +19,17 @@ Static body for 3D physics. Properties ---------- -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`constant_angular_velocity` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`constant_linear_velocity` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | -+-----------------------------------------------+------------------------------------------------------------------------------+ ++-----------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bounce` | ++-----------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`constant_angular_velocity` | ++-----------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`constant_linear_velocity` | ++-----------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`friction` | ++-----------------------------------------------+---------------------------------------------------------------------------------------+ +| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | ++-----------------------------------------------+---------------------------------------------------------------------------------------+ Description ----------- @@ -43,7 +43,7 @@ Alternatively, a constant linear or angular velocity can be set for the static b Property Descriptions --------------------- -.. _class_StaticBody_bounce: +.. _class_StaticBody_property_bounce: - :ref:`float` **bounce** @@ -55,7 +55,7 @@ Property Descriptions The body bounciness. -.. _class_StaticBody_constant_angular_velocity: +.. _class_StaticBody_property_constant_angular_velocity: - :ref:`Vector3` **constant_angular_velocity** @@ -67,7 +67,7 @@ The body bounciness. The constant angular velocity for the body. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. -.. _class_StaticBody_constant_linear_velocity: +.. _class_StaticBody_property_constant_linear_velocity: - :ref:`Vector3` **constant_linear_velocity** @@ -79,7 +79,7 @@ The constant angular velocity for the body. This does not rotate the body, but a The constant linear velocity for the body. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. -.. _class_StaticBody_friction: +.. _class_StaticBody_property_friction: - :ref:`float` **friction** @@ -91,7 +91,7 @@ The constant linear velocity for the body. This does not move the body, but affe The body friction, from 0 (frictionless) to 1 (full friction). -.. _class_StaticBody_physics_material_override: +.. _class_StaticBody_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index a3f88b29d..882e87e8f 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -19,17 +19,17 @@ Static body for 2D Physics. Properties ---------- -+-----------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`bounce` | -+-----------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`constant_angular_velocity` | -+-----------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`constant_linear_velocity` | -+-----------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`friction` | -+-----------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | -+-----------------------------------------------+--------------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bounce` | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`constant_angular_velocity` | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`constant_linear_velocity` | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`friction` | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`PhysicsMaterial` | :ref:`physics_material_override` | ++-----------------------------------------------+-----------------------------------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ Additionally, a constant linear or angular velocity can be set for the static bo Property Descriptions --------------------- -.. _class_StaticBody2D_bounce: +.. _class_StaticBody2D_property_bounce: - :ref:`float` **bounce** @@ -53,7 +53,7 @@ Property Descriptions The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). -.. _class_StaticBody2D_constant_angular_velocity: +.. _class_StaticBody2D_property_constant_angular_velocity: - :ref:`float` **constant_angular_velocity** @@ -65,7 +65,7 @@ The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounci Constant angular velocity for the body. This does not rotate the body, but affects colliding bodies, as if it were rotating. -.. _class_StaticBody2D_constant_linear_velocity: +.. _class_StaticBody2D_property_constant_linear_velocity: - :ref:`Vector2` **constant_linear_velocity** @@ -77,7 +77,7 @@ Constant angular velocity for the body. This does not rotate the body, but affec Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. -.. _class_StaticBody2D_friction: +.. _class_StaticBody2D_property_friction: - :ref:`float` **friction** @@ -89,7 +89,7 @@ Constant linear velocity for the body. This does not move the body, but affects The body's friction. Values range from ``0`` (no friction) to ``1`` (full friction). -.. _class_StaticBody2D_physics_material_override: +.. _class_StaticBody2D_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index b8c82c98e..b9036553d 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -21,76 +21,76 @@ Abstraction and base class for stream-based protocols. Properties ---------- -+-------------------------+------------------------------------------------+ -| :ref:`bool` | :ref:`big_endian` | -+-------------------------+------------------------------------------------+ ++-------------------------+---------------------------------------------------------+ +| :ref:`bool` | :ref:`big_endian` | ++-------------------------+---------------------------------------------------------+ Methods ------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_bytes` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes=-1 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u16` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u32` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u64` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u8` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes=-1 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_16` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_32` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_64` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_8` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_double` **(** :ref:`float` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_float` **(** :ref:`float` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_string` **(** :ref:`String` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u16` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u32` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u64` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u8` **(** :ref:`int` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_utf8_string` **(** :ref:`String` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_var` **(** :ref:`Variant` value **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_16` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_32` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_64` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_8` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_bytes` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_double` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_float` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes=-1 **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u16` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u32` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u64` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u8` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes=-1 **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_16` **(** :ref:`int` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_32` **(** :ref:`int` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_64` **(** :ref:`int` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_8` **(** :ref:`int` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_double` **(** :ref:`float` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_float` **(** :ref:`float` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_string` **(** :ref:`String` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u16` **(** :ref:`int` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u32` **(** :ref:`int` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u64` **(** :ref:`int` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u8` **(** :ref:`int` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_utf8_string` **(** :ref:`String` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_var` **(** :ref:`Variant` value **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -100,7 +100,7 @@ StreamPeer is an abstraction and base class for stream-based protocols (such as Property Descriptions --------------------- -.. _class_StreamPeer_big_endian: +.. _class_StreamPeer_property_big_endian: - :ref:`bool` **big_endian** @@ -115,187 +115,187 @@ If ``true``, this ``StreamPeer`` will using big-endian format for encoding and d Method Descriptions ------------------- -.. _class_StreamPeer_get_16: +.. _class_StreamPeer_method_get_16: - :ref:`int` **get_16** **(** **)** Get a signed 16 bit value from the stream. -.. _class_StreamPeer_get_32: +.. _class_StreamPeer_method_get_32: - :ref:`int` **get_32** **(** **)** Get a signed 32 bit value from the stream. -.. _class_StreamPeer_get_64: +.. _class_StreamPeer_method_get_64: - :ref:`int` **get_64** **(** **)** Get a signed 64 bit value from the stream. -.. _class_StreamPeer_get_8: +.. _class_StreamPeer_method_get_8: - :ref:`int` **get_8** **(** **)** Get a signed byte from the stream. -.. _class_StreamPeer_get_available_bytes: +.. _class_StreamPeer_method_get_available_bytes: - :ref:`int` **get_available_bytes** **(** **)** const Return the amount of bytes this ``StreamPeer`` has available. -.. _class_StreamPeer_get_data: +.. _class_StreamPeer_method_get_data: - :ref:`Array` **get_data** **(** :ref:`int` bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. -.. _class_StreamPeer_get_double: +.. _class_StreamPeer_method_get_double: - :ref:`float` **get_double** **(** **)** Get a double-precision float from the stream. -.. _class_StreamPeer_get_float: +.. _class_StreamPeer_method_get_float: - :ref:`float` **get_float** **(** **)** Get a single-precision float from the stream. -.. _class_StreamPeer_get_partial_data: +.. _class_StreamPeer_method_get_partial_data: - :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. -.. _class_StreamPeer_get_string: +.. _class_StreamPeer_method_get_string: - :ref:`String` **get_string** **(** :ref:`int` bytes=-1 **)** -Get a string with byte-length ``bytes`` from the stream. If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_string`. +Get a string with byte-length ``bytes`` from the stream. If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_string`. -.. _class_StreamPeer_get_u16: +.. _class_StreamPeer_method_get_u16: - :ref:`int` **get_u16** **(** **)** Get an unsigned 16 bit value from the stream. -.. _class_StreamPeer_get_u32: +.. _class_StreamPeer_method_get_u32: - :ref:`int` **get_u32** **(** **)** Get an unsigned 32 bit value from the stream. -.. _class_StreamPeer_get_u64: +.. _class_StreamPeer_method_get_u64: - :ref:`int` **get_u64** **(** **)** Get an unsigned 64 bit value from the stream. -.. _class_StreamPeer_get_u8: +.. _class_StreamPeer_method_get_u8: - :ref:`int` **get_u8** **(** **)** Get an unsigned byte from the stream. -.. _class_StreamPeer_get_utf8_string: +.. _class_StreamPeer_method_get_utf8_string: - :ref:`String` **get_utf8_string** **(** :ref:`int` bytes=-1 **)** -Get a utf8 string with byte-length ``bytes`` from the stream (this decodes the string sent as utf8). If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_utf8_string`. +Get a utf8 string with byte-length ``bytes`` from the stream (this decodes the string sent as utf8). If ``bytes`` is negative (default) the length will be read from the stream using the reverse process of :ref:`put_utf8_string`. -.. _class_StreamPeer_get_var: +.. _class_StreamPeer_method_get_var: - :ref:`Variant` **get_var** **(** **)** Get a Variant from the stream. -.. _class_StreamPeer_put_16: +.. _class_StreamPeer_method_put_16: - void **put_16** **(** :ref:`int` value **)** Put a signed 16 bit value into the stream. -.. _class_StreamPeer_put_32: +.. _class_StreamPeer_method_put_32: - void **put_32** **(** :ref:`int` value **)** Put a signed 32 bit value into the stream. -.. _class_StreamPeer_put_64: +.. _class_StreamPeer_method_put_64: - void **put_64** **(** :ref:`int` value **)** Put a signed 64 bit value into the stream. -.. _class_StreamPeer_put_8: +.. _class_StreamPeer_method_put_8: - void **put_8** **(** :ref:`int` value **)** Put a signed byte into the stream. -.. _class_StreamPeer_put_data: +.. _class_StreamPeer_method_put_data: - :ref:`Error` **put_data** **(** :ref:`PoolByteArray` data **)** Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. -.. _class_StreamPeer_put_double: +.. _class_StreamPeer_method_put_double: - void **put_double** **(** :ref:`float` value **)** Put a double-precision float into the stream. -.. _class_StreamPeer_put_float: +.. _class_StreamPeer_method_put_float: - void **put_float** **(** :ref:`float` value **)** Put a single-precision float into the stream. -.. _class_StreamPeer_put_partial_data: +.. _class_StreamPeer_method_put_partial_data: - :ref:`Array` **put_partial_data** **(** :ref:`PoolByteArray` data **)** Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. -.. _class_StreamPeer_put_string: +.. _class_StreamPeer_method_put_string: - void **put_string** **(** :ref:`String` value **)** Put a zero-terminated ascii string into the stream prepended by a 32 bits unsigned integer representing its size. -.. _class_StreamPeer_put_u16: +.. _class_StreamPeer_method_put_u16: - void **put_u16** **(** :ref:`int` value **)** Put an unsigned 16 bit value into the stream. -.. _class_StreamPeer_put_u32: +.. _class_StreamPeer_method_put_u32: - void **put_u32** **(** :ref:`int` value **)** Put an unsigned 32 bit value into the stream. -.. _class_StreamPeer_put_u64: +.. _class_StreamPeer_method_put_u64: - void **put_u64** **(** :ref:`int` value **)** Put an unsigned 64 bit value into the stream. -.. _class_StreamPeer_put_u8: +.. _class_StreamPeer_method_put_u8: - void **put_u8** **(** :ref:`int` value **)** Put an unsigned byte into the stream. -.. _class_StreamPeer_put_utf8_string: +.. _class_StreamPeer_method_put_utf8_string: - void **put_utf8_string** **(** :ref:`String` value **)** Put a zero-terminated utf8 string into the stream prepended by a 32 bits unsigned integer representing its size. -.. _class_StreamPeer_put_var: +.. _class_StreamPeer_method_put_var: - void **put_var** **(** :ref:`Variant` value **)** diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 6a906a39a..647d9b765 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -19,31 +19,31 @@ Brief Description Properties ---------- -+-------------------------------------------+------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`data_array` | -+-------------------------------------------+------------------------------------------------------+ ++-------------------------------------------+---------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`data_array` | ++-------------------------------------------+---------------------------------------------------------------+ Methods ------- -+--------------------------------------------------+-------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_size` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` size **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` position **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | ++-------------------------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position` **(** **)** const | ++-------------------------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_size` **(** **)** const | ++-------------------------------------------------+--------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` size **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`int` position **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_StreamPeerBuffer_data_array: +.. _class_StreamPeerBuffer_property_data_array: - :ref:`PoolByteArray` **data_array** @@ -56,27 +56,27 @@ Property Descriptions Method Descriptions ------------------- -.. _class_StreamPeerBuffer_clear: +.. _class_StreamPeerBuffer_method_clear: - void **clear** **(** **)** -.. _class_StreamPeerBuffer_duplicate: +.. _class_StreamPeerBuffer_method_duplicate: - :ref:`StreamPeerBuffer` **duplicate** **(** **)** const -.. _class_StreamPeerBuffer_get_position: +.. _class_StreamPeerBuffer_method_get_position: - :ref:`int` **get_position** **(** **)** const -.. _class_StreamPeerBuffer_get_size: +.. _class_StreamPeerBuffer_method_get_size: - :ref:`int` **get_size** **(** **)** const -.. _class_StreamPeerBuffer_resize: +.. _class_StreamPeerBuffer_method_resize: - void **resize** **(** :ref:`int` size **)** -.. _class_StreamPeerBuffer_seek: +.. _class_StreamPeerBuffer_method_seek: - void **seek** **(** :ref:`int` position **)** diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index dd123825b..5b11b3a1f 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -19,30 +19,40 @@ SSL Stream peer. Properties ---------- -+-------------------------+-------------------------------------------------------------------+ -| :ref:`bool` | :ref:`blocking_handshake` | -+-------------------------+-------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`blocking_handshake` | ++-------------------------+----------------------------------------------------------------------------+ Methods ------- -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` base **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_from_stream` **(** **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** const | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`poll` **(** **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` base **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_stream` **(** **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Status` | :ref:`get_status` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`poll` **(** **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_StreamPeerSSL_Status: +.. _class_StreamPeerSSL_constant_STATUS_DISCONNECTED: + +.. _class_StreamPeerSSL_constant_STATUS_HANDSHAKING: + +.. _class_StreamPeerSSL_constant_STATUS_CONNECTED: + +.. _class_StreamPeerSSL_constant_STATUS_ERROR: + +.. _class_StreamPeerSSL_constant_STATUS_ERROR_HOSTNAME_MISMATCH: + enum **Status**: - **STATUS_DISCONNECTED** = **0** --- A status representing a ``StreamPeerSSL`` that is disconnected. @@ -68,7 +78,7 @@ Tutorials Property Descriptions --------------------- -.. _class_StreamPeerSSL_blocking_handshake: +.. _class_StreamPeerSSL_property_blocking_handshake: - :ref:`bool` **blocking_handshake** @@ -81,29 +91,29 @@ Property Descriptions Method Descriptions ------------------- -.. _class_StreamPeerSSL_accept_stream: +.. _class_StreamPeerSSL_method_accept_stream: - :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` base **)** -.. _class_StreamPeerSSL_connect_to_stream: +.. _class_StreamPeerSSL_method_connect_to_stream: - :ref:`Error` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** Connect to a peer using an underlying :ref:`StreamPeer` "stream", when "validate_certs" is true, ``StreamPeerSSL`` will validate that the certificate presented by the peer matches the "for_hostname". -.. _class_StreamPeerSSL_disconnect_from_stream: +.. _class_StreamPeerSSL_method_disconnect_from_stream: - void **disconnect_from_stream** **(** **)** Disconnect from host. -.. _class_StreamPeerSSL_get_status: +.. _class_StreamPeerSSL_method_get_status: - :ref:`Status` **get_status** **(** **)** const Return the status of the connection, one of STATUS\_\* enum. -.. _class_StreamPeerSSL_poll: +.. _class_StreamPeerSSL_method_poll: - void **poll** **(** **)** diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 1b1777d13..5f258a6b1 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -19,27 +19,35 @@ TCP Stream peer. Methods ------- -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_from_host` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connected_port` **(** **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_no_delay` **(** :ref:`bool` enabled **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_host` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connected_host` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connected_port` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Status` | :ref:`get_status` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_no_delay` **(** :ref:`bool` enabled **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_StreamPeerTCP_Status: +.. _class_StreamPeerTCP_constant_STATUS_NONE: + +.. _class_StreamPeerTCP_constant_STATUS_CONNECTING: + +.. _class_StreamPeerTCP_constant_STATUS_CONNECTED: + +.. _class_StreamPeerTCP_constant_STATUS_ERROR: + enum **Status**: - **STATUS_NONE** = **0** --- The initial status of the ``StreamPeerTCP``, also the status after a disconnect. @@ -58,43 +66,43 @@ TCP Stream peer. This object can be used to connect to TCP servers, or also is r Method Descriptions ------------------- -.. _class_StreamPeerTCP_connect_to_host: +.. _class_StreamPeerTCP_method_connect_to_host: - :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** Connect to the specified host:port pair. A hostname will be resolved if valid. Returns ``OK`` on success or ``FAILED`` on failure. -.. _class_StreamPeerTCP_disconnect_from_host: +.. _class_StreamPeerTCP_method_disconnect_from_host: - void **disconnect_from_host** **(** **)** Disconnect from host. -.. _class_StreamPeerTCP_get_connected_host: +.. _class_StreamPeerTCP_method_get_connected_host: - :ref:`String` **get_connected_host** **(** **)** const Return the IP of this peer. -.. _class_StreamPeerTCP_get_connected_port: +.. _class_StreamPeerTCP_method_get_connected_port: - :ref:`int` **get_connected_port** **(** **)** const Return the port of this peer. -.. _class_StreamPeerTCP_get_status: +.. _class_StreamPeerTCP_method_get_status: - :ref:`Status` **get_status** **(** **)** Return the status of the connection, see :ref:`Status`. -.. _class_StreamPeerTCP_is_connected_to_host: +.. _class_StreamPeerTCP_method_is_connected_to_host: - :ref:`bool` **is_connected_to_host** **(** **)** const Returns ``true`` if this peer is currently connected to a host, ``false[code] otherwise. -.. _class_StreamPeerTCP_set_no_delay: +.. _class_StreamPeerTCP_method_set_no_delay: - void **set_no_delay** **(** :ref:`bool` enabled **)** diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index ba4069980..8e179bf1a 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -19,9 +19,9 @@ A .stex texture. Properties ---------- -+-----------------------------+-------------------------------------------------+ -| :ref:`String` | :ref:`load_path` | -+-----------------------------+-------------------------------------------------+ ++-----------------------------+----------------------------------------------------------+ +| :ref:`String` | :ref:`load_path` | ++-----------------------------+----------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ A texture that is loaded from a .stex file. Property Descriptions --------------------- -.. _class_StreamTexture_load_path: +.. _class_StreamTexture_property_load_path: - :ref:`String` **load_path** diff --git a/classes/class_string.rst b/classes/class_string.rst index 97ae78097..d192f0a26 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -17,195 +17,195 @@ Built-in string class. Methods ------- -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`AABB` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolByteArray` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolIntArray` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolRealArray` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolStringArray` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolVector2Array` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolVector3Array` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolColorArray` from **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`bigrams` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_escape` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_unescape` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`capitalize` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`dedent` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`format` **(** :ref:`Variant` values, :ref:`String` placeholder={_} **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_dir` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_basename` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_extension` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hex_to_int` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_abs_path` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rel_path` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_float` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_hex_number` **(** :ref:`bool` with_prefix=False **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_integer` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`json_escape` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`length` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`lstrip` **(** :ref:`String` chars **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`md5_buffer` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`md5_text` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_decode` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_encode` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`rsplit` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rstrip` **(** :ref:`String` chars **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sha256_text` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`split` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`split_floats` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`to_float` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_int` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_lower` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_upper` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`to_utf8` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_escape` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_unescape` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`AABB` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolByteArray` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolIntArray` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolRealArray` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolStringArray` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolVector2Array` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolVector3Array` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PoolColorArray` from **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`bigrams` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`c_escape` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`c_unescape` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`capitalize` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`dedent` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`format` **(** :ref:`Variant` values, :ref:`String` placeholder={_} **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_dir` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_basename` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_extension` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hex_to_int` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_abs_path` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_rel_path` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_float` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_hex_number` **(** :ref:`bool` with_prefix=False **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_integer` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`json_escape` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`length` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`lstrip` **(** :ref:`String` chars **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`md5_buffer` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`md5_text` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`percent_decode` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`percent_encode` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`rsplit` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rstrip` **(** :ref:`String` chars **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sha256_text` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`split` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`split_floats` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`to_float` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_int` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_lower` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_upper` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`to_utf8` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`xml_escape` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`xml_unescape` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -215,457 +215,411 @@ This is the built-in string class (and the one used by GDScript). It supports Un Method Descriptions ------------------- -.. _class_String_String: +.. _class_String_method_String: - :ref:`String` **String** **(** :ref:`bool` from **)** Constructs a new String from the given :ref:`bool`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`int` from **)** Constructs a new String from the given :ref:`int`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`float` from **)** Constructs a new String from the given :ref:`float`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Vector2` from **)** Constructs a new String from the given :ref:`Vector2`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Rect2` from **)** Constructs a new String from the given :ref:`Rect2`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Vector3` from **)** Constructs a new String from the given :ref:`Vector3`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Transform2D` from **)** Constructs a new String from the given :ref:`Transform2D`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Plane` from **)** Constructs a new String from the given :ref:`Plane`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Quat` from **)** Constructs a new String from the given :ref:`Quat`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`AABB` from **)** Constructs a new String from the given :ref:`AABB`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Basis` from **)** Constructs a new String from the given :ref:`Basis`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Transform` from **)** Constructs a new String from the given :ref:`Transform`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Color` from **)** Constructs a new String from the given :ref:`Color`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`NodePath` from **)** Constructs a new String from the given :ref:`NodePath`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`RID` from **)** Constructs a new String from the given :ref:`RID`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Dictionary` from **)** Constructs a new String from the given :ref:`Dictionary`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Array` from **)** Constructs a new String from the given :ref:`Array`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** Constructs a new String from the given :ref:`PoolByteArray`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** Constructs a new String from the given :ref:`PoolIntArray`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** Constructs a new String from the given :ref:`PoolRealArray`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** Constructs a new String from the given :ref:`PoolStringArray`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** Constructs a new String from the given :ref:`PoolVector2Array`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** Constructs a new String from the given :ref:`PoolVector3Array`. -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** Constructs a new String from the given :ref:`PoolColorArray`. -.. _class_String_begins_with: +.. _class_String_method_begins_with: - :ref:`bool` **begins_with** **(** :ref:`String` text **)** Returns ``true`` if the string begins with the given string. -.. _class_String_bigrams: +.. _class_String_method_bigrams: - :ref:`PoolStringArray` **bigrams** **(** **)** Returns the bigrams (pairs of consecutive letters) of this string. -.. _class_String_c_escape: +.. _class_String_method_c_escape: - :ref:`String` **c_escape** **(** **)** Returns a copy of the string with special characters escaped using the C language standard. -.. _class_String_c_unescape: +.. _class_String_method_c_unescape: - :ref:`String` **c_unescape** **(** **)** Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard. -.. _class_String_capitalize: +.. _class_String_method_capitalize: - :ref:`String` **capitalize** **(** **)** Changes the case of some letters. Replaces underscores with spaces, converts all letters to lowercase, then capitalizes first and every letter following the space character. For ``capitalize camelCase mixed_with_underscores`` it will return ``Capitalize Camelcase Mixed With Underscores``. -.. _class_String_casecmp_to: +.. _class_String_method_casecmp_to: - :ref:`int` **casecmp_to** **(** :ref:`String` to **)** Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal. -.. _class_String_dedent: +.. _class_String_method_dedent: - :ref:`String` **dedent** **(** **)** Removes indentation from string. -.. _class_String_empty: +.. _class_String_method_empty: - :ref:`bool` **empty** **(** **)** Returns ``true`` if the string is empty. -.. _class_String_ends_with: +.. _class_String_method_ends_with: - :ref:`bool` **ends_with** **(** :ref:`String` text **)** Returns ``true`` if the string ends with the given string. -.. _class_String_erase: +.. _class_String_method_erase: - void **erase** **(** :ref:`int` position, :ref:`int` chars **)** Erases ``chars`` characters from the string starting from ``position``. -.. _class_String_find: +.. _class_String_method_find: - :ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** Finds the first occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. -.. _class_String_find_last: +.. _class_String_method_find_last: - :ref:`int` **find_last** **(** :ref:`String` what **)** Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. -.. _class_String_findn: +.. _class_String_method_findn: - :ref:`int` **findn** **(** :ref:`String` what, :ref:`int` from=0 **)** Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. -.. _class_String_format: +.. _class_String_method_format: - :ref:`String` **format** **(** :ref:`Variant` values, :ref:`String` placeholder={_} **)** Formats the string by replacing all occurrences of ``placeholder`` with ``values``. -.. _class_String_get_base_dir: +.. _class_String_method_get_base_dir: - :ref:`String` **get_base_dir** **(** **)** If the string is a valid file path, returns the base directory name. -.. _class_String_get_basename: +.. _class_String_method_get_basename: - :ref:`String` **get_basename** **(** **)** If the string is a valid file path, returns the full file path without the extension. -.. _class_String_get_extension: +.. _class_String_method_get_extension: - :ref:`String` **get_extension** **(** **)** If the string is a valid file path, returns the extension. -.. _class_String_get_file: +.. _class_String_method_get_file: - :ref:`String` **get_file** **(** **)** If the string is a valid file path, returns the filename. -.. _class_String_hash: +.. _class_String_method_hash: - :ref:`int` **hash** **(** **)** Hashes the string and returns a 32-bit integer. -.. _class_String_hex_to_int: +.. _class_String_method_hex_to_int: - :ref:`int` **hex_to_int** **(** **)** Converts a string containing a hexadecimal number into an integer. -.. _class_String_insert: +.. _class_String_method_insert: - :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** Inserts a substring at a given position. -.. _class_String_is_abs_path: +.. _class_String_method_is_abs_path: - :ref:`bool` **is_abs_path** **(** **)** If the string is a path to a file or directory, returns ``true`` if the path is absolute. -.. _class_String_is_rel_path: +.. _class_String_method_is_rel_path: - :ref:`bool` **is_rel_path** **(** **)** If the string is a path to a file or directory, returns ``true`` if the path is relative. -.. _class_String_is_subsequence_of: +.. _class_String_method_is_subsequence_of: - :ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** Returns ``true`` if this string is a subsequence of the given string. -.. _class_String_is_subsequence_ofi: +.. _class_String_method_is_subsequence_ofi: - :ref:`bool` **is_subsequence_ofi** **(** :ref:`String` text **)** Returns ``true`` if this string is a subsequence of the given string, without considering case. -.. _class_String_is_valid_float: +.. _class_String_method_is_valid_float: - :ref:`bool` **is_valid_float** **(** **)** Returns ``true`` if this string contains a valid float. -.. _class_String_is_valid_hex_number: +.. _class_String_method_is_valid_hex_number: - :ref:`bool` **is_valid_hex_number** **(** :ref:`bool` with_prefix=False **)** Returns ``true`` if this string contains a valid hexadecimal number. If ``with_prefix`` is ``true``, then a validity of the hexadecimal number is determined by ``0x`` prefix, for instance: ``0xDEADC0DE``. -.. _class_String_is_valid_html_color: +.. _class_String_method_is_valid_html_color: - :ref:`bool` **is_valid_html_color** **(** **)** Returns ``true`` if this string contains a valid color in HTML notation. -.. _class_String_is_valid_identifier: +.. _class_String_method_is_valid_identifier: - :ref:`bool` **is_valid_identifier** **(** **)** Returns ``true`` if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (``_``) and the first character may not be a digit. -.. _class_String_is_valid_integer: +.. _class_String_method_is_valid_integer: - :ref:`bool` **is_valid_integer** **(** **)** Returns ``true`` if this string contains a valid integer. -.. _class_String_is_valid_ip_address: +.. _class_String_method_is_valid_ip_address: - :ref:`bool` **is_valid_ip_address** **(** **)** Returns ``true`` if this string contains a valid IP address. -.. _class_String_json_escape: +.. _class_String_method_json_escape: - :ref:`String` **json_escape** **(** **)** Returns a copy of the string with special characters escaped using the JSON standard. -.. _class_String_left: +.. _class_String_method_left: - :ref:`String` **left** **(** :ref:`int` position **)** Returns a number of characters from the left of the string. -.. _class_String_length: +.. _class_String_method_length: - :ref:`int` **length** **(** **)** Returns the string's amount of characters. -.. _class_String_lstrip: +.. _class_String_method_lstrip: - :ref:`String` **lstrip** **(** :ref:`String` chars **)** Returns a copy of the string with characters removed from the left. -.. _class_String_match: +.. _class_String_method_match: - :ref:`bool` **match** **(** :ref:`String` expr **)** Does a simple expression match, where ``*`` matches zero or more arbitrary characters and ``?`` matches any single character except '.'. -.. _class_String_matchn: +.. _class_String_method_matchn: - :ref:`bool` **matchn** **(** :ref:`String` expr **)** -Does a simple case insensitive expression match, using ``?`` and ``*`` wildcards (see :ref:`match`). +Does a simple case insensitive expression match, using ``?`` and ``*`` wildcards (see :ref:`match`). -.. _class_String_md5_buffer: +.. _class_String_method_md5_buffer: - :ref:`PoolByteArray` **md5_buffer** **(** **)** Returns the MD5 hash of the string as an array of bytes. -.. _class_String_md5_text: +.. _class_String_method_md5_text: - :ref:`String` **md5_text** **(** **)** Returns the MD5 hash of the string as a string. -.. _class_String_nocasecmp_to: +.. _class_String_method_nocasecmp_to: - :ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** Performs a case-insensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal. -.. _class_String_ord_at: +.. _class_String_method_ord_at: - :ref:`int` **ord_at** **(** :ref:`int` at **)** Returns the character code at position ``at``. -.. _class_String_pad_decimals: +.. _class_String_method_pad_decimals: - :ref:`String` **pad_decimals** **(** :ref:`int` digits **)** Formats a number to have an exact number of ``digits`` after the decimal point. -.. _class_String_pad_zeros: +.. _class_String_method_pad_zeros: - :ref:`String` **pad_zeros** **(** :ref:`int` digits **)** Formats a number to have an exact number of ``digits`` before the decimal point. -.. _class_String_percent_decode: +.. _class_String_method_percent_decode: - :ref:`String` **percent_decode** **(** **)** -Decode a percent-encoded string. See :ref:`percent_encode`. +Decode a percent-encoded string. See :ref:`percent_encode`. -.. _class_String_percent_encode: +.. _class_String_method_percent_encode: - :ref:`String` **percent_encode** **(** **)** Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests). -.. _class_String_plus_file: +.. _class_String_method_plus_file: - :ref:`String` **plus_file** **(** :ref:`String` file **)** If the string is a path, this concatenates ``file`` at the end of the string as a subpath. E.g. ``"this/is".plus_file("path") == "this/is/path"``. -.. _class_String_replace: +.. _class_String_method_replace: - :ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** Replaces occurrences of a substring with the given one inside the string. -.. _class_String_replacen: +.. _class_String_method_replacen: - :ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** Replaces occurrences of a substring with the given one inside the string. Ignores case. -.. _class_String_rfind: +.. _class_String_method_rfind: - :ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** Performs a search for a substring, but starts from the end of the string instead of the beginning. -.. _class_String_rfindn: +.. _class_String_method_rfindn: - :ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case. -.. _class_String_right: +.. _class_String_method_right: - :ref:`String` **right** **(** :ref:`int` position **)** Returns the right side of the string from a given position. -.. _class_String_rsplit: +.. _class_String_method_rsplit: - :ref:`PoolStringArray` **rsplit** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** @@ -675,31 +629,31 @@ Splits the string by a ``divisor`` string and returns an array of the substrings If ``maxsplit`` is specified, then it is number of splits to do, default is 0 which splits all the items. -.. _class_String_rstrip: +.. _class_String_method_rstrip: - :ref:`String` **rstrip** **(** :ref:`String` chars **)** Returns a copy of the string with characters removed from the right. -.. _class_String_sha256_buffer: +.. _class_String_method_sha256_buffer: - :ref:`PoolByteArray` **sha256_buffer** **(** **)** Returns the SHA-256 hash of the string as an array of bytes. -.. _class_String_sha256_text: +.. _class_String_method_sha256_text: - :ref:`String` **sha256_text** **(** **)** Returns the SHA-256 hash of the string as a string. -.. _class_String_similarity: +.. _class_String_method_similarity: - :ref:`float` **similarity** **(** :ref:`String` text **)** Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. -.. _class_String_split: +.. _class_String_method_split: - :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** @@ -709,7 +663,7 @@ Splits the string by a divisor string and returns an array of the substrings. If ``maxsplit`` is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements) -.. _class_String_split_floats: +.. _class_String_method_split_floats: - :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** @@ -717,73 +671,73 @@ Splits the string in floats by using a divisor string and returns an array of th **Example:** ``"1,2.5,3"`` will return ``[1,2.5,3]`` if split by ``","``. -.. _class_String_strip_edges: +.. _class_String_method_strip_edges: - :ref:`String` **strip_edges** **(** :ref:`bool` left=True, :ref:`bool` right=True **)** Returns a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. -.. _class_String_substr: +.. _class_String_method_substr: - :ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len **)** Returns part of the string from the position ``from`` with length ``len``. -.. _class_String_to_ascii: +.. _class_String_method_to_ascii: - :ref:`PoolByteArray` **to_ascii** **(** **)** -Converts the String (which is a character array) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is sped up in comparison to :ref:`to_utf8` with the assumption that all the characters the String contains are only ASCII characters. +Converts the String (which is a character array) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is sped up in comparison to :ref:`to_utf8` with the assumption that all the characters the String contains are only ASCII characters. -.. _class_String_to_float: +.. _class_String_method_to_float: - :ref:`float` **to_float** **(** **)** Converts a string containing a decimal number into a ``float``. -.. _class_String_to_int: +.. _class_String_method_to_int: - :ref:`int` **to_int** **(** **)** Converts a string containing an integer number into an ``int``. -.. _class_String_to_lower: +.. _class_String_method_to_lower: - :ref:`String` **to_lower** **(** **)** Returns the string converted to lowercase. -.. _class_String_to_upper: +.. _class_String_method_to_upper: - :ref:`String` **to_upper** **(** **)** Returns the string converted to uppercase. -.. _class_String_to_utf8: +.. _class_String_method_to_utf8: - :ref:`PoolByteArray` **to_utf8** **(** **)** -Converts the String (which is an array of characters) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is a bit slower than :ref:`to_ascii`, but supports all UTF-8 characters. Therefore, you should prefer this function over :ref:`to_ascii`. +Converts the String (which is an array of characters) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is a bit slower than :ref:`to_ascii`, but supports all UTF-8 characters. Therefore, you should prefer this function over :ref:`to_ascii`. -.. _class_String_trim_prefix: +.. _class_String_method_trim_prefix: - :ref:`String` **trim_prefix** **(** :ref:`String` prefix **)** Removes a given string from the start if it starts with it or leaves the string unchanged. -.. _class_String_trim_suffix: +.. _class_String_method_trim_suffix: - :ref:`String` **trim_suffix** **(** :ref:`String` suffix **)** Removes a given string from the end if it ends with it or leaves the string unchanged. -.. _class_String_xml_escape: +.. _class_String_method_xml_escape: - :ref:`String` **xml_escape** **(** **)** Returns a copy of the string with special characters escaped using the XML standard. -.. _class_String_xml_unescape: +.. _class_String_method_xml_unescape: - :ref:`String` **xml_unescape** **(** **)** diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 37d7bff2c..2bc4a0a3e 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -21,32 +21,32 @@ Base class for drawing stylized boxes for the UI. Properties ---------- -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`content_margin_bottom` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`content_margin_left` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`content_margin_right` | -+---------------------------+--------------------------------------------------------------------+ -| :ref:`float` | :ref:`content_margin_top` | -+---------------------------+--------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`content_margin_bottom` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`content_margin_left` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`content_margin_right` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`content_margin_top` | ++---------------------------+-----------------------------------------------------------------------------+ Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_center_size` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`Margin` margin **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_center_size` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** :ref:`Margin` margin **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -56,7 +56,7 @@ StyleBox is :ref:`Resource` that provides an abstract base class Property Descriptions --------------------- -.. _class_StyleBox_content_margin_bottom: +.. _class_StyleBox_property_content_margin_bottom: - :ref:`float` **content_margin_bottom** @@ -66,7 +66,7 @@ Property Descriptions | *Getter* | get_default_margin() | +----------+---------------------------+ -.. _class_StyleBox_content_margin_left: +.. _class_StyleBox_property_content_margin_left: - :ref:`float` **content_margin_left** @@ -76,7 +76,7 @@ Property Descriptions | *Getter* | get_default_margin() | +----------+---------------------------+ -.. _class_StyleBox_content_margin_right: +.. _class_StyleBox_property_content_margin_right: - :ref:`float` **content_margin_right** @@ -86,7 +86,7 @@ Property Descriptions | *Getter* | get_default_margin() | +----------+---------------------------+ -.. _class_StyleBox_content_margin_top: +.. _class_StyleBox_property_content_margin_top: - :ref:`float` **content_margin_top** @@ -99,33 +99,33 @@ Property Descriptions Method Descriptions ------------------- -.. _class_StyleBox_draw: +.. _class_StyleBox_method_draw: - void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const -.. _class_StyleBox_get_center_size: +.. _class_StyleBox_method_get_center_size: - :ref:`Vector2` **get_center_size** **(** **)** const -.. _class_StyleBox_get_margin: +.. _class_StyleBox_method_get_margin: - :ref:`float` **get_margin** **(** :ref:`Margin` margin **)** const Return the offset of margin "margin" (see MARGIN\_\* enum). -.. _class_StyleBox_get_minimum_size: +.. _class_StyleBox_method_get_minimum_size: - :ref:`Vector2` **get_minimum_size** **(** **)** const Return the minimum size that this stylebox can be shrunk to. -.. _class_StyleBox_get_offset: +.. _class_StyleBox_method_get_offset: - :ref:`Vector2` **get_offset** **(** **)** const Return the "offset" of a stylebox, this is a helper function, like writing ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``. -.. _class_StyleBox_test_mask: +.. _class_StyleBox_method_test_mask: - :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 3e8686876..dc7275302 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -19,66 +19,66 @@ Customizable Stylebox with a given set of parameters. (no texture required) Properties ---------- -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`anti_aliasing` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`anti_aliasing_size` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`bg_color` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`border_blend` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`border_color` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_bottom` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_left` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_right` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_top` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_detail` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_bottom_left` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_bottom_right` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_top_left` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_top_right` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_center` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_bottom` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_left` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_right` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_top` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`shadow_color` | -+---------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_size` | -+---------------------------+----------------------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`anti_aliasing` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`anti_aliasing_size` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`bg_color` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`border_blend` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`border_color` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`border_width_bottom` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`border_width_left` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`border_width_right` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`border_width_top` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_detail` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_radius_bottom_left` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_radius_bottom_right` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_radius_top_left` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_radius_top_right` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`draw_center` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_bottom` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_left` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_right` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_top` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`shadow_color` | ++---------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shadow_size` | ++---------------------------+-------------------------------------------------------------------------------------------+ Methods ------- -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_width_min` **(** **)** const | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius_individual` **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_border_width_min` **(** **)** const | ++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | ++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | ++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius_individual` **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** | ++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | ++-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -111,7 +111,7 @@ The relative system now would take the 1:2 ratio of the two left corners to calc Property Descriptions --------------------- -.. _class_StyleBoxFlat_anti_aliasing: +.. _class_StyleBoxFlat_property_anti_aliasing: - :ref:`bool` **anti_aliasing** @@ -123,7 +123,7 @@ Property Descriptions Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners. -.. _class_StyleBoxFlat_anti_aliasing_size: +.. _class_StyleBoxFlat_property_anti_aliasing_size: - :ref:`int` **anti_aliasing_size** @@ -135,7 +135,7 @@ Anti Aliasing draws a small ring around edges. This ring fades to transparent. A This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. -.. _class_StyleBoxFlat_bg_color: +.. _class_StyleBoxFlat_property_bg_color: - :ref:`Color` **bg_color** @@ -147,7 +147,7 @@ This changes the size of the faded ring. Higher values can be used to achieve a The background color of the stylebox. -.. _class_StyleBoxFlat_border_blend: +.. _class_StyleBoxFlat_property_border_blend: - :ref:`bool` **border_blend** @@ -159,7 +159,7 @@ The background color of the stylebox. When set to true, the border will fade into the background color. -.. _class_StyleBoxFlat_border_color: +.. _class_StyleBoxFlat_property_border_color: - :ref:`Color` **border_color** @@ -171,7 +171,7 @@ When set to true, the border will fade into the background color. Sets the color of the border. -.. _class_StyleBoxFlat_border_width_bottom: +.. _class_StyleBoxFlat_property_border_width_bottom: - :ref:`int` **border_width_bottom** @@ -183,7 +183,7 @@ Sets the color of the border. Border width for the bottom border. -.. _class_StyleBoxFlat_border_width_left: +.. _class_StyleBoxFlat_property_border_width_left: - :ref:`int` **border_width_left** @@ -195,7 +195,7 @@ Border width for the bottom border. Border width for the left border. -.. _class_StyleBoxFlat_border_width_right: +.. _class_StyleBoxFlat_property_border_width_right: - :ref:`int` **border_width_right** @@ -207,7 +207,7 @@ Border width for the left border. Border width for the right border. -.. _class_StyleBoxFlat_border_width_top: +.. _class_StyleBoxFlat_property_border_width_top: - :ref:`int` **border_width_top** @@ -219,7 +219,7 @@ Border width for the right border. Border width for the top border. -.. _class_StyleBoxFlat_corner_detail: +.. _class_StyleBoxFlat_property_corner_detail: - :ref:`int` **corner_detail** @@ -229,13 +229,13 @@ Border width for the top border. | *Getter* | get_corner_detail() | +----------+--------------------------+ -This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value you should take the corner radius (:ref:`set_corner_radius_all`) into account. +This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value you should take the corner radius (:ref:`set_corner_radius_all`) into account. For corner radius smaller than 10, 4-5 should be enough. For corner radius smaller than 30, 8-12 should be enough. -.. _class_StyleBoxFlat_corner_radius_bottom_left: +.. _class_StyleBoxFlat_property_corner_radius_bottom_left: - :ref:`int` **corner_radius_bottom_left** @@ -247,7 +247,7 @@ For corner radius smaller than 30, 8-12 should be enough. The corner radius of the bottom left corner. When set to 0 the corner is not rounded. -.. _class_StyleBoxFlat_corner_radius_bottom_right: +.. _class_StyleBoxFlat_property_corner_radius_bottom_right: - :ref:`int` **corner_radius_bottom_right** @@ -259,7 +259,7 @@ The corner radius of the bottom left corner. When set to 0 the corner is not rou The corner radius of the bottom right corner. When set to 0 the corner is not rounded. -.. _class_StyleBoxFlat_corner_radius_top_left: +.. _class_StyleBoxFlat_property_corner_radius_top_left: - :ref:`int` **corner_radius_top_left** @@ -271,7 +271,7 @@ The corner radius of the bottom right corner. When set to 0 the corner is not ro The corner radius of the top left corner. When set to 0 the corner is not rounded. -.. _class_StyleBoxFlat_corner_radius_top_right: +.. _class_StyleBoxFlat_property_corner_radius_top_right: - :ref:`int` **corner_radius_top_right** @@ -283,7 +283,7 @@ The corner radius of the top left corner. When set to 0 the corner is not rounde The corner radius of the top right corner. When set to 0 the corner is not rounded. -.. _class_StyleBoxFlat_draw_center: +.. _class_StyleBoxFlat_property_draw_center: - :ref:`bool` **draw_center** @@ -295,7 +295,7 @@ The corner radius of the top right corner. When set to 0 the corner is not round Toggels drawing of the inner part of the stylebox. -.. _class_StyleBoxFlat_expand_margin_bottom: +.. _class_StyleBoxFlat_property_expand_margin_bottom: - :ref:`float` **expand_margin_bottom** @@ -307,7 +307,7 @@ Toggels drawing of the inner part of the stylebox. Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect. -.. _class_StyleBoxFlat_expand_margin_left: +.. _class_StyleBoxFlat_property_expand_margin_left: - :ref:`float` **expand_margin_left** @@ -319,7 +319,7 @@ Expands the stylebox outside of the control rect on the bottom edge. Useful in c Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect. -.. _class_StyleBoxFlat_expand_margin_right: +.. _class_StyleBoxFlat_property_expand_margin_right: - :ref:`float` **expand_margin_right** @@ -331,7 +331,7 @@ Expands the stylebox outside of the control rect on the left edge. Useful in com Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect. -.. _class_StyleBoxFlat_expand_margin_top: +.. _class_StyleBoxFlat_property_expand_margin_top: - :ref:`float` **expand_margin_top** @@ -343,7 +343,7 @@ Expands the stylebox outside of the control rect on the right edge. Useful in co Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect. -.. _class_StyleBoxFlat_shadow_color: +.. _class_StyleBoxFlat_property_shadow_color: - :ref:`Color` **shadow_color** @@ -355,7 +355,7 @@ Expands the stylebox outside of the control rect on the top edge. Useful in comb The color of the shadow. (This has no effect when shadow_size < 1) -.. _class_StyleBoxFlat_shadow_size: +.. _class_StyleBoxFlat_property_shadow_size: - :ref:`int` **shadow_size** @@ -370,27 +370,27 @@ The shadow size in pixels. Method Descriptions ------------------- -.. _class_StyleBoxFlat_get_border_width_min: +.. _class_StyleBoxFlat_method_get_border_width_min: - :ref:`int` **get_border_width_min** **(** **)** const -.. _class_StyleBoxFlat_set_border_width_all: +.. _class_StyleBoxFlat_method_set_border_width_all: - void **set_border_width_all** **(** :ref:`int` width **)** -.. _class_StyleBoxFlat_set_corner_radius_all: +.. _class_StyleBoxFlat_method_set_corner_radius_all: - void **set_corner_radius_all** **(** :ref:`int` radius **)** -.. _class_StyleBoxFlat_set_corner_radius_individual: +.. _class_StyleBoxFlat_method_set_corner_radius_individual: - void **set_corner_radius_individual** **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** -.. _class_StyleBoxFlat_set_expand_margin_all: +.. _class_StyleBoxFlat_method_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** -.. _class_StyleBoxFlat_set_expand_margin_individual: +.. _class_StyleBoxFlat_method_set_expand_margin_individual: - void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index e23a221ad..9f8509b77 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -19,22 +19,22 @@ Brief Description Properties ---------- -+---------------------------+--------------------------------------------------+ -| :ref:`Color` | :ref:`color` | -+---------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`grow_begin` | -+---------------------------+--------------------------------------------------+ -| :ref:`float` | :ref:`grow_end` | -+---------------------------+--------------------------------------------------+ -| :ref:`int` | :ref:`thickness` | -+---------------------------+--------------------------------------------------+ -| :ref:`bool` | :ref:`vertical` | -+---------------------------+--------------------------------------------------+ ++---------------------------+-----------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`grow_begin` | ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`grow_end` | ++---------------------------+-----------------------------------------------------------+ +| :ref:`int` | :ref:`thickness` | ++---------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`vertical` | ++---------------------------+-----------------------------------------------------------+ Property Descriptions --------------------- -.. _class_StyleBoxLine_color: +.. _class_StyleBoxLine_property_color: - :ref:`Color` **color** @@ -44,7 +44,7 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ -.. _class_StyleBoxLine_grow_begin: +.. _class_StyleBoxLine_property_grow_begin: - :ref:`float` **grow_begin** @@ -54,7 +54,7 @@ Property Descriptions | *Getter* | get_grow_begin() | +----------+-----------------------+ -.. _class_StyleBoxLine_grow_end: +.. _class_StyleBoxLine_property_grow_end: - :ref:`float` **grow_end** @@ -64,7 +64,7 @@ Property Descriptions | *Getter* | get_grow_end() | +----------+---------------------+ -.. _class_StyleBoxLine_thickness: +.. _class_StyleBoxLine_property_thickness: - :ref:`int` **thickness** @@ -74,7 +74,7 @@ Property Descriptions | *Getter* | get_thickness() | +----------+----------------------+ -.. _class_StyleBoxLine_vertical: +.. _class_StyleBoxLine_property_vertical: - :ref:`bool` **vertical** diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 9cff9ed04..7be2bda45 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -19,51 +19,51 @@ Texture Based 3x3 scale style. Properties ---------- -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`AxisStretchMode` | :ref:`axis_stretch_horizontal` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`AxisStretchMode` | :ref:`axis_stretch_vertical` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_center` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_bottom` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_left` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_right` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_top` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_bottom` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_left` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_right` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`margin_top` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`modulate_color` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+--------------------------------------------------------------+-------------------------------------------------------------------------------+ ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`AxisStretchMode` | :ref:`axis_stretch_horizontal` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`AxisStretchMode` | :ref:`axis_stretch_vertical` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`draw_center` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_bottom` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_left` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_right` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_top` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin_bottom` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin_left` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin_right` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`margin_top` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`modulate_color` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`normal_map` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`region_rect` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++--------------------------------------------------------------+----------------------------------------------------------------------------------------+ Methods ------- -+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | -+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | -+-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_StyleBoxTexture_texture_changed: +.. _class_StyleBoxTexture_signal_texture_changed: - **texture_changed** **(** **)** @@ -72,6 +72,12 @@ Enumerations .. _enum_StyleBoxTexture_AxisStretchMode: +.. _class_StyleBoxTexture_constant_AXIS_STRETCH_MODE_STRETCH: + +.. _class_StyleBoxTexture_constant_AXIS_STRETCH_MODE_TILE: + +.. _class_StyleBoxTexture_constant_AXIS_STRETCH_MODE_TILE_FIT: + enum **AxisStretchMode**: - **AXIS_STRETCH_MODE_STRETCH** = **0** @@ -88,7 +94,7 @@ Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture Property Descriptions --------------------- -.. _class_StyleBoxTexture_axis_stretch_horizontal: +.. _class_StyleBoxTexture_property_axis_stretch_horizontal: - :ref:`AxisStretchMode` **axis_stretch_horizontal** @@ -98,7 +104,7 @@ Property Descriptions | *Getter* | get_h_axis_stretch_mode() | +----------+--------------------------------+ -.. _class_StyleBoxTexture_axis_stretch_vertical: +.. _class_StyleBoxTexture_property_axis_stretch_vertical: - :ref:`AxisStretchMode` **axis_stretch_vertical** @@ -108,7 +114,7 @@ Property Descriptions | *Getter* | get_v_axis_stretch_mode() | +----------+--------------------------------+ -.. _class_StyleBoxTexture_draw_center: +.. _class_StyleBoxTexture_property_draw_center: - :ref:`bool` **draw_center** @@ -118,7 +124,7 @@ Property Descriptions | *Getter* | is_draw_center_enabled() | +----------+--------------------------+ -.. _class_StyleBoxTexture_expand_margin_bottom: +.. _class_StyleBoxTexture_property_expand_margin_bottom: - :ref:`float` **expand_margin_bottom** @@ -128,7 +134,7 @@ Property Descriptions | *Getter* | get_expand_margin_size() | +----------+-------------------------------+ -.. _class_StyleBoxTexture_expand_margin_left: +.. _class_StyleBoxTexture_property_expand_margin_left: - :ref:`float` **expand_margin_left** @@ -138,7 +144,7 @@ Property Descriptions | *Getter* | get_expand_margin_size() | +----------+-------------------------------+ -.. _class_StyleBoxTexture_expand_margin_right: +.. _class_StyleBoxTexture_property_expand_margin_right: - :ref:`float` **expand_margin_right** @@ -148,7 +154,7 @@ Property Descriptions | *Getter* | get_expand_margin_size() | +----------+-------------------------------+ -.. _class_StyleBoxTexture_expand_margin_top: +.. _class_StyleBoxTexture_property_expand_margin_top: - :ref:`float` **expand_margin_top** @@ -158,7 +164,7 @@ Property Descriptions | *Getter* | get_expand_margin_size() | +----------+-------------------------------+ -.. _class_StyleBoxTexture_margin_bottom: +.. _class_StyleBoxTexture_property_margin_bottom: - :ref:`float` **margin_bottom** @@ -168,7 +174,7 @@ Property Descriptions | *Getter* | get_margin_size() | +----------+------------------------+ -.. _class_StyleBoxTexture_margin_left: +.. _class_StyleBoxTexture_property_margin_left: - :ref:`float` **margin_left** @@ -178,7 +184,7 @@ Property Descriptions | *Getter* | get_margin_size() | +----------+------------------------+ -.. _class_StyleBoxTexture_margin_right: +.. _class_StyleBoxTexture_property_margin_right: - :ref:`float` **margin_right** @@ -188,7 +194,7 @@ Property Descriptions | *Getter* | get_margin_size() | +----------+------------------------+ -.. _class_StyleBoxTexture_margin_top: +.. _class_StyleBoxTexture_property_margin_top: - :ref:`float` **margin_top** @@ -198,7 +204,7 @@ Property Descriptions | *Getter* | get_margin_size() | +----------+------------------------+ -.. _class_StyleBoxTexture_modulate_color: +.. _class_StyleBoxTexture_property_modulate_color: - :ref:`Color` **modulate_color** @@ -208,7 +214,7 @@ Property Descriptions | *Getter* | get_modulate() | +----------+---------------------+ -.. _class_StyleBoxTexture_normal_map: +.. _class_StyleBoxTexture_property_normal_map: - :ref:`Texture` **normal_map** @@ -218,7 +224,7 @@ Property Descriptions | *Getter* | get_normal_map() | +----------+-----------------------+ -.. _class_StyleBoxTexture_region_rect: +.. _class_StyleBoxTexture_property_region_rect: - :ref:`Rect2` **region_rect** @@ -228,7 +234,7 @@ Property Descriptions | *Getter* | get_region_rect() | +----------+------------------------+ -.. _class_StyleBoxTexture_texture: +.. _class_StyleBoxTexture_property_texture: - :ref:`Texture` **texture** @@ -241,11 +247,11 @@ Property Descriptions Method Descriptions ------------------- -.. _class_StyleBoxTexture_set_expand_margin_all: +.. _class_StyleBoxTexture_method_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** -.. _class_StyleBoxTexture_set_expand_margin_individual: +.. _class_StyleBoxTexture_method_set_expand_margin_individual: - void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index b5120b29b..09e8c6032 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -19,56 +19,56 @@ Helper tool to create geometry. Methods ------- -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color` **(** :ref:`Color` color **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_index` **(** :ref:`int` index **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_format` **(** :ref:`int` flags **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deindex` **(** **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_normals` **(** :ref:`bool` flip=false **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_tangents` **(** **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`index` **(** **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color` **(** :ref:`Color` color **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_index` **(** :ref:`int` index **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_format` **(** :ref:`int` flags **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deindex` **(** **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_normals` **(** :ref:`bool` flip=false **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_tangents` **(** **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`index` **(** **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -The ``SurfaceTool`` is used to construct a :ref:`Mesh` by specifying vertex attributes individually. It can be used to construct a :ref:`Mesh` from script. All properties except index need to be added before a call to :ref:`add_vertex`. For example adding vertex colors and UVs looks like +The ``SurfaceTool`` is used to construct a :ref:`Mesh` by specifying vertex attributes individually. It can be used to construct a :ref:`Mesh` from script. All properties except index need to be added before a call to :ref:`add_vertex`. For example adding vertex colors and UVs looks like :: @@ -78,56 +78,56 @@ The ``SurfaceTool`` is used to construct a :ref:`Mesh` by specifying st.add_uv(Vector2(0, 0)) st.add_vertex(Vector3(0, 0, 0)) -The ``SurfaceTool`` now contains one vertex of a triangle which has a UV coordinate and a specified :ref:`Color`. If another vertex were added without calls to :ref:`add_uv` or :ref:`add_color` then the last values would be used. +The ``SurfaceTool`` now contains one vertex of a triangle which has a UV coordinate and a specified :ref:`Color`. If another vertex were added without calls to :ref:`add_uv` or :ref:`add_color` then the last values would be used. -It is very important that vertex attributes are passed **before** the call to :ref:`add_vertex`, failure to do this will result in an error when committing the vertex information to a mesh. +It is very important that vertex attributes are passed **before** the call to :ref:`add_vertex`, failure to do this will result in an error when committing the vertex information to a mesh. Additionally, the attributes used before the first vertex is added determine the format of the mesh. For example if you only add UVs to the first vertex, you cannot add color to any of the subsequent vertices. Method Descriptions ------------------- -.. _class_SurfaceTool_add_bones: +.. _class_SurfaceTool_method_add_bones: - void **add_bones** **(** :ref:`PoolIntArray` bones **)** Add an array of bones for the next Vertex to use. Array must contain 4 integers. -.. _class_SurfaceTool_add_color: +.. _class_SurfaceTool_method_add_color: - void **add_color** **(** :ref:`Color` color **)** Specify a :ref:`Color` for the next Vertex to use. -.. _class_SurfaceTool_add_index: +.. _class_SurfaceTool_method_add_index: - void **add_index** **(** :ref:`int` index **)** Adds an index to index array if you are using indexed Vertices. Does not need to be called before adding Vertex. -.. _class_SurfaceTool_add_normal: +.. _class_SurfaceTool_method_add_normal: - void **add_normal** **(** :ref:`Vector3` normal **)** Specify a normal for the next Vertex to use. -.. _class_SurfaceTool_add_smooth_group: +.. _class_SurfaceTool_method_add_smooth_group: - void **add_smooth_group** **(** :ref:`bool` smooth **)** Specify whether current Vertex (if using only Vertex arrays) or current index (if also using index arrays) should utilize smooth normals for normal calculation. -.. _class_SurfaceTool_add_tangent: +.. _class_SurfaceTool_method_add_tangent: - void **add_tangent** **(** :ref:`Plane` tangent **)** Specify a Tangent for the next Vertex to use. -.. _class_SurfaceTool_add_to_format: +.. _class_SurfaceTool_method_add_to_format: - void **add_to_format** **(** :ref:`int` flags **)** -.. _class_SurfaceTool_add_triangle_fan: +.. _class_SurfaceTool_method_add_triangle_fan: - void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** @@ -135,67 +135,67 @@ Insert a triangle fan made of array data into :ref:`Mesh` being cons Requires primitive type be set to ``PRIMITIVE_TRIANGLES``. -.. _class_SurfaceTool_add_uv: +.. _class_SurfaceTool_method_add_uv: - void **add_uv** **(** :ref:`Vector2` uv **)** Specify UV Coordinate for next Vertex to use. -.. _class_SurfaceTool_add_uv2: +.. _class_SurfaceTool_method_add_uv2: - void **add_uv2** **(** :ref:`Vector2` uv2 **)** Specify an optional second set of UV coordinates for next Vertex to use. -.. _class_SurfaceTool_add_vertex: +.. _class_SurfaceTool_method_add_vertex: - void **add_vertex** **(** :ref:`Vector3` vertex **)** Specify position of current Vertex. Should be called after specifying other vertex properties (e.g. Color, UV). -.. _class_SurfaceTool_add_weights: +.. _class_SurfaceTool_method_add_weights: - void **add_weights** **(** :ref:`PoolRealArray` weights **)** Specify weight values for next Vertex to use. Array must contain 4 values. -.. _class_SurfaceTool_append_from: +.. _class_SurfaceTool_method_append_from: - void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** Append vertices from a given :ref:`Mesh` surface onto the current vertex array with specified :ref:`Transform`. -.. _class_SurfaceTool_begin: +.. _class_SurfaceTool_method_begin: - void **begin** **(** :ref:`PrimitiveType` primitive **)** Called before adding any Vertices. Takes the primitive type as an argument (e.g. Mesh.PRIMITIVE_TRIANGLES). -.. _class_SurfaceTool_clear: +.. _class_SurfaceTool_method_clear: - void **clear** **(** **)** Clear all information passed into the surface tool so far. -.. _class_SurfaceTool_commit: +.. _class_SurfaceTool_method_commit: - :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. -.. _class_SurfaceTool_create_from: +.. _class_SurfaceTool_method_create_from: - void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** Creates a vertex array from an existing :ref:`Mesh`. -.. _class_SurfaceTool_deindex: +.. _class_SurfaceTool_method_deindex: - void **deindex** **(** **)** Removes index array by expanding Vertex array. -.. _class_SurfaceTool_generate_normals: +.. _class_SurfaceTool_method_generate_normals: - void **generate_normals** **(** :ref:`bool` flip=false **)** @@ -205,7 +205,7 @@ Setting "flip" ``true`` inverts resulting normals. Requires primitive type to be set to ``PRIMITIVE_TRIANGLES``. -.. _class_SurfaceTool_generate_tangents: +.. _class_SurfaceTool_method_generate_tangents: - void **generate_tangents** **(** **)** @@ -213,13 +213,13 @@ Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already. -.. _class_SurfaceTool_index: +.. _class_SurfaceTool_method_index: - void **index** **(** **)** Shrinks Vertex array by creating an index array. Avoids reusing Vertices. -.. _class_SurfaceTool_set_material: +.. _class_SurfaceTool_method_set_material: - void **set_material** **(** :ref:`Material` material **)** diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 76bc8f2d8..ad24f1fee 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -19,106 +19,106 @@ Tabbed Container. Properties ---------- -+---------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`current_tab` | -+---------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | -+---------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`TabAlign` | :ref:`tab_align` | -+---------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tabs_visible` | -+---------------------------------------------+--------------------------------------------------------------------------------+ ++---------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`current_tab` | ++---------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | ++---------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`TabAlign` | :ref:`tab_align` | ++---------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tabs_visible` | ++---------------------------------------------+-----------------------------------------------------------------------------------------+ Methods ------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Popup` | :ref:`get_popup` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_previous_tab` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_popup` **(** :ref:`Node` popup **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Popup` | :ref:`get_popup` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_previous_tab` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_count` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_popup` **(** :ref:`Node` popup **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`decrement` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`decrement_highlight` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_bg` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_fg` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`increment` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`increment_highlight` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`label_valign_bg` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`label_valign_fg` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`menu` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`menu_highlight` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`side_margin` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`tab_bg` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`tab_fg` | -+---------------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`top_margin` | -+---------------------------------+--------------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`Texture` | decrement | ++---------------------------------+---------------------+ +| :ref:`Texture` | decrement_highlight | ++---------------------------------+---------------------+ +| :ref:`Font` | font | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_bg | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_fg | ++---------------------------------+---------------------+ +| :ref:`int` | hseparation | ++---------------------------------+---------------------+ +| :ref:`Texture` | increment | ++---------------------------------+---------------------+ +| :ref:`Texture` | increment_highlight | ++---------------------------------+---------------------+ +| :ref:`int` | label_valign_bg | ++---------------------------------+---------------------+ +| :ref:`int` | label_valign_fg | ++---------------------------------+---------------------+ +| :ref:`Texture` | menu | ++---------------------------------+---------------------+ +| :ref:`Texture` | menu_highlight | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | panel | ++---------------------------------+---------------------+ +| :ref:`int` | side_margin | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | tab_bg | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | tab_fg | ++---------------------------------+---------------------+ +| :ref:`int` | top_margin | ++---------------------------------+---------------------+ Signals ------- -.. _class_TabContainer_pre_popup_pressed: +.. _class_TabContainer_signal_pre_popup_pressed: - **pre_popup_pressed** **(** **)** -Emitted when the ``TabContainer``'s :ref:`Popup` button is clicked. See :ref:`set_popup` for details. +Emitted when the ``TabContainer``'s :ref:`Popup` button is clicked. See :ref:`set_popup` for details. -.. _class_TabContainer_tab_changed: +.. _class_TabContainer_signal_tab_changed: - **tab_changed** **(** :ref:`int` tab **)** Emitted when switching to another tab. -.. _class_TabContainer_tab_selected: +.. _class_TabContainer_signal_tab_selected: - **tab_selected** **(** :ref:`int` tab **)** @@ -129,6 +129,12 @@ Enumerations .. _enum_TabContainer_TabAlign: +.. _class_TabContainer_constant_ALIGN_LEFT: + +.. _class_TabContainer_constant_ALIGN_CENTER: + +.. _class_TabContainer_constant_ALIGN_RIGHT: + enum **TabAlign**: - **ALIGN_LEFT** = **0** --- Align the tabs to the left. @@ -144,14 +150,14 @@ Sets the active tab's ``visible`` property to the value ``true``. Sets all other Ignores non-:ref:`Control` children. -Individual tabs are always visible unless you use :ref:`set_tab_disabled` and :ref:`set_tab_title` to hide it. +Individual tabs are always visible unless you use :ref:`set_tab_disabled` and :ref:`set_tab_title` to hide it. To hide only a tab's content, nest the content inside a child :ref:`Control`, so it receives the ``TabContainer``'s visibility setting instead. Property Descriptions --------------------- -.. _class_TabContainer_current_tab: +.. _class_TabContainer_property_current_tab: - :ref:`int` **current_tab** @@ -163,7 +169,7 @@ Property Descriptions The current tab index. When set, this index's :ref:`Control` node's ``visible`` property is set to ``true`` and all others are set to ``false``. -.. _class_TabContainer_drag_to_rearrange_enabled: +.. _class_TabContainer_property_drag_to_rearrange_enabled: - :ref:`bool` **drag_to_rearrange_enabled** @@ -175,7 +181,7 @@ The current tab index. When set, this index's :ref:`Control` node If ``true``, tabs can be rearranged with mouse drag. -.. _class_TabContainer_tab_align: +.. _class_TabContainer_property_tab_align: - :ref:`TabAlign` **tab_align** @@ -187,7 +193,7 @@ If ``true``, tabs can be rearranged with mouse drag. The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details. -.. _class_TabContainer_tabs_visible: +.. _class_TabContainer_property_tabs_visible: - :ref:`bool` **tabs_visible** @@ -202,85 +208,85 @@ If ``true``, tabs are visible. If ``false``, tabs' content and titles are hidden Method Descriptions ------------------- -.. _class_TabContainer_get_current_tab_control: +.. _class_TabContainer_method_get_current_tab_control: - :ref:`Control` **get_current_tab_control** **(** **)** const Returns the child :ref:`Control` node located at the active tab index. -.. _class_TabContainer_get_popup: +.. _class_TabContainer_method_get_popup: - :ref:`Popup` **get_popup** **(** **)** const -Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. +Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. -.. _class_TabContainer_get_previous_tab: +.. _class_TabContainer_method_get_previous_tab: - :ref:`int` **get_previous_tab** **(** **)** const Returns the previously active tab index. -.. _class_TabContainer_get_tab_control: +.. _class_TabContainer_method_get_tab_control: - :ref:`Control` **get_tab_control** **(** :ref:`int` idx **)** const Returns the currently visible tab's :ref:`Control` node. -.. _class_TabContainer_get_tab_count: +.. _class_TabContainer_method_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const Returns the number of tabs. -.. _class_TabContainer_get_tab_disabled: +.. _class_TabContainer_method_get_tab_disabled: - :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const Returns ``true`` if the tab at index ``tab_idx`` is disabled. -.. _class_TabContainer_get_tab_icon: +.. _class_TabContainer_method_get_tab_icon: - :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`. -.. _class_TabContainer_get_tab_title: +.. _class_TabContainer_method_get_tab_title: - :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`. +Returns the title of the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. -.. _class_TabContainer_get_tabs_rearrange_group: +.. _class_TabContainer_method_get_tabs_rearrange_group: - :ref:`int` **get_tabs_rearrange_group** **(** **)** const Returns the ``TabContainer`` rearrange group id. -.. _class_TabContainer_set_popup: +.. _class_TabContainer_method_set_popup: - void **set_popup** **(** :ref:`Node` popup **)** If set on a :ref:`Popup` node instance, a popup menu icon appears in the top-right corner of the ``TabContainer``. Clicking it will expand the :ref:`Popup` node. -.. _class_TabContainer_set_tab_disabled: +.. _class_TabContainer_method_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** -If ``disabled`` is false, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. +If ``disabled`` is false, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. -.. _class_TabContainer_set_tab_icon: +.. _class_TabContainer_method_set_tab_icon: - void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** Sets an icon for the tab at index ``tab_idx``. -.. _class_TabContainer_set_tab_title: +.. _class_TabContainer_method_set_tab_title: - void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** -Sets a title for the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. +Sets a title for the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. -.. _class_TabContainer_set_tabs_rearrange_group: +.. _class_TabContainer_method_set_tabs_rearrange_group: - void **set_tabs_rearrange_group** **(** :ref:`int` group_id **)** diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 0d0bea432..38bec7c65 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -19,124 +19,124 @@ Tabs Control. Properties ---------- -+---------------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`current_tab` | -+---------------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | -+---------------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scrolling_enabled` | -+---------------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`TabAlign` | :ref:`tab_align` | -+---------------------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`CloseButtonDisplayPolicy` | :ref:`tab_close_display_policy` | -+---------------------------------------------------------------------+------------------------------------------------------------------------+ ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`current_tab` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`drag_to_rearrange_enabled` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`scrolling_enabled` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`TabAlign` | :ref:`tab_align` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`CloseButtonDisplayPolicy` | :ref:`tab_close_display_policy` | ++---------------------------------------------------------------------+---------------------------------------------------------------------------------+ Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture` icon=null **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_select_with_rmb` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_offset` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_select_with_rmb` **(** :ref:`bool` enabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture` icon=null **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_select_with_rmb` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_count` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_offset` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_select_with_rmb` **(** :ref:`bool` enabled **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`button` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`button_pressed` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Texture` | :ref:`close` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Texture` | :ref:`decrement` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Texture` | :ref:`decrement_highlight` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_bg` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_fg` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Texture` | :ref:`increment` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`Texture` | :ref:`increment_highlight` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`label_valign_bg` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`label_valign_fg` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`tab_bg` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`tab_fg` | -+---------------------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`top_margin` | -+---------------------------------+------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`StyleBox` | button | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | button_pressed | ++---------------------------------+---------------------+ +| :ref:`Texture` | close | ++---------------------------------+---------------------+ +| :ref:`Texture` | decrement | ++---------------------------------+---------------------+ +| :ref:`Texture` | decrement_highlight | ++---------------------------------+---------------------+ +| :ref:`Font` | font | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_bg | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_fg | ++---------------------------------+---------------------+ +| :ref:`int` | hseparation | ++---------------------------------+---------------------+ +| :ref:`Texture` | increment | ++---------------------------------+---------------------+ +| :ref:`Texture` | increment_highlight | ++---------------------------------+---------------------+ +| :ref:`int` | label_valign_bg | ++---------------------------------+---------------------+ +| :ref:`int` | label_valign_fg | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | panel | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | tab_bg | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | tab_fg | ++---------------------------------+---------------------+ +| :ref:`int` | top_margin | ++---------------------------------+---------------------+ Signals ------- -.. _class_Tabs_reposition_active_tab_request: +.. _class_Tabs_signal_reposition_active_tab_request: - **reposition_active_tab_request** **(** :ref:`int` idx_to **)** -.. _class_Tabs_right_button_pressed: +.. _class_Tabs_signal_right_button_pressed: - **right_button_pressed** **(** :ref:`int` tab **)** -.. _class_Tabs_tab_changed: +.. _class_Tabs_signal_tab_changed: - **tab_changed** **(** :ref:`int` tab **)** -.. _class_Tabs_tab_clicked: +.. _class_Tabs_signal_tab_clicked: - **tab_clicked** **(** :ref:`int` tab **)** -.. _class_Tabs_tab_close: +.. _class_Tabs_signal_tab_close: - **tab_close** **(** :ref:`int` tab **)** -.. _class_Tabs_tab_hover: +.. _class_Tabs_signal_tab_hover: - **tab_hover** **(** :ref:`int` tab **)** @@ -145,6 +145,14 @@ Enumerations .. _enum_Tabs_TabAlign: +.. _class_Tabs_constant_ALIGN_LEFT: + +.. _class_Tabs_constant_ALIGN_CENTER: + +.. _class_Tabs_constant_ALIGN_RIGHT: + +.. _class_Tabs_constant_ALIGN_MAX: + enum **TabAlign**: - **ALIGN_LEFT** = **0** --- Align the tabs to the left. @@ -157,6 +165,14 @@ enum **TabAlign**: .. _enum_Tabs_CloseButtonDisplayPolicy: +.. _class_Tabs_constant_CLOSE_BUTTON_SHOW_NEVER: + +.. _class_Tabs_constant_CLOSE_BUTTON_SHOW_ACTIVE_ONLY: + +.. _class_Tabs_constant_CLOSE_BUTTON_SHOW_ALWAYS: + +.. _class_Tabs_constant_CLOSE_BUTTON_MAX: + enum **CloseButtonDisplayPolicy**: - **CLOSE_BUTTON_SHOW_NEVER** = **0** @@ -175,7 +191,7 @@ Simple tabs control, similar to :ref:`TabContainer` but is o Property Descriptions --------------------- -.. _class_Tabs_current_tab: +.. _class_Tabs_property_current_tab: - :ref:`int` **current_tab** @@ -187,7 +203,7 @@ Property Descriptions Select tab at index ``tab_idx``. -.. _class_Tabs_drag_to_rearrange_enabled: +.. _class_Tabs_property_drag_to_rearrange_enabled: - :ref:`bool` **drag_to_rearrange_enabled** @@ -199,7 +215,7 @@ Select tab at index ``tab_idx``. If ``true``, tabs can be rearranged with mouse drag. -.. _class_Tabs_scrolling_enabled: +.. _class_Tabs_property_scrolling_enabled: - :ref:`bool` **scrolling_enabled** @@ -209,7 +225,7 @@ If ``true``, tabs can be rearranged with mouse drag. | *Getter* | get_scrolling_enabled() | +----------+------------------------------+ -.. _class_Tabs_tab_align: +.. _class_Tabs_property_tab_align: - :ref:`TabAlign` **tab_align** @@ -221,7 +237,7 @@ If ``true``, tabs can be rearranged with mouse drag. The alignment of all tabs. See enum ``TabAlign`` constants for details. -.. _class_Tabs_tab_close_display_policy: +.. _class_Tabs_property_tab_close_display_policy: - :ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** @@ -234,105 +250,105 @@ The alignment of all tabs. See enum ``TabAlign`` constants for details. Method Descriptions ------------------- -.. _class_Tabs_add_tab: +.. _class_Tabs_method_add_tab: - void **add_tab** **(** :ref:`String` title="", :ref:`Texture` icon=null **)** Adds a new tab. -.. _class_Tabs_ensure_tab_visible: +.. _class_Tabs_method_ensure_tab_visible: - void **ensure_tab_visible** **(** :ref:`int` idx **)** Moves the Scroll view to make the tab visible. -.. _class_Tabs_get_offset_buttons_visible: +.. _class_Tabs_method_get_offset_buttons_visible: - :ref:`bool` **get_offset_buttons_visible** **(** **)** const -.. _class_Tabs_get_select_with_rmb: +.. _class_Tabs_method_get_select_with_rmb: - :ref:`bool` **get_select_with_rmb** **(** **)** const Returns ``true`` if select with right mouse button is enabled. -.. _class_Tabs_get_tab_count: +.. _class_Tabs_method_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const Returns the number of tabs. -.. _class_Tabs_get_tab_disabled: +.. _class_Tabs_method_get_tab_disabled: - :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const Returns ``true`` if the tab at index ``tab_idx`` is disabled. -.. _class_Tabs_get_tab_icon: +.. _class_Tabs_method_get_tab_icon: - :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`. -.. _class_Tabs_get_tab_offset: +.. _class_Tabs_method_get_tab_offset: - :ref:`int` **get_tab_offset** **(** **)** const -.. _class_Tabs_get_tab_rect: +.. _class_Tabs_method_get_tab_rect: - :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const Returns tab :ref:`Rect2` with local position and size. -.. _class_Tabs_get_tab_title: +.. _class_Tabs_method_get_tab_title: - :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`. +Returns the title of the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. -.. _class_Tabs_get_tabs_rearrange_group: +.. _class_Tabs_method_get_tabs_rearrange_group: - :ref:`int` **get_tabs_rearrange_group** **(** **)** const Returns the ``Tabs`` rearrange group id. -.. _class_Tabs_move_tab: +.. _class_Tabs_method_move_tab: - void **move_tab** **(** :ref:`int` from, :ref:`int` to **)** Rearrange tab. -.. _class_Tabs_remove_tab: +.. _class_Tabs_method_remove_tab: - void **remove_tab** **(** :ref:`int` tab_idx **)** Removes tab at index ``tab_idx`` -.. _class_Tabs_set_select_with_rmb: +.. _class_Tabs_method_set_select_with_rmb: - void **set_select_with_rmb** **(** :ref:`bool` enabled **)** If ``true``, enables selecting a tab with right mouse button. -.. _class_Tabs_set_tab_disabled: +.. _class_Tabs_method_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** -If ``disabled`` is false, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. +If ``disabled`` is false, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. -.. _class_Tabs_set_tab_icon: +.. _class_Tabs_method_set_tab_icon: - void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** Sets an icon for the tab at index ``tab_idx``. -.. _class_Tabs_set_tab_title: +.. _class_Tabs_method_set_tab_title: - void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** Sets a title for the tab at index ``tab_idx``. -.. _class_Tabs_set_tabs_rearrange_group: +.. _class_Tabs_method_set_tabs_rearrange_group: - void **set_tabs_rearrange_group** **(** :ref:`int` group_id **)** diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 23482e8ec..6a230d1bb 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -19,15 +19,15 @@ TCP Server. Methods ------- -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StreamPeerTCP` | :ref:`take_connection` **(** **)** | -+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StreamPeerTCP` | :ref:`take_connection` **(** **)** | ++-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -37,13 +37,13 @@ TCP Server class. Listens to connections on a port and returns a :ref:`StreamPee Method Descriptions ------------------- -.. _class_TCP_Server_is_connection_available: +.. _class_TCP_Server_method_is_connection_available: - :ref:`bool` **is_connection_available** **(** **)** const Return true if a connection is available for taking. -.. _class_TCP_Server_listen: +.. _class_TCP_Server_method_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** @@ -55,13 +55,13 @@ If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the server If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). -.. _class_TCP_Server_stop: +.. _class_TCP_Server_method_stop: - void **stop** **(** **)** Stop listening. -.. _class_TCP_Server_take_connection: +.. _class_TCP_Server_method_take_connection: - :ref:`StreamPeerTCP` **take_connection** **(** **)** diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 5c9993311..ccdf094e1 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -19,226 +19,226 @@ Multiline text editing control. Properties ---------- -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`breakpoint_gutter` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`caret_blink` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`caret_blink_speed` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`caret_block_mode` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`caret_moving_by_right_click` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`context_menu_enabled` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hiding_enabled` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`highlight_all_occurrences` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`highlight_current_line` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`override_selected_font_color` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`readonly` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_line_numbers` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_scrolling` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`syntax_highlighting` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`text` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`v_scroll_speed` | -+-----------------------------+----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`wrap_enabled` | -+-----------------------------+----------------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`breakpoint_gutter` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`caret_blink` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`caret_blink_speed` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`caret_block_mode` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`caret_moving_by_right_click` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`context_menu_enabled` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hiding_enabled` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`highlight_all_occurrences` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`highlight_current_line` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`override_selected_font_color` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`readonly` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`show_line_numbers` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`smooth_scrolling` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`syntax_highlighting` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`text` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`v_scroll_speed` | ++-----------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`wrap_enabled` | ++-----------------------------+-------------------------------------------------------------------------------------------+ Methods ------- -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_fold` **(** :ref:`int` line **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_colors` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_undo_history` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true, :ref:`int` wrap_index=0 **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cut` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fold_all_lines` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fold_line` **(** :ref:`int` line **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_breakpoints` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selection_text` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** 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_line_hidden` **(** :ref:`int` line **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`menu_option` **(** :ref:`int` option **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`paste` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redo` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_breakpoints` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_all` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_line_as_hidden` **(** :ref:`int` line, :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_fold_line` **(** :ref:`int` line **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`undo` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unfold_line` **(** :ref:`int` line **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhide_all_lines` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_fold` **(** :ref:`int` line **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_colors` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_undo_history` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true, :ref:`int` wrap_index=0 **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cut` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fold_all_lines` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fold_line` **(** :ref:`int` line **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_breakpoints` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_selection_text` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** 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_line_hidden` **(** :ref:`int` line **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`menu_option` **(** :ref:`int` option **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`paste` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redo` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_breakpoints` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_all` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_line_as_hidden` **(** :ref:`int` line, :ref:`bool` enable **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_fold_line` **(** :ref:`int` line **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`undo` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unfold_line` **(** :ref:`int` line **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unhide_all_lines` **(** **)** | ++-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`background_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`brace_mismatch_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`breakpoint_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`caret_background_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`caret_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`code_folding_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`completion` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`completion_background_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`completion_existing_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`completion_font_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`completion_lines` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`completion_max_width` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`completion_scroll_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`completion_scroll_width` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`completion_selected_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`current_line_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_selected` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`function_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`line_number_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`line_spacing` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`mark_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`member_variable_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`number_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`read_only` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`safe_line_number_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`selection_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`symbol_color` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tab` | -+---------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`word_highlighted_color` | -+---------------------------------+--------------------------------------------------------------------------------+ ++---------------------------------+-----------------------------+ +| :ref:`Color` | background_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | brace_mismatch_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | breakpoint_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | caret_background_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | caret_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | code_folding_color | ++---------------------------------+-----------------------------+ +| :ref:`StyleBox` | completion | ++---------------------------------+-----------------------------+ +| :ref:`Color` | completion_background_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | completion_existing_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | completion_font_color | ++---------------------------------+-----------------------------+ +| :ref:`int` | completion_lines | ++---------------------------------+-----------------------------+ +| :ref:`int` | completion_max_width | ++---------------------------------+-----------------------------+ +| :ref:`Color` | completion_scroll_color | ++---------------------------------+-----------------------------+ +| :ref:`int` | completion_scroll_width | ++---------------------------------+-----------------------------+ +| :ref:`Color` | completion_selected_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | current_line_color | ++---------------------------------+-----------------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+-----------------------------+ +| :ref:`Font` | font | ++---------------------------------+-----------------------------+ +| :ref:`Color` | font_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | font_color_selected | ++---------------------------------+-----------------------------+ +| :ref:`Color` | function_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | line_number_color | ++---------------------------------+-----------------------------+ +| :ref:`int` | line_spacing | ++---------------------------------+-----------------------------+ +| :ref:`Color` | mark_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | member_variable_color | ++---------------------------------+-----------------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+-----------------------------+ +| :ref:`Color` | number_color | ++---------------------------------+-----------------------------+ +| :ref:`StyleBox` | read_only | ++---------------------------------+-----------------------------+ +| :ref:`Color` | safe_line_number_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | selection_color | ++---------------------------------+-----------------------------+ +| :ref:`Color` | symbol_color | ++---------------------------------+-----------------------------+ +| :ref:`Texture` | tab | ++---------------------------------+-----------------------------+ +| :ref:`Color` | word_highlighted_color | ++---------------------------------+-----------------------------+ Signals ------- -.. _class_TextEdit_breakpoint_toggled: +.. _class_TextEdit_signal_breakpoint_toggled: - **breakpoint_toggled** **(** :ref:`int` row **)** Emitted when a breakpoint is placed via the breakpoint gutter. -.. _class_TextEdit_cursor_changed: +.. _class_TextEdit_signal_cursor_changed: - **cursor_changed** **(** **)** Emitted when the cursor changes. -.. _class_TextEdit_request_completion: +.. _class_TextEdit_signal_request_completion: - **request_completion** **(** **)** -.. _class_TextEdit_symbol_lookup: +.. _class_TextEdit_signal_symbol_lookup: - **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** -.. _class_TextEdit_text_changed: +.. _class_TextEdit_signal_text_changed: - **text_changed** **(** **)** @@ -249,6 +249,12 @@ Enumerations .. _enum_TextEdit_SearchFlags: +.. _class_TextEdit_constant_SEARCH_MATCH_CASE: + +.. _class_TextEdit_constant_SEARCH_WHOLE_WORDS: + +.. _class_TextEdit_constant_SEARCH_BACKWARDS: + enum **SearchFlags**: - **SEARCH_MATCH_CASE** = **1** --- Match case when searching. @@ -259,6 +265,22 @@ enum **SearchFlags**: .. _enum_TextEdit_MenuItems: +.. _class_TextEdit_constant_MENU_CUT: + +.. _class_TextEdit_constant_MENU_COPY: + +.. _class_TextEdit_constant_MENU_PASTE: + +.. _class_TextEdit_constant_MENU_CLEAR: + +.. _class_TextEdit_constant_MENU_SELECT_ALL: + +.. _class_TextEdit_constant_MENU_UNDO: + +.. _class_TextEdit_constant_MENU_REDO: + +.. _class_TextEdit_constant_MENU_MAX: + enum **MenuItems**: - **MENU_CUT** = **0** --- Cuts (Copies and clears) the selected text. @@ -285,7 +307,7 @@ TextEdit is meant for editing large, multiline text. It also has facilities for Property Descriptions --------------------- -.. _class_TextEdit_breakpoint_gutter: +.. _class_TextEdit_property_breakpoint_gutter: - :ref:`bool` **breakpoint_gutter** @@ -297,7 +319,7 @@ Property Descriptions If ``true``, the breakpoint gutter is visible. -.. _class_TextEdit_caret_blink: +.. _class_TextEdit_property_caret_blink: - :ref:`bool` **caret_blink** @@ -309,7 +331,7 @@ If ``true``, the breakpoint gutter is visible. If ``true``, the caret (visual cursor) blinks. -.. _class_TextEdit_caret_blink_speed: +.. _class_TextEdit_property_caret_blink_speed: - :ref:`float` **caret_blink_speed** @@ -321,7 +343,7 @@ If ``true``, the caret (visual cursor) blinks. Duration (in seconds) of a caret's blinking cycle. -.. _class_TextEdit_caret_block_mode: +.. _class_TextEdit_property_caret_block_mode: - :ref:`bool` **caret_block_mode** @@ -335,7 +357,7 @@ If ``true``, the caret displays as a rectangle. If ``false``, the caret displays as a bar. -.. _class_TextEdit_caret_moving_by_right_click: +.. _class_TextEdit_property_caret_moving_by_right_click: - :ref:`bool` **caret_moving_by_right_click** @@ -349,7 +371,7 @@ If ``true``, a right click moves the cursor at the mouse position before display If ``false``, the context menu disregards mouse location. -.. _class_TextEdit_context_menu_enabled: +.. _class_TextEdit_property_context_menu_enabled: - :ref:`bool` **context_menu_enabled** @@ -361,7 +383,7 @@ If ``false``, the context menu disregards mouse location. If ``true``, a right click displays the context menu. -.. _class_TextEdit_hiding_enabled: +.. _class_TextEdit_property_hiding_enabled: - :ref:`int` **hiding_enabled** @@ -371,7 +393,7 @@ If ``true``, a right click displays the context menu. | *Getter* | is_hiding_enabled() | +----------+---------------------------+ -.. _class_TextEdit_highlight_all_occurrences: +.. _class_TextEdit_property_highlight_all_occurrences: - :ref:`bool` **highlight_all_occurrences** @@ -381,7 +403,7 @@ If ``true``, a right click displays the context menu. | *Getter* | is_highlight_all_occurrences_enabled() | +----------+----------------------------------------+ -.. _class_TextEdit_highlight_current_line: +.. _class_TextEdit_property_highlight_current_line: - :ref:`bool` **highlight_current_line** @@ -393,7 +415,7 @@ If ``true``, a right click displays the context menu. If ``true``, the line containing the cursor is highlighted. -.. _class_TextEdit_override_selected_font_color: +.. _class_TextEdit_property_override_selected_font_color: - :ref:`bool` **override_selected_font_color** @@ -403,7 +425,7 @@ If ``true``, the line containing the cursor is highlighted. | *Getter* | is_overriding_selected_font_color() | +----------+-----------------------------------------+ -.. _class_TextEdit_readonly: +.. _class_TextEdit_property_readonly: - :ref:`bool` **readonly** @@ -415,7 +437,7 @@ If ``true``, the line containing the cursor is highlighted. If ``true``, read-only mode is enabled. Existing text cannot be modified and new text cannot be added. -.. _class_TextEdit_show_line_numbers: +.. _class_TextEdit_property_show_line_numbers: - :ref:`bool` **show_line_numbers** @@ -427,7 +449,7 @@ If ``true``, read-only mode is enabled. Existing text cannot be modified and new If ``true``, line numbers are displayed to the left of the text. -.. _class_TextEdit_smooth_scrolling: +.. _class_TextEdit_property_smooth_scrolling: - :ref:`bool` **smooth_scrolling** @@ -437,7 +459,7 @@ If ``true``, line numbers are displayed to the left of the text. | *Getter* | is_smooth_scroll_enabled() | +----------+---------------------------------+ -.. _class_TextEdit_syntax_highlighting: +.. _class_TextEdit_property_syntax_highlighting: - :ref:`bool` **syntax_highlighting** @@ -447,7 +469,7 @@ If ``true``, line numbers are displayed to the left of the text. | *Getter* | is_syntax_coloring_enabled() | +----------+------------------------------+ -.. _class_TextEdit_text: +.. _class_TextEdit_property_text: - :ref:`String` **text** @@ -459,7 +481,7 @@ If ``true``, line numbers are displayed to the left of the text. String value of the :ref:`TextEdit`. -.. _class_TextEdit_v_scroll_speed: +.. _class_TextEdit_property_v_scroll_speed: - :ref:`float` **v_scroll_speed** @@ -471,7 +493,7 @@ String value of the :ref:`TextEdit`. If ``true``, enables text wrapping when it goes beyond he edge of what is visible. -.. _class_TextEdit_wrap_enabled: +.. _class_TextEdit_property_wrap_enabled: - :ref:`bool` **wrap_enabled** @@ -484,225 +506,225 @@ If ``true``, enables text wrapping when it goes beyond he edge of what is visibl Method Descriptions ------------------- -.. _class_TextEdit_add_color_region: +.. _class_TextEdit_method_add_color_region: - void **add_color_region** **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** Add color region (given the delimiters) and its colors. -.. _class_TextEdit_add_keyword_color: +.. _class_TextEdit_method_add_keyword_color: - void **add_keyword_color** **(** :ref:`String` keyword, :ref:`Color` color **)** Add a keyword and its color. -.. _class_TextEdit_can_fold: +.. _class_TextEdit_method_can_fold: - :ref:`bool` **can_fold** **(** :ref:`int` line **)** const -.. _class_TextEdit_clear_colors: +.. _class_TextEdit_method_clear_colors: - void **clear_colors** **(** **)** Clear all the syntax coloring information. -.. _class_TextEdit_clear_undo_history: +.. _class_TextEdit_method_clear_undo_history: - void **clear_undo_history** **(** **)** Clear the undo history. -.. _class_TextEdit_copy: +.. _class_TextEdit_method_copy: - void **copy** **(** **)** Copy the current selection. -.. _class_TextEdit_cursor_get_column: +.. _class_TextEdit_method_cursor_get_column: - :ref:`int` **cursor_get_column** **(** **)** const Return the column the editing cursor is at. -.. _class_TextEdit_cursor_get_line: +.. _class_TextEdit_method_cursor_get_line: - :ref:`int` **cursor_get_line** **(** **)** const Return the line the editing cursor is at. -.. _class_TextEdit_cursor_set_column: +.. _class_TextEdit_method_cursor_set_column: - void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** -.. _class_TextEdit_cursor_set_line: +.. _class_TextEdit_method_cursor_set_line: - void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true, :ref:`int` wrap_index=0 **)** -.. _class_TextEdit_cut: +.. _class_TextEdit_method_cut: - void **cut** **(** **)** Cut the current selection. -.. _class_TextEdit_deselect: +.. _class_TextEdit_method_deselect: - void **deselect** **(** **)** Clears the current selection. -.. _class_TextEdit_fold_all_lines: +.. _class_TextEdit_method_fold_all_lines: - void **fold_all_lines** **(** **)** -.. _class_TextEdit_fold_line: +.. _class_TextEdit_method_fold_line: - void **fold_line** **(** :ref:`int` line **)** -.. _class_TextEdit_get_breakpoints: +.. _class_TextEdit_method_get_breakpoints: - :ref:`Array` **get_breakpoints** **(** **)** const Return an array containing the line number of each breakpoint. -.. _class_TextEdit_get_keyword_color: +.. _class_TextEdit_method_get_keyword_color: - :ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** const -.. _class_TextEdit_get_line: +.. _class_TextEdit_method_get_line: - :ref:`String` **get_line** **(** :ref:`int` line **)** const Return the text of a specific line. -.. _class_TextEdit_get_line_count: +.. _class_TextEdit_method_get_line_count: - :ref:`int` **get_line_count** **(** **)** const Return the amount of total lines in the text. -.. _class_TextEdit_get_menu: +.. _class_TextEdit_method_get_menu: - :ref:`PopupMenu` **get_menu** **(** **)** const -.. _class_TextEdit_get_selection_from_column: +.. _class_TextEdit_method_get_selection_from_column: - :ref:`int` **get_selection_from_column** **(** **)** const Return the selection begin column. -.. _class_TextEdit_get_selection_from_line: +.. _class_TextEdit_method_get_selection_from_line: - :ref:`int` **get_selection_from_line** **(** **)** const Return the selection begin line. -.. _class_TextEdit_get_selection_text: +.. _class_TextEdit_method_get_selection_text: - :ref:`String` **get_selection_text** **(** **)** const Return the text inside the selection. -.. _class_TextEdit_get_selection_to_column: +.. _class_TextEdit_method_get_selection_to_column: - :ref:`int` **get_selection_to_column** **(** **)** const Return the selection end column. -.. _class_TextEdit_get_selection_to_line: +.. _class_TextEdit_method_get_selection_to_line: - :ref:`int` **get_selection_to_line** **(** **)** const Return the selection end line. -.. _class_TextEdit_get_word_under_cursor: +.. _class_TextEdit_method_get_word_under_cursor: - :ref:`String` **get_word_under_cursor** **(** **)** const -.. _class_TextEdit_has_keyword_color: +.. _class_TextEdit_method_has_keyword_color: - :ref:`bool` **has_keyword_color** **(** :ref:`String` keyword **)** const -.. _class_TextEdit_insert_text_at_cursor: +.. _class_TextEdit_method_insert_text_at_cursor: - void **insert_text_at_cursor** **(** :ref:`String` text **)** Insert a given text at the cursor position. -.. _class_TextEdit_is_folded: +.. _class_TextEdit_method_is_folded: - :ref:`bool` **is_folded** **(** :ref:`int` line **)** const -.. _class_TextEdit_is_line_hidden: +.. _class_TextEdit_method_is_line_hidden: - :ref:`bool` **is_line_hidden** **(** :ref:`int` line **)** const -.. _class_TextEdit_is_selection_active: +.. _class_TextEdit_method_is_selection_active: - :ref:`bool` **is_selection_active** **(** **)** const Return true if the selection is active. -.. _class_TextEdit_menu_option: +.. _class_TextEdit_method_menu_option: - void **menu_option** **(** :ref:`int` option **)** -.. _class_TextEdit_paste: +.. _class_TextEdit_method_paste: - void **paste** **(** **)** Paste the current selection. -.. _class_TextEdit_redo: +.. _class_TextEdit_method_redo: - void **redo** **(** **)** Perform redo operation. -.. _class_TextEdit_remove_breakpoints: +.. _class_TextEdit_method_remove_breakpoints: - void **remove_breakpoints** **(** **)** Removes all the breakpoints (without firing "breakpoint_toggled" signal). -.. _class_TextEdit_search: +.. _class_TextEdit_method_search: - :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 SEARCH\_\* enum. -.. _class_TextEdit_select: +.. _class_TextEdit_method_select: - void **select** **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** Perform selection, from line/column to line/column. -.. _class_TextEdit_select_all: +.. _class_TextEdit_method_select_all: - void **select_all** **(** **)** Select all the text. -.. _class_TextEdit_set_line_as_hidden: +.. _class_TextEdit_method_set_line_as_hidden: - void **set_line_as_hidden** **(** :ref:`int` line, :ref:`bool` enable **)** -.. _class_TextEdit_toggle_fold_line: +.. _class_TextEdit_method_toggle_fold_line: - void **toggle_fold_line** **(** :ref:`int` line **)** Toggle the folding of the code block at the given line. -.. _class_TextEdit_undo: +.. _class_TextEdit_method_undo: - void **undo** **(** **)** Perform undo operation. -.. _class_TextEdit_unfold_line: +.. _class_TextEdit_method_unfold_line: - void **unfold_line** **(** :ref:`int` line **)** -.. _class_TextEdit_unhide_all_lines: +.. _class_TextEdit_method_unhide_all_lines: - void **unhide_all_lines** **(** **)** diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 0acad975d..870b88c5d 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -21,36 +21,52 @@ Texture for 2D and 3D. Properties ---------- -+-----------------------+-----------------------------------+ -| :ref:`int` | :ref:`flags` | -+-----------------------+-----------------------------------+ ++-----------------------+--------------------------------------------+ +| :ref:`int` | :ref:`flags` | ++-----------------------+--------------------------------------------+ 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 ------------ .. _enum_Texture_Flags: +.. _class_Texture_constant_FLAGS_DEFAULT: + +.. _class_Texture_constant_FLAG_MIPMAPS: + +.. _class_Texture_constant_FLAG_REPEAT: + +.. _class_Texture_constant_FLAG_FILTER: + +.. _class_Texture_constant_FLAG_ANISOTROPIC_FILTER: + +.. _class_Texture_constant_FLAG_CONVERT_TO_LINEAR: + +.. _class_Texture_constant_FLAG_MIRRORED_REPEAT: + +.. _class_Texture_constant_FLAG_VIDEO_SURFACE: + enum **Flags**: - **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. @@ -76,12 +92,12 @@ Description A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D :ref:`Sprite` or GUI :ref:`Control`. -Textures are often created by loading them from a file. See :ref:`@GDScript.load`. +Textures are often created by loading them from a file. See :ref:`@GDScript.load`. Property Descriptions --------------------- -.. _class_Texture_flags: +.. _class_Texture_property_flags: - :ref:`int` **flags** @@ -96,41 +112,41 @@ The texture's flags. Method Descriptions ------------------- -.. _class_Texture_draw: +.. _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 -.. _class_Texture_draw_rect: +.. _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 -.. _class_Texture_draw_rect_region: +.. _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 -.. _class_Texture_get_data: +.. _class_Texture_method_get_data: - :ref:`Image` **get_data** **(** **)** const -.. _class_Texture_get_height: +.. _class_Texture_method_get_height: - :ref:`int` **get_height** **(** **)** const Return the texture height. -.. _class_Texture_get_size: +.. _class_Texture_method_get_size: - :ref:`Vector2` **get_size** **(** **)** const Return the texture size. -.. _class_Texture_get_width: +.. _class_Texture_method_get_width: - :ref:`int` **get_width** **(** **)** const Return the texture width. -.. _class_Texture_has_alpha: +.. _class_Texture_method_has_alpha: - :ref:`bool` **has_alpha** **(** **)** const diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index 161a46213..203483a94 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -19,29 +19,43 @@ Texture-based button. Supports Pressed, Hover, Disabled and Focused states. Properties ---------- -+----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`bool` | :ref:`expand` | -+----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`StretchMode` | :ref:`stretch_mode` | -+----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`BitMap` | :ref:`texture_click_mask` | -+----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_disabled` | -+----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_focused` | -+----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_hover` | -+----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_normal` | -+----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_pressed` | -+----------------------------------------------------+-------------------------------------------------------------------+ ++----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`expand` | ++----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`StretchMode` | :ref:`stretch_mode` | ++----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`BitMap` | :ref:`texture_click_mask` | ++----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture_disabled` | ++----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture_focused` | ++----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture_hover` | ++----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture_normal` | ++----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture_pressed` | ++----------------------------------------------------+----------------------------------------------------------------------------+ Enumerations ------------ .. _enum_TextureButton_StretchMode: +.. _class_TextureButton_constant_STRETCH_SCALE: + +.. _class_TextureButton_constant_STRETCH_TILE: + +.. _class_TextureButton_constant_STRETCH_KEEP: + +.. _class_TextureButton_constant_STRETCH_KEEP_CENTERED: + +.. _class_TextureButton_constant_STRETCH_KEEP_ASPECT: + +.. _class_TextureButton_constant_STRETCH_KEEP_ASPECT_CENTERED: + +.. _class_TextureButton_constant_STRETCH_KEEP_ASPECT_COVERED: + enum **StretchMode**: - **STRETCH_SCALE** = **0** --- Scale to fit the node's bounding rectangle. @@ -68,7 +82,7 @@ The Normal state's texture is required. Others are optional. Property Descriptions --------------------- -.. _class_TextureButton_expand: +.. _class_TextureButton_property_expand: - :ref:`bool` **expand** @@ -78,9 +92,9 @@ Property Descriptions | *Getter* | get_expand() | +----------+-------------------+ -If ``true``, the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false``, the texture will not scale with the node. Default value: ``false``. +If ``true``, the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false``, the texture will not scale with the node. Default value: ``false``. -.. _class_TextureButton_stretch_mode: +.. _class_TextureButton_property_stretch_mode: - :ref:`StretchMode` **stretch_mode** @@ -90,9 +104,9 @@ If ``true``, the texture stretches to the edges of the node's bounding rectangle | *Getter* | get_stretch_mode() | +----------+-------------------------+ -Controls the texture's behavior when you resize the node's bounding rectangle, **only if** :ref:`expand` is ``true``. Set it to one of the ``STRETCH_*`` constants. See the constants to learn more. +Controls the texture's behavior when you resize the node's bounding rectangle, **only if** :ref:`expand` is ``true``. Set it to one of the ``STRETCH_*`` constants. See the constants to learn more. -.. _class_TextureButton_texture_click_mask: +.. _class_TextureButton_property_texture_click_mask: - :ref:`BitMap` **texture_click_mask** @@ -104,7 +118,7 @@ Controls the texture's behavior when you resize the node's bounding rectangle, * Pure black and white :ref:`BitMap` image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. -.. _class_TextureButton_texture_disabled: +.. _class_TextureButton_property_texture_disabled: - :ref:`Texture` **texture_disabled** @@ -114,9 +128,9 @@ Pure black and white :ref:`BitMap` image to use for click detectio | *Getter* | get_disabled_texture() | +----------+-----------------------------+ -Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. +Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. -.. _class_TextureButton_texture_focused: +.. _class_TextureButton_property_texture_focused: - :ref:`Texture` **texture_focused** @@ -128,7 +142,7 @@ Texture to display when the node is disabled. See :ref:`BaseButton.disabled` **texture_hover** @@ -140,7 +154,7 @@ Texture to display when the node has mouse or keyboard focus. Texture to display when the mouse hovers the node. -.. _class_TextureButton_texture_normal: +.. _class_TextureButton_property_texture_normal: - :ref:`Texture` **texture_normal** @@ -152,7 +166,7 @@ Texture to display when the mouse hovers the node. Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. -.. _class_TextureButton_texture_pressed: +.. _class_TextureButton_property_texture_pressed: - :ref:`Texture` **texture_pressed** @@ -162,5 +176,5 @@ Texture to display by default, when the node is **not** in the disabled, focused | *Getter* | get_pressed_texture() | +----------+----------------------------+ -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. +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. diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 0cc87b707..347f959dc 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -21,38 +21,46 @@ Brief Description Properties ---------- -+-------------------------------------+------------------------------------------+ -| :ref:`Dictionary` | :ref:`data` | -+-------------------------------------+------------------------------------------+ -| :ref:`int` | :ref:`flags` | -+-------------------------------------+------------------------------------------+ ++-------------------------------------+---------------------------------------------------+ +| :ref:`Dictionary` | :ref:`data` | ++-------------------------------------+---------------------------------------------------+ +| :ref:`int` | :ref:`flags` | ++-------------------------------------+---------------------------------------------------+ 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:`Format` | :ref:`get_format` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** 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 **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_data` **(** :ref:`Image` image, :ref:`int` layer **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`Format` | :ref:`get_format` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** 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 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_data` **(** :ref:`Image` image, :ref:`int` layer **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_TextureLayered_Flags: +.. _class_TextureLayered_constant_FLAG_MIPMAPS: + +.. _class_TextureLayered_constant_FLAG_REPEAT: + +.. _class_TextureLayered_constant_FLAG_FILTER: + +.. _class_TextureLayered_constant_FLAGS_DEFAULT: + enum **Flags**: - **FLAG_MIPMAPS** = **1** @@ -66,11 +74,11 @@ enum **Flags**: Property Descriptions --------------------- -.. _class_TextureLayered_data: +.. _class_TextureLayered_property_data: - :ref:`Dictionary` **data** -.. _class_TextureLayered_flags: +.. _class_TextureLayered_property_flags: - :ref:`int` **flags** @@ -83,35 +91,35 @@ Property Descriptions Method Descriptions ------------------- -.. _class_TextureLayered_create: +.. _class_TextureLayered_method_create: - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** -.. _class_TextureLayered_get_depth: +.. _class_TextureLayered_method_get_depth: - :ref:`int` **get_depth** **(** **)** const -.. _class_TextureLayered_get_format: +.. _class_TextureLayered_method_get_format: - :ref:`Format` **get_format** **(** **)** const -.. _class_TextureLayered_get_height: +.. _class_TextureLayered_method_get_height: - :ref:`int` **get_height** **(** **)** const -.. _class_TextureLayered_get_layer_data: +.. _class_TextureLayered_method_get_layer_data: - :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** const -.. _class_TextureLayered_get_width: +.. _class_TextureLayered_method_get_width: - :ref:`int` **get_width** **(** **)** const -.. _class_TextureLayered_set_data_partial: +.. _class_TextureLayered_method_set_data_partial: - void **set_data_partial** **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** -.. _class_TextureLayered_set_layer_data: +.. _class_TextureLayered_method_set_layer_data: - void **set_layer_data** **(** :ref:`Image` image, :ref:`int` layer **)** diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index a121c85c3..9a95c6626 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -19,62 +19,80 @@ Texture-based progress bar. Useful for loading screens and life or stamina bars. Properties ---------- -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`fill_mode` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`nine_patch_stretch` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`radial_center_offset` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_fill_degrees` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_initial_angle` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_bottom` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_left` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_right` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_top` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_over` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_progress` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture_under` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tint_over` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tint_progress` | -+-------------------------------+---------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tint_under` | -+-------------------------------+---------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`fill_mode` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`nine_patch_stretch` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`radial_center_offset` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_fill_degrees` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_initial_angle` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_margin_bottom` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_margin_left` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_margin_right` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_margin_top` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture_over` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture_progress` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture_under` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`tint_over` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`tint_progress` | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`tint_under` | ++-------------------------------+------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_TextureProgress_FillMode: +.. _class_TextureProgress_constant_FILL_LEFT_TO_RIGHT: + +.. _class_TextureProgress_constant_FILL_RIGHT_TO_LEFT: + +.. _class_TextureProgress_constant_FILL_TOP_TO_BOTTOM: + +.. _class_TextureProgress_constant_FILL_BOTTOM_TO_TOP: + +.. _class_TextureProgress_constant_FILL_CLOCKWISE: + +.. _class_TextureProgress_constant_FILL_COUNTER_CLOCKWISE: + +.. _class_TextureProgress_constant_FILL_BILINEAR_LEFT_AND_RIGHT: + +.. _class_TextureProgress_constant_FILL_BILINEAR_TOP_AND_BOTTOM: + +.. _class_TextureProgress_constant_FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE: + enum **FillMode**: -- **FILL_LEFT_TO_RIGHT** = **0** --- The :ref:`texture_progress` fills from left to right. +- **FILL_LEFT_TO_RIGHT** = **0** --- The :ref:`texture_progress` fills from left to right. -- **FILL_RIGHT_TO_LEFT** = **1** --- The :ref:`texture_progress` fills from right to left. +- **FILL_RIGHT_TO_LEFT** = **1** --- The :ref:`texture_progress` fills from right to left. -- **FILL_TOP_TO_BOTTOM** = **2** --- The :ref:`texture_progress` fills from top to bototm. +- **FILL_TOP_TO_BOTTOM** = **2** --- The :ref:`texture_progress` fills from top to bototm. -- **FILL_BOTTOM_TO_TOP** = **3** --- The :ref:`texture_progress` fills from bottom to top. +- **FILL_BOTTOM_TO_TOP** = **3** --- The :ref:`texture_progress` fills from bottom to top. -- **FILL_CLOCKWISE** = **4** --- Turns the node into a radial bar. The :ref:`texture_progress` fills clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to control the way the bar fills up. +- **FILL_CLOCKWISE** = **4** --- Turns the node into a radial bar. The :ref:`texture_progress` fills clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to control the way the bar fills up. -- **FILL_COUNTER_CLOCKWISE** = **5** --- Turns the node into a radial bar. The :ref:`texture_progress` fills counter-clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to control the way the bar fills up. +- **FILL_COUNTER_CLOCKWISE** = **5** --- Turns the node into a radial bar. The :ref:`texture_progress` fills counter-clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to control the way the bar fills up. -- **FILL_BILINEAR_LEFT_AND_RIGHT** = **6** --- The :ref:`texture_progress` fills from the center, expanding both towards the left and the right. +- **FILL_BILINEAR_LEFT_AND_RIGHT** = **6** --- The :ref:`texture_progress` fills from the center, expanding both towards the left and the right. -- **FILL_BILINEAR_TOP_AND_BOTTOM** = **7** --- The :ref:`texture_progress` fills from the center, expanding both towards the top and the bottom. +- **FILL_BILINEAR_TOP_AND_BOTTOM** = **7** --- The :ref:`texture_progress` fills from the center, expanding both towards the top and the bottom. -- **FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE** = **8** --- Turns the node into a radial bar. The :ref:`texture_progress` fills radially from the center, expanding both clockwise and counter-clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to control the way the bar fills up. +- **FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE** = **8** --- Turns the node into a radial bar. The :ref:`texture_progress` fills radially from the center, expanding both clockwise and counter-clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to control the way the bar fills up. Description ----------- @@ -84,7 +102,7 @@ TextureProgress works like :ref:`ProgressBar` but it uses up Property Descriptions --------------------- -.. _class_TextureProgress_fill_mode: +.. _class_TextureProgress_property_fill_mode: - :ref:`int` **fill_mode** @@ -96,7 +114,7 @@ Property Descriptions The fill direction. Uses FILL\_\* constants. -.. _class_TextureProgress_nine_patch_stretch: +.. _class_TextureProgress_property_nine_patch_stretch: - :ref:`bool` **nine_patch_stretch** @@ -106,9 +124,9 @@ The fill direction. Uses FILL\_\* constants. | *Getter* | get_nine_patch_stretch() | +----------+-------------------------------+ -If ``true``, Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin_*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. +If ``true``, Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin_*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. -.. _class_TextureProgress_radial_center_offset: +.. _class_TextureProgress_property_radial_center_offset: - :ref:`Vector2` **radial_center_offset** @@ -118,9 +136,9 @@ If ``true``, Godot treats the bar's textures like :ref:`NinePatchRect` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. +Offsets :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. -.. _class_TextureProgress_radial_fill_degrees: +.. _class_TextureProgress_property_radial_fill_degrees: - :ref:`float` **radial_fill_degrees** @@ -130,11 +148,11 @@ Offsets :ref:`texture_progress` if :ref: | *Getter* | get_fill_degrees() | +----------+-------------------------+ -Upper limit for the fill of :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. When the node's ``value`` is equal to its ``max_value``, the texture fills up to this angle. +Upper limit for the fill of :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. When the node's ``value`` is equal to its ``max_value``, the texture fills up to this angle. -See :ref:`Range.value`, :ref:`Range.max_value`. +See :ref:`Range.value`, :ref:`Range.max_value`. -.. _class_TextureProgress_radial_initial_angle: +.. _class_TextureProgress_property_radial_initial_angle: - :ref:`float` **radial_initial_angle** @@ -144,9 +162,9 @@ See :ref:`Range.value`, :ref:`Range.max_value` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. When the node's ``value`` is equal to its ``min_value``, the texture doesn't show up at all. When the ``value`` increases, the texture fills and tends towards :ref:`radial_fill_degrees`. +Starting angle for the fill of :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. When the node's ``value`` is equal to its ``min_value``, the texture doesn't show up at all. When the ``value`` increases, the texture fills and tends towards :ref:`radial_fill_degrees`. -.. _class_TextureProgress_stretch_margin_bottom: +.. _class_TextureProgress_property_stretch_margin_bottom: - :ref:`int` **stretch_margin_bottom** @@ -158,7 +176,7 @@ Starting angle for the fill of :ref:`texture_progress` **stretch_margin_left** @@ -170,7 +188,7 @@ The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's botto The width of the 9-patch's left column. -.. _class_TextureProgress_stretch_margin_right: +.. _class_TextureProgress_property_stretch_margin_right: - :ref:`int` **stretch_margin_right** @@ -182,7 +200,7 @@ The width of the 9-patch's left column. The width of the 9-patch's right column. -.. _class_TextureProgress_stretch_margin_top: +.. _class_TextureProgress_property_stretch_margin_top: - :ref:`int` **stretch_margin_top** @@ -194,7 +212,7 @@ The width of the 9-patch's right column. The height of the 9-patch's top row. -.. _class_TextureProgress_texture_over: +.. _class_TextureProgress_property_texture_over: - :ref:`Texture` **texture_over** @@ -204,9 +222,9 @@ The height of the 9-patch's top row. | *Getter* | get_over_texture() | +----------+-------------------------+ -:ref:`Texture` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. +:ref:`Texture` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. -.. _class_TextureProgress_texture_progress: +.. _class_TextureProgress_property_texture_progress: - :ref:`Texture` **texture_progress** @@ -216,11 +234,11 @@ The height of the 9-patch's top row. | *Getter* | get_progress_texture() | +----------+-----------------------------+ -:ref:`Texture` that clips based on the node's ``value`` and :ref:`fill_mode`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. +:ref:`Texture` that clips based on the node's ``value`` and :ref:`fill_mode`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. -The ``value`` property comes from :ref:`Range`. See :ref:`Range.value`, :ref:`Range.min_value`, :ref:`Range.max_value`. +The ``value`` property comes from :ref:`Range`. See :ref:`Range.value`, :ref:`Range.min_value`, :ref:`Range.max_value`. -.. _class_TextureProgress_texture_under: +.. _class_TextureProgress_property_texture_under: - :ref:`Texture` **texture_under** @@ -232,7 +250,7 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val :ref:`Texture` that draws under the progress bar. The bar's background. -.. _class_TextureProgress_tint_over: +.. _class_TextureProgress_property_tint_over: - :ref:`Color` **tint_over** @@ -242,9 +260,9 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val | *Getter* | get_tint_over() | +----------+----------------------+ -Multiplies the color of the bar's ``texture_over`` texture. The effect is similar to :ref:`CanvasItem.modulate`, except it only affects this specific texture instead of the entire node. +Multiplies the color of the bar's ``texture_over`` texture. The effect is similar to :ref:`CanvasItem.modulate`, except it only affects this specific texture instead of the entire node. -.. _class_TextureProgress_tint_progress: +.. _class_TextureProgress_property_tint_progress: - :ref:`Color` **tint_progress** @@ -256,7 +274,7 @@ Multiplies the color of the bar's ``texture_over`` texture. The effect is simila Multiplies the color of the bar's ``texture_progress`` texture. -.. _class_TextureProgress_tint_under: +.. _class_TextureProgress_property_tint_under: - :ref:`Color` **tint_under** diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 7b975055f..c47e9b50c 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -19,19 +19,35 @@ Control for drawing textures. Properties ---------- -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`expand` | -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`StretchMode` | :ref:`stretch_mode` | -+--------------------------------------------------+-----------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+--------------------------------------------------+-----------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`bool` | :ref:`expand` | ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`StretchMode` | :ref:`stretch_mode` | ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++--------------------------------------------------+--------------------------------------------------------------+ Enumerations ------------ .. _enum_TextureRect_StretchMode: +.. _class_TextureRect_constant_STRETCH_SCALE_ON_EXPAND: + +.. _class_TextureRect_constant_STRETCH_SCALE: + +.. _class_TextureRect_constant_STRETCH_TILE: + +.. _class_TextureRect_constant_STRETCH_KEEP: + +.. _class_TextureRect_constant_STRETCH_KEEP_CENTERED: + +.. _class_TextureRect_constant_STRETCH_KEEP_ASPECT: + +.. _class_TextureRect_constant_STRETCH_KEEP_ASPECT_CENTERED: + +.. _class_TextureRect_constant_STRETCH_KEEP_ASPECT_COVERED: + enum **StretchMode**: - **STRETCH_SCALE_ON_EXPAND** = **0** --- Scale to fit the node's bounding rectangle, only if ``expand`` is ``true``. Default ``stretch_mode``, for backwards compatibility. Until you set ``expand`` to ``true``, the texture will behave like ``STRETCH_KEEP``. @@ -53,12 +69,12 @@ enum **StretchMode**: Description ----------- -Used to draw icons and sprites in a user interface. The texture's placement can be controlled with the :ref:`stretch_mode` property. It can scale, tile, or stay centered inside its bounding rectangle. +Used to draw icons and sprites in a user interface. The texture's placement can be controlled with the :ref:`stretch_mode` property. It can scale, tile, or stay centered inside its bounding rectangle. Property Descriptions --------------------- -.. _class_TextureRect_expand: +.. _class_TextureRect_property_expand: - :ref:`bool` **expand** @@ -70,7 +86,7 @@ Property Descriptions If ``true``, the texture scales to fit its bounding rectangle. Default value: ``false``. -.. _class_TextureRect_stretch_mode: +.. _class_TextureRect_property_stretch_mode: - :ref:`StretchMode` **stretch_mode** @@ -80,9 +96,9 @@ If ``true``, the texture scales to fit its bounding rectangle. Default value: `` | *Getter* | get_stretch_mode() | +----------+-------------------------+ -Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. +Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. -.. _class_TextureRect_texture: +.. _class_TextureRect_property_texture: - :ref:`Texture` **texture** diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 017712a32..a731a25d1 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -19,72 +19,72 @@ Theme for controls. Properties ---------- -+-------------------------+-----------------------------------------------+ -| :ref:`Font` | :ref:`default_font` | -+-------------------------+-----------------------------------------------+ ++-------------------------+--------------------------------------------------------+ +| :ref:`Font` | :ref:`default_font` | ++-------------------------+--------------------------------------------------------+ Methods ------- -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_color` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_constant` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_font` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_icon` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_stylebox` **(** :ref:`String` name, :ref:`String` type **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_default_theme` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :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:`PoolStringArray` | :ref:`get_constant_list` **(** :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:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :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:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** 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_constant` **(** :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_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stylebox` **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_color` **(** :ref:`String` name, :ref:`String` type **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_constant` **(** :ref:`String` name, :ref:`String` type **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_font` **(** :ref:`String` name, :ref:`String` type **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_icon` **(** :ref:`String` name, :ref:`String` type **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_stylebox` **(** :ref:`String` name, :ref:`String` type **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_default_theme` **(** **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :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:`PoolStringArray` | :ref:`get_constant_list` **(** :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:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :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:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** 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_constant` **(** :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_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stylebox` **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -96,7 +96,7 @@ Theme resources can be alternatively loaded by writing them in a .theme file, se Property Descriptions --------------------- -.. _class_Theme_default_font: +.. _class_Theme_property_default_font: - :ref:`Font` **default_font** @@ -111,119 +111,119 @@ The theme's default font. Method Descriptions ------------------- -.. _class_Theme_clear: +.. _class_Theme_method_clear: - void **clear** **(** **)** -.. _class_Theme_clear_color: +.. _class_Theme_method_clear_color: - void **clear_color** **(** :ref:`String` name, :ref:`String` type **)** Clears theme :ref:`Color` at ``name`` if Theme has ``type``. -.. _class_Theme_clear_constant: +.. _class_Theme_method_clear_constant: - void **clear_constant** **(** :ref:`String` name, :ref:`String` type **)** Clears theme constant at ``name`` if Theme has ``type``. -.. _class_Theme_clear_font: +.. _class_Theme_method_clear_font: - void **clear_font** **(** :ref:`String` name, :ref:`String` type **)** Clears :ref:`Font` at ``name`` if Theme has ``type``. -.. _class_Theme_clear_icon: +.. _class_Theme_method_clear_icon: - void **clear_icon** **(** :ref:`String` name, :ref:`String` type **)** Clears icon at ``name`` if Theme has ``type``. -.. _class_Theme_clear_stylebox: +.. _class_Theme_method_clear_stylebox: - void **clear_stylebox** **(** :ref:`String` name, :ref:`String` type **)** Clears :ref:`StyleBox` at ``name`` if Theme has ``type``. -.. _class_Theme_copy_default_theme: +.. _class_Theme_method_copy_default_theme: - void **copy_default_theme** **(** **)** Sets theme values to a copy of the default theme values. -.. _class_Theme_get_color: +.. _class_Theme_method_get_color: - :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** const Returns the :ref:`Color` at ``name`` if Theme has ``type``. -.. _class_Theme_get_color_list: +.. _class_Theme_method_get_color_list: - :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** const -Returns all of the :ref:`Color`\ s as a :ref:`PoolStringArray` filled with each :ref:`Color`'s name, for use in :ref:`get_color`, if Theme has ``type``. +Returns all of the :ref:`Color`\ s as a :ref:`PoolStringArray` filled with each :ref:`Color`'s name, for use in :ref:`get_color`, if Theme has ``type``. -.. _class_Theme_get_constant: +.. _class_Theme_method_get_constant: - :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type **)** const Returns the constant at ``name`` if Theme has ``type``. -.. _class_Theme_get_constant_list: +.. _class_Theme_method_get_constant_list: - :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const -Returns all of the constants as a :ref:`PoolStringArray` filled with each constant's name, for use in :ref:`get_constant`, if Theme has ``type``. +Returns all of the constants as a :ref:`PoolStringArray` filled with each constant's name, for use in :ref:`get_constant`, if Theme has ``type``. -.. _class_Theme_get_font: +.. _class_Theme_method_get_font: - :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const Returns the :ref:`Font` at ``name`` if Theme has ``type``. -.. _class_Theme_get_font_list: +.. _class_Theme_method_get_font_list: - :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** const -Returns all of the :ref:`Font`\ s as a :ref:`PoolStringArray` filled with each :ref:`Font`'s name, for use in :ref:`get_font`, if Theme has ``type``. +Returns all of the :ref:`Font`\ s as a :ref:`PoolStringArray` filled with each :ref:`Font`'s name, for use in :ref:`get_font`, if Theme has ``type``. -.. _class_Theme_get_icon: +.. _class_Theme_method_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** const Returns the icon :ref:`Texture` at ``name`` if Theme has ``type``. -.. _class_Theme_get_icon_list: +.. _class_Theme_method_get_icon_list: - :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** const -Returns all of the icons as a :ref:`PoolStringArray` filled with each :ref:`Texture`'s name, for use in :ref:`get_icon`, if Theme has ``type``. +Returns all of the icons as a :ref:`PoolStringArray` filled with each :ref:`Texture`'s name, for use in :ref:`get_icon`, if Theme has ``type``. -.. _class_Theme_get_stylebox: +.. _class_Theme_method_get_stylebox: - :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const Returns the icon :ref:`StyleBox` at ``name`` if Theme has ``type``. -.. _class_Theme_get_stylebox_list: +.. _class_Theme_method_get_stylebox_list: - :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const -Returns all of the :ref:`StyleBox`\ s as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s name, for use in :ref:`get_stylebox`, if Theme has ``type``. +Returns all of the :ref:`StyleBox`\ s as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s name, for use in :ref:`get_stylebox`, if Theme has ``type``. -.. _class_Theme_get_stylebox_types: +.. _class_Theme_method_get_stylebox_types: - :ref:`PoolStringArray` **get_stylebox_types** **(** **)** const -Returns all of 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 Theme has ``type``. +Returns all of 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 Theme has ``type``. -.. _class_Theme_get_type_list: +.. _class_Theme_method_get_type_list: - :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** const Returns all of the types in ``type`` as a :ref:`PoolStringArray` for use in any of the get\_\* functions, if Theme has ``type``. -.. _class_Theme_has_color: +.. _class_Theme_method_has_color: - :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const @@ -231,7 +231,7 @@ Returns ``true`` if :ref:`Color` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. -.. _class_Theme_has_constant: +.. _class_Theme_method_has_constant: - :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const @@ -239,7 +239,7 @@ Returns ``true`` if constant with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. -.. _class_Theme_has_font: +.. _class_Theme_method_has_font: - :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const @@ -247,7 +247,7 @@ Returns ``true`` if :ref:`Font` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. -.. _class_Theme_has_icon: +.. _class_Theme_method_has_icon: - :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const @@ -255,7 +255,7 @@ Returns ``true`` if icon :ref:`Texture` with ``name`` is in ``typ Returns ``false`` if Theme does not have ``type``. -.. _class_Theme_has_stylebox: +.. _class_Theme_method_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const @@ -263,7 +263,7 @@ Returns ``true`` if :ref:`StyleBox` with ``name`` is in ``type`` Returns ``false`` if Theme does not have ``type``. -.. _class_Theme_set_color: +.. _class_Theme_method_set_color: - void **set_color** **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** @@ -271,7 +271,7 @@ Sets Theme's :ref:`Color` to ``color`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. -.. _class_Theme_set_constant: +.. _class_Theme_method_set_constant: - void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** @@ -279,7 +279,7 @@ Sets Theme's constant to ``constant`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. -.. _class_Theme_set_font: +.. _class_Theme_method_set_font: - void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** @@ -287,7 +287,7 @@ Sets Theme's :ref:`Font` to ``font`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. -.. _class_Theme_set_icon: +.. _class_Theme_method_set_icon: - void **set_icon** **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** @@ -295,7 +295,7 @@ Sets Theme's icon :ref:`Texture` to ``texture`` at ``name`` in `` Does nothing if Theme does not have ``type``. -.. _class_Theme_set_stylebox: +.. _class_Theme_method_set_stylebox: - void **set_stylebox** **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 5c9d0943d..f16012263 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -19,21 +19,27 @@ A unit of execution in a process. Methods ------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_id` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_id` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Thread_Priority: +.. _class_Thread_constant_PRIORITY_LOW: + +.. _class_Thread_constant_PRIORITY_NORMAL: + +.. _class_Thread_constant_PRIORITY_HIGH: + enum **Priority**: - **PRIORITY_LOW** = **0** @@ -50,19 +56,19 @@ A unit of execution in a process. Can run methods on :ref:`Object` Method Descriptions ------------------- -.. _class_Thread_get_id: +.. _class_Thread_method_get_id: - :ref:`String` **get_id** **(** **)** const Returns the current ``Thread``\ s id, uniquely identifying it among all threads. -.. _class_Thread_is_active: +.. _class_Thread_method_is_active: - :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`. +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`. -.. _class_Thread_start: +.. _class_Thread_method_start: - :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** @@ -70,7 +76,7 @@ Starts a new ``Thread`` that runs "method" on object "instance" with "userdata" Returns OK on success, or ERR_CANT_CREATE on failure. -.. _class_Thread_wait_to_finish: +.. _class_Thread_method_wait_to_finish: - :ref:`Variant` **wait_to_finish** **(** **)** diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index dfab2aa5f..b762ebc65 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -19,91 +19,91 @@ Node for 2D tile-based maps. Properties ---------- -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_clip_uv` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`cell_custom_transform` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`HalfOffset` | :ref:`cell_half_offset` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`cell_quadrant_size` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`cell_size` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`TileOrigin` | :ref:`cell_tile_origin` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cell_y_sort` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`collision_bounce` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`collision_friction` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_layer` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`collision_mask` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collision_use_kinematic` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`occluder_light_mask` | -+--------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`TileSet` | :ref:`tile_set` | -+--------------------------------------------+-----------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cell_clip_uv` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`cell_custom_transform` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`HalfOffset` | :ref:`cell_half_offset` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cell_quadrant_size` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`cell_size` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`TileOrigin` | :ref:`cell_tile_origin` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cell_y_sort` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`collision_bounce` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`collision_friction` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collision_use_kinematic` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`occluder_light_mask` | ++--------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`TileSet` | :ref:`tile_set` | ++--------------------------------------------+--------------------------------------------------------------------------------+ Methods ------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fix_invalid_tiles` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_bitmask_area` **(** :ref:`Vector2` position **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_bitmask_region` **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_dirty_quadrants` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fix_invalid_tiles` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_bitmask_area` **(** :ref:`Vector2` position **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_bitmask_region` **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_dirty_quadrants` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_TileMap_settings_changed: +.. _class_TileMap_signal_settings_changed: - **settings_changed** **(** **)** @@ -114,6 +114,12 @@ Enumerations .. _enum_TileMap_Mode: +.. _class_TileMap_constant_MODE_SQUARE: + +.. _class_TileMap_constant_MODE_ISOMETRIC: + +.. _class_TileMap_constant_MODE_CUSTOM: + enum **Mode**: - **MODE_SQUARE** = **0** --- Orthogonal orientation mode. @@ -124,6 +130,12 @@ enum **Mode**: .. _enum_TileMap_HalfOffset: +.. _class_TileMap_constant_HALF_OFFSET_X: + +.. _class_TileMap_constant_HALF_OFFSET_Y: + +.. _class_TileMap_constant_HALF_OFFSET_DISABLED: + enum **HalfOffset**: - **HALF_OFFSET_X** = **0** --- Half offset on the X coordinate. @@ -134,6 +146,12 @@ enum **HalfOffset**: .. _enum_TileMap_TileOrigin: +.. _class_TileMap_constant_TILE_ORIGIN_TOP_LEFT: + +.. _class_TileMap_constant_TILE_ORIGIN_CENTER: + +.. _class_TileMap_constant_TILE_ORIGIN_BOTTOM_LEFT: + enum **TileOrigin**: - **TILE_ORIGIN_TOP_LEFT** = **0** --- Tile origin at its top-left corner. @@ -145,6 +163,8 @@ enum **TileOrigin**: Constants --------- +.. _class_TileMap_constant_INVALID_CELL: + - **INVALID_CELL** = **-1** --- Returned when a cell doesn't exist. Description @@ -160,7 +180,7 @@ Tutorials Property Descriptions --------------------- -.. _class_TileMap_cell_clip_uv: +.. _class_TileMap_property_cell_clip_uv: - :ref:`bool` **cell_clip_uv** @@ -170,7 +190,7 @@ Property Descriptions | *Getter* | get_clip_uv() | +----------+--------------------+ -.. _class_TileMap_cell_custom_transform: +.. _class_TileMap_property_cell_custom_transform: - :ref:`Transform2D` **cell_custom_transform** @@ -182,7 +202,7 @@ Property Descriptions The custom :ref:`Transform2D` to be applied to the TileMap's cells. -.. _class_TileMap_cell_half_offset: +.. _class_TileMap_property_cell_half_offset: - :ref:`HalfOffset` **cell_half_offset** @@ -194,7 +214,7 @@ The custom :ref:`Transform2D` to be applied to the TileMap's Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default value: HALF_OFFSET_DISABLED. -.. _class_TileMap_cell_quadrant_size: +.. _class_TileMap_property_cell_quadrant_size: - :ref:`int` **cell_quadrant_size** @@ -206,7 +226,7 @@ Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default valu The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. -.. _class_TileMap_cell_size: +.. _class_TileMap_property_cell_size: - :ref:`Vector2` **cell_size** @@ -218,7 +238,7 @@ The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this The TileMap's cell size. -.. _class_TileMap_cell_tile_origin: +.. _class_TileMap_property_cell_tile_origin: - :ref:`TileOrigin` **cell_tile_origin** @@ -230,7 +250,7 @@ The TileMap's cell size. Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_ORIGIN_TOP_LEFT. -.. _class_TileMap_cell_y_sort: +.. _class_TileMap_property_cell_y_sort: - :ref:`bool` **cell_y_sort** @@ -242,7 +262,7 @@ Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_OR If ``true``, the TileMap's children will be drawn in order of their Y coordinate. Default value: ``false``. -.. _class_TileMap_collision_bounce: +.. _class_TileMap_property_collision_bounce: - :ref:`float` **collision_bounce** @@ -254,7 +274,7 @@ If ``true``, the TileMap's children will be drawn in order of their Y coordinate Bounce value for static body collisions (see ``collision_use_kinematic``). Default value: 0. -.. _class_TileMap_collision_friction: +.. _class_TileMap_property_collision_friction: - :ref:`float` **collision_friction** @@ -266,7 +286,7 @@ Bounce value for static body collisions (see ``collision_use_kinematic``). Defau Friction value for static body collisions (see ``collision_use_kinematic``). Default value: 1. -.. _class_TileMap_collision_layer: +.. _class_TileMap_property_collision_layer: - :ref:`int` **collision_layer** @@ -278,7 +298,7 @@ Friction value for static body collisions (see ``collision_use_kinematic``). Def The collision layer(s) for all colliders in the TileMap. -.. _class_TileMap_collision_mask: +.. _class_TileMap_property_collision_mask: - :ref:`int` **collision_mask** @@ -290,7 +310,7 @@ The collision layer(s) for all colliders in the TileMap. The collision mask(s) for all colliders in the TileMap. -.. _class_TileMap_collision_use_kinematic: +.. _class_TileMap_property_collision_use_kinematic: - :ref:`bool` **collision_use_kinematic** @@ -302,7 +322,7 @@ The collision mask(s) for all colliders in the TileMap. If ``true``, TileMap collisions will be handled as a kinematic body. If ``false``, collisions will be handled as static body. Default value: ``false``. -.. _class_TileMap_mode: +.. _class_TileMap_property_mode: - :ref:`Mode` **mode** @@ -314,7 +334,7 @@ If ``true``, TileMap collisions will be handled as a kinematic body. If ``false` The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUARE. -.. _class_TileMap_occluder_light_mask: +.. _class_TileMap_property_occluder_light_mask: - :ref:`int` **occluder_light_mask** @@ -326,7 +346,7 @@ The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUAR The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). -.. _class_TileMap_tile_set: +.. _class_TileMap_property_tile_set: - :ref:`TileSet` **tile_set** @@ -341,83 +361,83 @@ The assigned :ref:`TileSet`. Method Descriptions ------------------- -.. _class_TileMap_clear: +.. _class_TileMap_method_clear: - void **clear** **(** **)** Clears all cells. -.. _class_TileMap_fix_invalid_tiles: +.. _class_TileMap_method_fix_invalid_tiles: - void **fix_invalid_tiles** **(** **)** Clears cells that do not exist in the tileset. -.. _class_TileMap_get_cell: +.. _class_TileMap_method_get_cell: - :ref:`int` **get_cell** **(** :ref:`int` x, :ref:`int` y **)** const Returns the tile index of the given cell. -.. _class_TileMap_get_cell_autotile_coord: +.. _class_TileMap_method_get_cell_autotile_coord: - :ref:`Vector2` **get_cell_autotile_coord** **(** :ref:`int` x, :ref:`int` y **)** const -.. _class_TileMap_get_cellv: +.. _class_TileMap_method_get_cellv: - :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const Returns the tile index of the cell given by a Vector2. -.. _class_TileMap_get_collision_layer_bit: +.. _class_TileMap_method_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns ``true`` if the given collision layer bit is set. -.. _class_TileMap_get_collision_mask_bit: +.. _class_TileMap_method_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns ``true`` if the given collision mask bit is set. -.. _class_TileMap_get_used_cells: +.. _class_TileMap_method_get_used_cells: - :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``). -.. _class_TileMap_get_used_cells_by_id: +.. _class_TileMap_method_get_used_cells_by_id: - :ref:`Array` **get_used_cells_by_id** **(** :ref:`int` id **)** const Returns an array of all cells with the given tile id. -.. _class_TileMap_get_used_rect: +.. _class_TileMap_method_get_used_rect: - :ref:`Rect2` **get_used_rect** **(** **)** Returns a rectangle enclosing the used (non-empty) tiles of the map. -.. _class_TileMap_is_cell_transposed: +.. _class_TileMap_method_is_cell_transposed: - :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. -.. _class_TileMap_is_cell_x_flipped: +.. _class_TileMap_method_is_cell_x_flipped: - :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. -.. _class_TileMap_is_cell_y_flipped: +.. _class_TileMap_method_is_cell_y_flipped: - :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. -.. _class_TileMap_map_to_world: +.. _class_TileMap_method_map_to_world: - :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const @@ -425,7 +445,7 @@ Returns the global position corresponding to the given tilemap (grid-based) coor Optionally, the tilemap's half offset can be ignored. -.. _class_TileMap_set_cell: +.. _class_TileMap_method_set_cell: - void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** @@ -437,9 +457,9 @@ Optionally, the tile can also be flipped, transposed, or given autotile coordina Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons. -If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. +If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. -.. _class_TileMap_set_cellv: +.. _class_TileMap_method_set_cellv: - void **set_cellv** **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** @@ -451,27 +471,27 @@ Optionally, the tile can also be flipped or transposed. Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons. -If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. +If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. -.. _class_TileMap_set_collision_layer_bit: +.. _class_TileMap_method_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets the given collision layer bit. -.. _class_TileMap_set_collision_mask_bit: +.. _class_TileMap_method_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets the given collision mask bit. -.. _class_TileMap_update_bitmask_area: +.. _class_TileMap_method_update_bitmask_area: - void **update_bitmask_area** **(** :ref:`Vector2` position **)** Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based x and y coordinates. -.. _class_TileMap_update_bitmask_region: +.. _class_TileMap_method_update_bitmask_region: - void **update_bitmask_region** **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** @@ -479,13 +499,13 @@ Applies autotiling rules to the cells in the given region (specified by grid-bas Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap. -.. _class_TileMap_update_dirty_quadrants: +.. _class_TileMap_method_update_dirty_quadrants: - void **update_dirty_quadrants** **(** **)** Updates the tile map's quadrants, allowing things such as navigation and collision shapes to be immediately used if modified. -.. _class_TileMap_world_to_map: +.. _class_TileMap_method_world_to_map: - :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index c79081eb2..c9b6f109b 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -19,143 +19,149 @@ Tile library for tilemaps. Methods ------- -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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:`NavigationPolygon` | :ref:`autotile_get_navigation_polygon` **(** :ref:`int` id, :ref:`Vector2` coord **)** 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_subtile_priority` **(** :ref:`int` id, :ref:`Vector2` coord **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`autotile_get_z_index` **(** :ref:`int` id, :ref:`Vector2` coord **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_bitmask` **(** :ref:`int` id, :ref:`Vector2` bitmask, :ref:`int` flag **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_bitmask_mode` **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_icon_coordinate` **(** :ref:`int` id, :ref:`Vector2` coord **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder, :ref:`Vector2` coord **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon, :ref:`Vector2` coord **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_size` **(** :ref:`int` id, :ref:`Vector2` size **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_spacing` **(** :ref:`int` id, :ref:`int` spacing **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_subtile_priority` **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` priority **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_z_index` **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` z_index **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tile_get_modulate` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`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:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TileMode` | :ref:`tile_get_tile_mode` **(** :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 **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_modulate` **(** :ref:`int` id, :ref:`Color` color **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_offset` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Vector2` shape_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_tile_mode` **(** :ref:`int` id, :ref:`TileMode` tilemode **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_z_index` **(** :ref:`int` id, :ref:`int` z_index **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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:`NavigationPolygon` | :ref:`autotile_get_navigation_polygon` **(** :ref:`int` id, :ref:`Vector2` coord **)** 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_subtile_priority` **(** :ref:`int` id, :ref:`Vector2` coord **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`autotile_get_z_index` **(** :ref:`int` id, :ref:`Vector2` coord **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_bitmask` **(** :ref:`int` id, :ref:`Vector2` bitmask, :ref:`int` flag **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_bitmask_mode` **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_icon_coordinate` **(** :ref:`int` id, :ref:`Vector2` coord **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder, :ref:`Vector2` coord **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon, :ref:`Vector2` coord **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_size` **(** :ref:`int` id, :ref:`Vector2` size **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_spacing` **(** :ref:`int` id, :ref:`int` spacing **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_subtile_priority` **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` priority **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_z_index` **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` z_index **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_tile` **(** :ref:`int` id **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tile` **(** :ref:`int` id **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`tile_get_modulate` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`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:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TileMode` | :ref:`tile_get_tile_mode` **(** :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 **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_modulate` **(** :ref:`int` id, :ref:`Color` color **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_offset` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Vector2` shape_offset **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_tile_mode` **(** :ref:`int` id, :ref:`TileMode` tilemode **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_z_index` **(** :ref:`int` id, :ref:`int` z_index **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_TileSet_BitmaskMode: +.. _class_TileSet_constant_BITMASK_2X2: + +.. _class_TileSet_constant_BITMASK_3X3_MINIMAL: + +.. _class_TileSet_constant_BITMASK_3X3: + enum **BitmaskMode**: - **BITMASK_2X2** = **0** @@ -166,6 +172,22 @@ enum **BitmaskMode**: .. _enum_TileSet_AutotileBindings: +.. _class_TileSet_constant_BIND_TOPLEFT: + +.. _class_TileSet_constant_BIND_TOP: + +.. _class_TileSet_constant_BIND_TOPRIGHT: + +.. _class_TileSet_constant_BIND_LEFT: + +.. _class_TileSet_constant_BIND_RIGHT: + +.. _class_TileSet_constant_BIND_BOTTOMLEFT: + +.. _class_TileSet_constant_BIND_BOTTOM: + +.. _class_TileSet_constant_BIND_BOTTOMRIGHT: + enum **AutotileBindings**: - **BIND_TOPLEFT** = **1** @@ -186,6 +208,12 @@ enum **AutotileBindings**: .. _enum_TileSet_TileMode: +.. _class_TileSet_constant_SINGLE_TILE: + +.. _class_TileSet_constant_AUTO_TILE: + +.. _class_TileSet_constant_ATLAS_TILE: + enum **TileMode**: - **SINGLE_TILE** = **0** @@ -204,21 +232,21 @@ Tiles are referenced by a unique integer ID. Method Descriptions ------------------- -.. _class_TileSet__forward_subtile_selection: +.. _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 -.. _class_TileSet__is_tile_bound: +.. _class_TileSet_method__is_tile_bound: - :ref:`bool` **_is_tile_bound** **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** virtual -.. _class_TileSet_autotile_clear_bitmask_map: +.. _class_TileSet_method_autotile_clear_bitmask_map: - void **autotile_clear_bitmask_map** **(** :ref:`int` id **)** Clears all bitmask info of the autotile. -.. _class_TileSet_autotile_get_bitmask: +.. _class_TileSet_method_autotile_get_bitmask: - :ref:`int` **autotile_get_bitmask** **(** :ref:`int` id, :ref:`Vector2` coord **)** @@ -226,13 +254,13 @@ Returns the bitmask of the subtile from an autotile given its coordinates. The value is the sum of the values in :ref:`AutotileBindings` present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right). -.. _class_TileSet_autotile_get_bitmask_mode: +.. _class_TileSet_method_autotile_get_bitmask_mode: - :ref:`BitmaskMode` **autotile_get_bitmask_mode** **(** :ref:`int` id **)** const Returns the :ref:`BitmaskMode` of the autotile. -.. _class_TileSet_autotile_get_icon_coordinate: +.. _class_TileSet_method_autotile_get_icon_coordinate: - :ref:`Vector2` **autotile_get_icon_coordinate** **(** :ref:`int` id **)** const @@ -240,31 +268,31 @@ Returns the subtile that's being used as an icon in an atlas/autotile given its The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask info is incomplete. It will also be used to represent it in the TileSet editor. -.. _class_TileSet_autotile_get_light_occluder: +.. _class_TileSet_method_autotile_get_light_occluder: - :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. -.. _class_TileSet_autotile_get_navigation_polygon: +.. _class_TileSet_method_autotile_get_navigation_polygon: - :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. -.. _class_TileSet_autotile_get_size: +.. _class_TileSet_method_autotile_get_size: - :ref:`Vector2` **autotile_get_size** **(** :ref:`int` id **)** const Returns the size of the subtiles in an atlas/autotile. -.. _class_TileSet_autotile_get_spacing: +.. _class_TileSet_method_autotile_get_spacing: - :ref:`int` **autotile_get_spacing** **(** :ref:`int` id **)** const Returns the spacing between subtiles of the atlas/autotile. -.. _class_TileSet_autotile_get_subtile_priority: +.. _class_TileSet_method_autotile_get_subtile_priority: - :ref:`int` **autotile_get_subtile_priority** **(** :ref:`int` id, :ref:`Vector2` coord **)** @@ -272,13 +300,13 @@ Returns the priority of the subtile from an autotile given its coordinates. When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked. -.. _class_TileSet_autotile_get_z_index: +.. _class_TileSet_method_autotile_get_z_index: - :ref:`int` **autotile_get_z_index** **(** :ref:`int` id, :ref:`Vector2` coord **)** Returns the drawing index of the subtile from an atlas/autotile given its coordinates. -.. _class_TileSet_autotile_set_bitmask: +.. _class_TileSet_method_autotile_set_bitmask: - void **autotile_set_bitmask** **(** :ref:`int` id, :ref:`Vector2` bitmask, :ref:`int` flag **)** @@ -286,13 +314,13 @@ Sets the bitmask of the subtile from an autotile given its coordinates. The value is the sum of the values in :ref:`AutotileBindings` present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right). -.. _class_TileSet_autotile_set_bitmask_mode: +.. _class_TileSet_method_autotile_set_bitmask_mode: - void **autotile_set_bitmask_mode** **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** Sets the :ref:`BitmaskMode` of the autotile. -.. _class_TileSet_autotile_set_icon_coordinate: +.. _class_TileSet_method_autotile_set_icon_coordinate: - void **autotile_set_icon_coordinate** **(** :ref:`int` id, :ref:`Vector2` coord **)** @@ -300,31 +328,31 @@ Sets the subtile that will be used as an icon in an atlas/autotile given its coo The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask info is incomplete. It will also be used to represent it in the TileSet editor. -.. _class_TileSet_autotile_set_light_occluder: +.. _class_TileSet_method_autotile_set_light_occluder: - void **autotile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder, :ref:`Vector2` coord **)** Sets the light occluder of the subtile from an atlas/autotile given its coordinates. -.. _class_TileSet_autotile_set_navigation_polygon: +.. _class_TileSet_method_autotile_set_navigation_polygon: - void **autotile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon, :ref:`Vector2` coord **)** Sets the navigation polygon of the subtile from an atlas/autotile given its coordinates. -.. _class_TileSet_autotile_set_size: +.. _class_TileSet_method_autotile_set_size: - void **autotile_set_size** **(** :ref:`int` id, :ref:`Vector2` size **)** Sets the size of the subtiles in an atlas/autotile. -.. _class_TileSet_autotile_set_spacing: +.. _class_TileSet_method_autotile_set_spacing: - void **autotile_set_spacing** **(** :ref:`int` id, :ref:`int` spacing **)** Sets the spacing between subtiles of the atlas/autotile. -.. _class_TileSet_autotile_set_subtile_priority: +.. _class_TileSet_method_autotile_set_subtile_priority: - void **autotile_set_subtile_priority** **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` priority **)** @@ -332,271 +360,271 @@ Sets the priority of the subtile from an autotile given its coordinates. When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked. -.. _class_TileSet_autotile_set_z_index: +.. _class_TileSet_method_autotile_set_z_index: - void **autotile_set_z_index** **(** :ref:`int` id, :ref:`Vector2` coord, :ref:`int` z_index **)** Sets the drawing index of the subtile from an atlas/autotile given its coordinates. -.. _class_TileSet_clear: +.. _class_TileSet_method_clear: - void **clear** **(** **)** Clears all tiles. -.. _class_TileSet_create_tile: +.. _class_TileSet_method_create_tile: - void **create_tile** **(** :ref:`int` id **)** Creates a new tile with the given ID. -.. _class_TileSet_find_tile_by_name: +.. _class_TileSet_method_find_tile_by_name: - :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** const Returns the first tile matching the given name. -.. _class_TileSet_get_last_unused_tile_id: +.. _class_TileSet_method_get_last_unused_tile_id: - :ref:`int` **get_last_unused_tile_id** **(** **)** const Returns the ID following the last currently used ID, useful when creating a new tile. -.. _class_TileSet_get_tiles_ids: +.. _class_TileSet_method_get_tiles_ids: - :ref:`Array` **get_tiles_ids** **(** **)** const Returns an array of all currently used tile IDs. -.. _class_TileSet_remove_tile: +.. _class_TileSet_method_remove_tile: - void **remove_tile** **(** :ref:`int` id **)** Removes the given tile ID. -.. _class_TileSet_tile_add_shape: +.. _class_TileSet_method_tile_add_shape: - void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** Adds a shape to the tile. -.. _class_TileSet_tile_get_light_occluder: +.. _class_TileSet_method_tile_get_light_occluder: - :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const Returns the tile's light occluder. -.. _class_TileSet_tile_get_material: +.. _class_TileSet_method_tile_get_material: - :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const Returns the tile's material. -.. _class_TileSet_tile_get_modulate: +.. _class_TileSet_method_tile_get_modulate: - :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** const Returns the tile's modulation color. -.. _class_TileSet_tile_get_name: +.. _class_TileSet_method_tile_get_name: - :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const Returns the tile's name. -.. _class_TileSet_tile_get_navigation_polygon: +.. _class_TileSet_method_tile_get_navigation_polygon: - :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** const Returns the navigation polygon of the tile. -.. _class_TileSet_tile_get_navigation_polygon_offset: +.. _class_TileSet_method_tile_get_navigation_polygon_offset: - :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** const Returns the offset of the tile's navigation polygon. -.. _class_TileSet_tile_get_normal_map: +.. _class_TileSet_method_tile_get_normal_map: - :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const Returns the tile's normal map texture. -.. _class_TileSet_tile_get_occluder_offset: +.. _class_TileSet_method_tile_get_occluder_offset: - :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const Returns the offset of the tile's light occluder. -.. _class_TileSet_tile_get_region: +.. _class_TileSet_method_tile_get_region: - :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** const Returns the tile sub-region in the texture. -.. _class_TileSet_tile_get_shape: +.. _class_TileSet_method_tile_get_shape: - :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const Returns a tile's given shape. -.. _class_TileSet_tile_get_shape_count: +.. _class_TileSet_method_tile_get_shape_count: - :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** const Returns the number of shapes assigned to a tile. -.. _class_TileSet_tile_get_shape_offset: +.. _class_TileSet_method_tile_get_shape_offset: - :ref:`Vector2` **tile_get_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id **)** const Returns the offset of a tile's shape. -.. _class_TileSet_tile_get_shape_one_way: +.. _class_TileSet_method_tile_get_shape_one_way: - :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. -.. _class_TileSet_tile_get_shape_transform: +.. _class_TileSet_method_tile_get_shape_transform: - :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const Returns the :ref:`Transform2D` of a tile's shape. -.. _class_TileSet_tile_get_shapes: +.. _class_TileSet_method_tile_get_shapes: - :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const Returns an array of the tile's shapes. -.. _class_TileSet_tile_get_texture: +.. _class_TileSet_method_tile_get_texture: - :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const Returns the tile's texture. -.. _class_TileSet_tile_get_texture_offset: +.. _class_TileSet_method_tile_get_texture_offset: - :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** const Returns the texture offset of the tile. -.. _class_TileSet_tile_get_tile_mode: +.. _class_TileSet_method_tile_get_tile_mode: - :ref:`TileMode` **tile_get_tile_mode** **(** :ref:`int` id **)** const Returns the tile's :ref:`TileMode`. -.. _class_TileSet_tile_get_z_index: +.. _class_TileSet_method_tile_get_z_index: - :ref:`int` **tile_get_z_index** **(** :ref:`int` id **)** const Returns the tile's z-index (drawing layer). -.. _class_TileSet_tile_set_light_occluder: +.. _class_TileSet_method_tile_set_light_occluder: - void **tile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** Sets a light occluder for the tile. -.. _class_TileSet_tile_set_material: +.. _class_TileSet_method_tile_set_material: - void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** Sets the tile's material. -.. _class_TileSet_tile_set_modulate: +.. _class_TileSet_method_tile_set_modulate: - void **tile_set_modulate** **(** :ref:`int` id, :ref:`Color` color **)** Sets the tile's modulation color. -.. _class_TileSet_tile_set_name: +.. _class_TileSet_method_tile_set_name: - void **tile_set_name** **(** :ref:`int` id, :ref:`String` name **)** Sets the tile's name. -.. _class_TileSet_tile_set_navigation_polygon: +.. _class_TileSet_method_tile_set_navigation_polygon: - void **tile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** Sets the tile's navigation polygon. -.. _class_TileSet_tile_set_navigation_polygon_offset: +.. _class_TileSet_method_tile_set_navigation_polygon_offset: - void **tile_set_navigation_polygon_offset** **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** Sets an offset for the tile's navigation polygon. -.. _class_TileSet_tile_set_normal_map: +.. _class_TileSet_method_tile_set_normal_map: - void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** Sets the tile's normal map texture. -.. _class_TileSet_tile_set_occluder_offset: +.. _class_TileSet_method_tile_set_occluder_offset: - void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** Sets an offset for the tile's light occluder. -.. _class_TileSet_tile_set_region: +.. _class_TileSet_method_tile_set_region: - void **tile_set_region** **(** :ref:`int` id, :ref:`Rect2` region **)** Sets the tile's sub-region in the texture. This is common in texture atlases. -.. _class_TileSet_tile_set_shape: +.. _class_TileSet_method_tile_set_shape: - void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** Sets a shape for the tile, enabling collision. -.. _class_TileSet_tile_set_shape_offset: +.. _class_TileSet_method_tile_set_shape_offset: - void **tile_set_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Vector2` shape_offset **)** Sets the offset of a tile's shape. -.. _class_TileSet_tile_set_shape_one_way: +.. _class_TileSet_method_tile_set_shape_one_way: - void **tile_set_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** Enables one-way collision on a tile's shape. -.. _class_TileSet_tile_set_shape_transform: +.. _class_TileSet_method_tile_set_shape_transform: - void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** Sets a :ref:`Transform2D` on a tile's shape. -.. _class_TileSet_tile_set_shapes: +.. _class_TileSet_method_tile_set_shapes: - void **tile_set_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** Sets an array of shapes for the tile, enabling collision. -.. _class_TileSet_tile_set_texture: +.. _class_TileSet_method_tile_set_texture: - void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** Sets the tile's texture. -.. _class_TileSet_tile_set_texture_offset: +.. _class_TileSet_method_tile_set_texture_offset: - void **tile_set_texture_offset** **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** Sets the tile's texture offset. -.. _class_TileSet_tile_set_tile_mode: +.. _class_TileSet_method_tile_set_tile_mode: - void **tile_set_tile_mode** **(** :ref:`int` id, :ref:`TileMode` tilemode **)** Sets the tile's :ref:`TileMode`. -.. _class_TileSet_tile_set_z_index: +.. _class_TileSet_method_tile_set_z_index: - void **tile_set_z_index** **(** :ref:`int` id, :ref:`int` z_index **)** diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 64eb05018..8560a1a4a 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -19,35 +19,35 @@ A countdown timer. Properties ---------- -+------------------------------------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`autostart` | -+------------------------------------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`one_shot` | -+------------------------------------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`paused` | -+------------------------------------------------------+-----------------------------------------------+ -| :ref:`TimerProcessMode` | :ref:`process_mode` | -+------------------------------------------------------+-----------------------------------------------+ -| :ref:`float` | :ref:`time_left` | -+------------------------------------------------------+-----------------------------------------------+ -| :ref:`float` | :ref:`wait_time` | -+------------------------------------------------------+-----------------------------------------------+ ++------------------------------------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`autostart` | ++------------------------------------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`one_shot` | ++------------------------------------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`paused` | ++------------------------------------------------------+--------------------------------------------------------+ +| :ref:`TimerProcessMode` | :ref:`process_mode` | ++------------------------------------------------------+--------------------------------------------------------+ +| :ref:`float` | :ref:`time_left` | ++------------------------------------------------------+--------------------------------------------------------+ +| :ref:`float` | :ref:`wait_time` | ++------------------------------------------------------+--------------------------------------------------------+ Methods ------- -+--------------------------+-----------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stopped` **(** **)** const | -+--------------------------+-----------------------------------------------------------------------------------+ -| void | :ref:`start` **(** :ref:`float` time_sec=-1 **)** | -+--------------------------+-----------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+--------------------------+-----------------------------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stopped` **(** **)** const | ++-------------------------+------------------------------------------------------------------------------------------+ +| void | :ref:`start` **(** :ref:`float` time_sec=-1 **)** | ++-------------------------+------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------+------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Timer_timeout: +.. _class_Timer_signal_timeout: - **timeout** **(** **)** @@ -58,6 +58,10 @@ Enumerations .. _enum_Timer_TimerProcessMode: +.. _class_Timer_constant_TIMER_PROCESS_PHYSICS: + +.. _class_Timer_constant_TIMER_PROCESS_IDLE: + enum **TimerProcessMode**: - **TIMER_PROCESS_PHYSICS** = **0** --- Update the timer during the physics step at each frame (fixed framerate processing). @@ -72,7 +76,7 @@ Counts down a specified interval and emits a signal on reaching 0. Can be set to Property Descriptions --------------------- -.. _class_Timer_autostart: +.. _class_Timer_property_autostart: - :ref:`bool` **autostart** @@ -84,7 +88,7 @@ Property Descriptions If ``true``, the timer will automatically start when entering the scene tree. Default value: ``false``. -.. _class_Timer_one_shot: +.. _class_Timer_property_one_shot: - :ref:`bool` **one_shot** @@ -96,7 +100,7 @@ If ``true``, the timer will automatically start when entering the scene tree. De If ``true``, the timer will stop when reaching 0. If ``false``, it will restart. Default value: ``false``. -.. _class_Timer_paused: +.. _class_Timer_property_paused: - :ref:`bool` **paused** @@ -106,9 +110,9 @@ If ``true``, the timer will stop when reaching 0. If ``false``, it will restart. | *Getter* | is_paused() | +----------+-------------------+ -If ``true``, the timer is paused and will not process until it is unpaused again, even if :ref:`start` is called. +If ``true``, the timer is paused and will not process until it is unpaused again, even if :ref:`start` is called. -.. _class_Timer_process_mode: +.. _class_Timer_property_process_mode: - :ref:`TimerProcessMode` **process_mode** @@ -118,9 +122,9 @@ If ``true``, the timer is paused and will not process until it is unpaused again | *Getter* | get_timer_process_mode() | +----------+-------------------------------+ -Processing mode. See :ref:`TimerProcessMode`. +Processing mode. See :ref:`TimerProcessMode`. -.. _class_Timer_time_left: +.. _class_Timer_property_time_left: - :ref:`float` **time_left** @@ -130,9 +134,9 @@ Processing mode. See :ref:`TimerProcessMode` The timer's remaining time in seconds. Returns 0 if the timer is inactive. -Note: You cannot set this value. To change the timer's remaining time, use :ref:`wait_time`. +Note: You cannot set this value. To change the timer's remaining time, use :ref:`wait_time`. -.. _class_Timer_wait_time: +.. _class_Timer_property_wait_time: - :ref:`float` **wait_time** @@ -147,21 +151,21 @@ Wait time in seconds. Method Descriptions ------------------- -.. _class_Timer_is_stopped: +.. _class_Timer_method_is_stopped: - :ref:`bool` **is_stopped** **(** **)** const Returns ``true`` if the timer is stopped. -.. _class_Timer_start: +.. _class_Timer_method_start: - void **start** **(** :ref:`float` time_sec=-1 **)** Starts the timer. Sets ``wait_time`` to ``time_sec`` if ``time_sec > 0``. This also resets the remaining time to ``wait_time``. -Note: this method will not resume a paused timer. See :ref:`paused`. +Note: this method will not resume a paused timer. See :ref:`paused`. -.. _class_Timer_stop: +.. _class_Timer_method_stop: - void **stop** **(** **)** diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index 308f89d06..e9fa75088 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -19,34 +19,34 @@ Flat button helper class. Theme Properties ---------------- -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`disabled` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_disabled` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_hover` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_pressed` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`hover` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`pressed` | -+---------------------------------+------------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`StyleBox` | disabled | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+---------------------+ +| :ref:`Font` | font | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_disabled | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_hover | ++---------------------------------+---------------------+ +| :ref:`Color` | font_color_pressed | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | hover | ++---------------------------------+---------------------+ +| :ref:`int` | hseparation | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | normal | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | pressed | ++---------------------------------+---------------------+ Description ----------- -This is a helper class to generate a flat :ref:`Button` (see :ref:`Button.set_flat`), creating a ToolButton is equivalent to: +This is a helper class to generate a flat :ref:`Button` (see :ref:`Button.set_flat`), creating a ToolButton is equivalent to: :: diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index fbc434d1d..d240688af 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -19,43 +19,43 @@ Button for touch screen devices. Properties ---------- -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`String` | :ref:`action` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`BitMap` | :ref:`bitmask` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`passby_press` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Texture` | :ref:`pressed` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`shape` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`shape_centered` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`shape_visible` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`VisibilityMode` | :ref:`visibility_mode` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`String` | :ref:`action` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`BitMap` | :ref:`bitmask` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`normal` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`passby_press` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`pressed` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`shape` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shape_centered` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shape_visible` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`VisibilityMode` | :ref:`visibility_mode` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ Methods ------- -+--------------------------+-------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++-------------------------+--------------------------------------------------------------------------------+ Signals ------- -.. _class_TouchScreenButton_pressed: +.. _class_TouchScreenButton_signal_pressed: - **pressed** **(** **)** Emitted when the button is pressed (down). -.. _class_TouchScreenButton_released: +.. _class_TouchScreenButton_signal_released: - **released** **(** **)** @@ -66,6 +66,10 @@ Enumerations .. _enum_TouchScreenButton_VisibilityMode: +.. _class_TouchScreenButton_constant_VISIBILITY_ALWAYS: + +.. _class_TouchScreenButton_constant_VISIBILITY_TOUCHSCREEN_ONLY: + enum **VisibilityMode**: - **VISIBILITY_ALWAYS** = **0** --- Always visible. @@ -80,7 +84,7 @@ Button for touch screen devices. You can set it to be visible on all screens, or Property Descriptions --------------------- -.. _class_TouchScreenButton_action: +.. _class_TouchScreenButton_property_action: - :ref:`String` **action** @@ -92,7 +96,7 @@ Property Descriptions The button's action. Actions can be handled with :ref:`InputEventAction`. -.. _class_TouchScreenButton_bitmask: +.. _class_TouchScreenButton_property_bitmask: - :ref:`BitMap` **bitmask** @@ -104,7 +108,7 @@ The button's action. Actions can be handled with :ref:`InputEventAction` **normal** @@ -116,7 +120,7 @@ The button's bitmask. The button's texture for the normal state. -.. _class_TouchScreenButton_passby_press: +.. _class_TouchScreenButton_property_passby_press: - :ref:`bool` **passby_press** @@ -128,7 +132,7 @@ The button's texture for the normal state. If ``true``, passby presses are enabled. -.. _class_TouchScreenButton_pressed: +.. _class_TouchScreenButton_property_pressed: - :ref:`Texture` **pressed** @@ -140,7 +144,7 @@ If ``true``, passby presses are enabled. The button's texture for the pressed state. -.. _class_TouchScreenButton_shape: +.. _class_TouchScreenButton_property_shape: - :ref:`Shape2D` **shape** @@ -152,7 +156,7 @@ The button's texture for the pressed state. The button's shape. -.. _class_TouchScreenButton_shape_centered: +.. _class_TouchScreenButton_property_shape_centered: - :ref:`bool` **shape_centered** @@ -164,7 +168,7 @@ The button's shape. If ``true``, the button's shape is centered. -.. _class_TouchScreenButton_shape_visible: +.. _class_TouchScreenButton_property_shape_visible: - :ref:`bool` **shape_visible** @@ -176,7 +180,7 @@ If ``true``, the button's shape is centered. If ``true``, the button's shape is visible. -.. _class_TouchScreenButton_visibility_mode: +.. _class_TouchScreenButton_property_visibility_mode: - :ref:`VisibilityMode` **visibility_mode** @@ -191,7 +195,7 @@ The button's visibility mode. See ``VISIBILITY_*`` constants. Method Descriptions ------------------- -.. _class_TouchScreenButton_is_pressed: +.. _class_TouchScreenButton_method_is_pressed: - :ref:`bool` **is_pressed** **(** **)** const diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 470629fbf..005f6aac8 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -17,50 +17,58 @@ Brief Description Properties ---------- -+-------------------------------+---------------------------------------+ -| :ref:`Basis` | :ref:`basis` | -+-------------------------------+---------------------------------------+ -| :ref:`Vector3` | :ref:`origin` | -+-------------------------------+---------------------------------------+ ++-------------------------------+------------------------------------------------+ +| :ref:`Basis` | :ref:`basis` | ++-------------------------------+------------------------------------------------+ +| :ref:`Vector3` | :ref:`origin` | ++-------------------------------+------------------------------------------------+ Methods ------- -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Transform2D` from **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Quat` from **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` from **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`affine_inverse` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`interpolate_with` **(** :ref:`Transform` transform, :ref:`float` weight **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`inverse` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`orthonormalized` **(** **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`translated` **(** :ref:`Vector3` ofs **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`xform` **(** :ref:`Variant` v **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`xform_inv` **(** :ref:`Variant` v **)** | -+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Transform2D` from **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Quat` from **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` from **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`affine_inverse` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`interpolate_with` **(** :ref:`Transform` transform, :ref:`float` weight **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`inverse` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`orthonormalized` **(** **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`translated` **(** :ref:`Vector3` ofs **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`xform` **(** :ref:`Variant` v **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`xform_inv` **(** :ref:`Variant` v **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_Transform_constant_IDENTITY: + +.. _class_Transform_constant_FLIP_X: + +.. _class_Transform_constant_FLIP_Y: + +.. _class_Transform_constant_FLIP_Z: + - **IDENTITY** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** - **FLIP_X** = **Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** @@ -84,13 +92,13 @@ Tutorials Property Descriptions --------------------- -.. _class_Transform_basis: +.. _class_Transform_property_basis: - :ref:`Basis` **basis** The basis is a matrix containing 3 :ref:`Vector3` as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. -.. _class_Transform_origin: +.. _class_Transform_property_origin: - :ref:`Vector3` **origin** @@ -99,55 +107,47 @@ The translation offset of the transform. Method Descriptions ------------------- -.. _class_Transform_Transform: +.. _class_Transform_method_Transform: - :ref:`Transform` **Transform** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** Constructs the Transform from four :ref:`Vector3`. Each axis corresponds to local basis vectors (some of which may be scaled). -.. _class_Transform_Transform: - - :ref:`Transform` **Transform** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** Constructs the Transform from a :ref:`Basis` and :ref:`Vector3`. -.. _class_Transform_Transform: - - :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** Constructs the Transform from a :ref:`Transform2D`. -.. _class_Transform_Transform: - - :ref:`Transform` **Transform** **(** :ref:`Quat` from **)** Constructs the Transform from a :ref:`Quat`. The origin will be Vector3(0, 0, 0). -.. _class_Transform_Transform: - - :ref:`Transform` **Transform** **(** :ref:`Basis` from **)** Constructs the Transform from a :ref:`Basis`. The origin will be Vector3(0, 0, 0). -.. _class_Transform_affine_inverse: +.. _class_Transform_method_affine_inverse: - :ref:`Transform` **affine_inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. -.. _class_Transform_interpolate_with: +.. _class_Transform_method_interpolate_with: - :ref:`Transform` **interpolate_with** **(** :ref:`Transform` transform, :ref:`float` weight **)** Interpolates the transform to other Transform by weight amount (0-1). -.. _class_Transform_inverse: +.. _class_Transform_method_inverse: - :ref:`Transform` **inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). -.. _class_Transform_looking_at: +.. _class_Transform_method_looking_at: - :ref:`Transform` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** @@ -157,37 +157,37 @@ The transform will first be rotated around the given ``up`` vector, and then ful Operations take place in global space. -.. _class_Transform_orthonormalized: +.. _class_Transform_method_orthonormalized: - :ref:`Transform` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. -.. _class_Transform_rotated: +.. _class_Transform_method_rotated: - :ref:`Transform` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Rotates the transform around given axis by phi. The axis must be a normalized vector. -.. _class_Transform_scaled: +.. _class_Transform_method_scaled: - :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** Scales the transform by the specified 3D scaling factors. -.. _class_Transform_translated: +.. _class_Transform_method_translated: - :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** Translates the transform by the specified offset. -.. _class_Transform_xform: +.. _class_Transform_method_xform: - :ref:`Variant` **xform** **(** :ref:`Variant` v **)** Transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. -.. _class_Transform_xform_inv: +.. _class_Transform_method_xform_inv: - :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index d68e4aeeb..46d92545b 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -17,56 +17,62 @@ Brief Description Properties ---------- -+-------------------------------+-----------------------------------------+ -| :ref:`Vector2` | :ref:`origin` | -+-------------------------------+-----------------------------------------+ -| :ref:`Vector2` | :ref:`x` | -+-------------------------------+-----------------------------------------+ -| :ref:`Vector2` | :ref:`y` | -+-------------------------------+-----------------------------------------+ ++-------------------------------+--------------------------------------------------+ +| :ref:`Vector2` | :ref:`origin` | ++-------------------------------+--------------------------------------------------+ +| :ref:`Vector2` | :ref:`x` | ++-------------------------------+--------------------------------------------------+ +| :ref:`Vector2` | :ref:`y` | ++-------------------------------+--------------------------------------------------+ Methods ------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform` from **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`basis_xform` **(** :ref:`Vector2` v **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`basis_xform_inv` **(** :ref:`Vector2` v **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_origin` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` transform, :ref:`float` weight **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`inverse` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` phi **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`xform` **(** :ref:`Variant` v **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`xform_inv` **(** :ref:`Variant` v **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform` from **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`basis_xform` **(** :ref:`Vector2` v **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`basis_xform_inv` **(** :ref:`Vector2` v **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_origin` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` transform, :ref:`float` weight **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`inverse` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` phi **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`xform` **(** :ref:`Variant` v **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`xform_inv` **(** :ref:`Variant` v **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_Transform2D_constant_IDENTITY: + +.. _class_Transform2D_constant_FLIP_X: + +.. _class_Transform2D_constant_FLIP_Y: + - **IDENTITY** = **Transform2D( 1, 0, 0, 1, 0, 0 )** - **FLIP_X** = **Transform2D( -1, 0, 0, 1, 0, 0 )** @@ -81,19 +87,19 @@ Represents one or many transformations in 2D space such as translation, rotation Property Descriptions --------------------- -.. _class_Transform2D_origin: +.. _class_Transform2D_property_origin: - :ref:`Vector2` **origin** The transform's translation offset. -.. _class_Transform2D_x: +.. _class_Transform2D_property_x: - :ref:`Vector2` **x** The X axis of 2x2 basis matrix containing 2 :ref:`Vector2`\ s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. -.. _class_Transform2D_y: +.. _class_Transform2D_property_y: - :ref:`Vector2` **y** @@ -102,103 +108,99 @@ The Y axis of 2x2 basis matrix containing 2 :ref:`Vector2`\ s as Method Descriptions ------------------- -.. _class_Transform2D_Transform2D: +.. _class_Transform2D_method_Transform2D: - :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** Constructs the transform from a 3D :ref:`Transform`. -.. _class_Transform2D_Transform2D: - - :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** Constructs the transform from 3 :ref:`Vector2`\ s representing x, y, and origin. -.. _class_Transform2D_Transform2D: - - :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** Constructs the transform from a given angle (in radians) and position. -.. _class_Transform2D_affine_inverse: +.. _class_Transform2D_method_affine_inverse: - :ref:`Transform2D` **affine_inverse** **(** **)** Returns the inverse of the matrix. -.. _class_Transform2D_basis_xform: +.. _class_Transform2D_method_basis_xform: - :ref:`Vector2` **basis_xform** **(** :ref:`Vector2` v **)** Transforms the given vector by this transform's basis (no translation). -.. _class_Transform2D_basis_xform_inv: +.. _class_Transform2D_method_basis_xform_inv: - :ref:`Vector2` **basis_xform_inv** **(** :ref:`Vector2` v **)** Inverse-transforms the given vector by this transform's basis (no translation). -.. _class_Transform2D_get_origin: +.. _class_Transform2D_method_get_origin: - :ref:`Vector2` **get_origin** **(** **)** Returns the transform's origin (translation). -.. _class_Transform2D_get_rotation: +.. _class_Transform2D_method_get_rotation: - :ref:`float` **get_rotation** **(** **)** Returns the transform's rotation (in radians). -.. _class_Transform2D_get_scale: +.. _class_Transform2D_method_get_scale: - :ref:`Vector2` **get_scale** **(** **)** Returns the scale. -.. _class_Transform2D_interpolate_with: +.. _class_Transform2D_method_interpolate_with: - :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` transform, :ref:`float` weight **)** Returns a transform interpolated between this transform and another by a given weight (0-1). -.. _class_Transform2D_inverse: +.. _class_Transform2D_method_inverse: - :ref:`Transform2D` **inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). -.. _class_Transform2D_orthonormalized: +.. _class_Transform2D_method_orthonormalized: - :ref:`Transform2D` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. -.. _class_Transform2D_rotated: +.. _class_Transform2D_method_rotated: - :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** Rotates the transform by the given angle (in radians). -.. _class_Transform2D_scaled: +.. _class_Transform2D_method_scaled: - :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** Scales the transform by the given factor. -.. _class_Transform2D_translated: +.. _class_Transform2D_method_translated: - :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** Translates the transform by the given offset. -.. _class_Transform2D_xform: +.. _class_Transform2D_method_xform: - :ref:`Variant` **xform** **(** :ref:`Variant` v **)** Transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. -.. _class_Transform2D_xform_inv: +.. _class_Transform2D_method_xform_inv: - :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** diff --git a/classes/class_translation.rst b/classes/class_translation.rst index e094c8064..c09b34807 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -21,24 +21,24 @@ Language Translation. Properties ---------- -+-----------------------------+-----------------------------------------+ -| :ref:`String` | :ref:`locale` | -+-----------------------------+-----------------------------------------+ ++-----------------------------+--------------------------------------------------+ +| :ref:`String` | :ref:`locale` | ++-----------------------------+--------------------------------------------------+ Methods ------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_message` **(** :ref:`String` src_message, :ref:`String` xlated_message **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_message` **(** :ref:`String` src_message **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_message_count` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_message` **(** :ref:`String` src_message, :ref:`String` xlated_message **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_message` **(** :ref:`String` src_message **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_message_count` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -55,7 +55,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Translation_locale: +.. _class_Translation_property_locale: - :ref:`String` **locale** @@ -70,31 +70,31 @@ The locale of the translation. Method Descriptions ------------------- -.. _class_Translation_add_message: +.. _class_Translation_method_add_message: - void **add_message** **(** :ref:`String` src_message, :ref:`String` xlated_message **)** Adds a message if nonexistent, followed by its translation. -.. _class_Translation_erase_message: +.. _class_Translation_method_erase_message: - void **erase_message** **(** :ref:`String` src_message **)** Erases a message. -.. _class_Translation_get_message: +.. _class_Translation_method_get_message: - :ref:`String` **get_message** **(** :ref:`String` src_message **)** const Returns a message's translation. -.. _class_Translation_get_message_count: +.. _class_Translation_method_get_message_count: - :ref:`int` **get_message_count** **(** **)** const Returns the number of existing messages. -.. _class_Translation_get_message_list: +.. _class_Translation_method_get_message_list: - :ref:`PoolStringArray` **get_message_list** **(** **)** const diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index d501aa43d..22f390d86 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -19,21 +19,21 @@ Server that manages all translations. Methods ------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_translation` **(** :ref:`Translation` translation **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_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 | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_translation` **(** :ref:`Translation` translation **)** | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_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 | ++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -50,43 +50,43 @@ Tutorials Method Descriptions ------------------- -.. _class_TranslationServer_add_translation: +.. _class_TranslationServer_method_add_translation: - void **add_translation** **(** :ref:`Translation` translation **)** Adds a :ref:`Translation` resource. -.. _class_TranslationServer_clear: +.. _class_TranslationServer_method_clear: - void **clear** **(** **)** Clears the server from all translations. -.. _class_TranslationServer_get_locale: +.. _class_TranslationServer_method_get_locale: - :ref:`String` **get_locale** **(** **)** const Returns the current locale of the game. -.. _class_TranslationServer_get_locale_name: +.. _class_TranslationServer_method_get_locale_name: - :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)"). -.. _class_TranslationServer_remove_translation: +.. _class_TranslationServer_method_remove_translation: - void **remove_translation** **(** :ref:`Translation` translation **)** Removes the given translation from the server. -.. _class_TranslationServer_set_locale: +.. _class_TranslationServer_method_set_locale: - void **set_locale** **(** :ref:`String` locale **)** Sets the locale of the game. -.. _class_TranslationServer_translate: +.. _class_TranslationServer_method_translate: - :ref:`String` **translate** **(** :ref:`String` message **)** const diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 9a762a1ae..bfbd54fad 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -19,242 +19,242 @@ Control to show a tree of items. Properties ---------- -+-----------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_reselect` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`allow_rmb_select` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`columns` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`int` | :ref:`drop_mode_flags` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_folding` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_root` | -+-----------------------------------------+------------------------------------------------------+ -| :ref:`SelectMode` | :ref:`select_mode` | -+-----------------------------------------+------------------------------------------------------+ ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_reselect` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_rmb_select` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`columns` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`drop_mode_flags` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`hide_folding` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`hide_root` | ++-----------------------------------------+---------------------------------------------------------------+ +| :ref:`SelectMode` | :ref:`select_mode` | ++-----------------------------------------+---------------------------------------------------------------+ 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 ---------------- -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`arrow` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`arrow_collapsed` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`bg_focus` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`button_margin` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`button_pressed` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`checked` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`cursor` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`cursor_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`cursor_unfocused` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`custom_button` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`custom_button_font_highlight` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`custom_button_hover` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`custom_button_pressed` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`draw_guides` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`draw_relationship_lines` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`drop_position_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`font` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`font_color_selected` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`guide_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`guide_width` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hseparation` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`item_margin` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`relationship_line_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scroll_border` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`scroll_speed` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`select_arrow` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`selected` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`selected_focus` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`selection_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`title_button_color` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`title_button_font` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`title_button_hover` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`title_button_normal` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`title_button_pressed` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`unchecked` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`updown` | -+---------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`vseparation` | -+---------------------------------+------------------------------------------------------------------------------+ ++---------------------------------+------------------------------+ +| :ref:`Texture` | arrow | ++---------------------------------+------------------------------+ +| :ref:`Texture` | arrow_collapsed | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | bg | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | bg_focus | ++---------------------------------+------------------------------+ +| :ref:`int` | button_margin | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | button_pressed | ++---------------------------------+------------------------------+ +| :ref:`Texture` | checked | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | cursor | ++---------------------------------+------------------------------+ +| :ref:`Color` | cursor_color | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | cursor_unfocused | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | custom_button | ++---------------------------------+------------------------------+ +| :ref:`Color` | custom_button_font_highlight | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | custom_button_hover | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | custom_button_pressed | ++---------------------------------+------------------------------+ +| :ref:`int` | draw_guides | ++---------------------------------+------------------------------+ +| :ref:`int` | draw_relationship_lines | ++---------------------------------+------------------------------+ +| :ref:`Color` | drop_position_color | ++---------------------------------+------------------------------+ +| :ref:`Font` | font | ++---------------------------------+------------------------------+ +| :ref:`Color` | font_color | ++---------------------------------+------------------------------+ +| :ref:`Color` | font_color_selected | ++---------------------------------+------------------------------+ +| :ref:`Color` | guide_color | ++---------------------------------+------------------------------+ +| :ref:`int` | guide_width | ++---------------------------------+------------------------------+ +| :ref:`int` | hseparation | ++---------------------------------+------------------------------+ +| :ref:`int` | item_margin | ++---------------------------------+------------------------------+ +| :ref:`Color` | relationship_line_color | ++---------------------------------+------------------------------+ +| :ref:`int` | scroll_border | ++---------------------------------+------------------------------+ +| :ref:`int` | scroll_speed | ++---------------------------------+------------------------------+ +| :ref:`Texture` | select_arrow | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | selected | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | selected_focus | ++---------------------------------+------------------------------+ +| :ref:`Color` | selection_color | ++---------------------------------+------------------------------+ +| :ref:`Color` | title_button_color | ++---------------------------------+------------------------------+ +| :ref:`Font` | title_button_font | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | title_button_hover | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | title_button_normal | ++---------------------------------+------------------------------+ +| :ref:`StyleBox` | title_button_pressed | ++---------------------------------+------------------------------+ +| :ref:`Texture` | unchecked | ++---------------------------------+------------------------------+ +| :ref:`Texture` | updown | ++---------------------------------+------------------------------+ +| :ref:`int` | vseparation | ++---------------------------------+------------------------------+ Signals ------- -.. _class_Tree_button_pressed: +.. _class_Tree_signal_button_pressed: - **button_pressed** **(** :ref:`TreeItem` item, :ref:`int` column, :ref:`int` id **)** -Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). +Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). -.. _class_Tree_cell_selected: +.. _class_Tree_signal_cell_selected: - **cell_selected** **(** **)** Emitted when a cell is selected. -.. _class_Tree_column_title_pressed: +.. _class_Tree_signal_column_title_pressed: - **column_title_pressed** **(** :ref:`int` column **)** Emitted when a column's title is pressed. -.. _class_Tree_custom_popup_edited: +.. _class_Tree_signal_custom_popup_edited: - **custom_popup_edited** **(** :ref:`bool` arrow_clicked **)** Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited. -.. _class_Tree_empty_tree_rmb_selected: +.. _class_Tree_signal_empty_tree_rmb_selected: - **empty_tree_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty. -.. _class_Tree_item_activated: +.. _class_Tree_signal_item_activated: - **item_activated** **(** **)** Emitted when an item's label is double-clicked. -.. _class_Tree_item_collapsed: +.. _class_Tree_signal_item_collapsed: - **item_collapsed** **(** :ref:`TreeItem` item **)** Emitted when an item is collapsed by a click on the folding arrow. -.. _class_Tree_item_custom_button_pressed: +.. _class_Tree_signal_item_custom_button_pressed: - **item_custom_button_pressed** **(** **)** -.. _class_Tree_item_double_clicked: +.. _class_Tree_signal_item_double_clicked: - **item_double_clicked** **(** **)** Emitted when an item's icon is double-clicked. -.. _class_Tree_item_edited: +.. _class_Tree_signal_item_edited: - **item_edited** **(** **)** Emitted when an item is edited. -.. _class_Tree_item_rmb_edited: +.. _class_Tree_signal_item_rmb_edited: - **item_rmb_edited** **(** **)** Emitted when an item is edited using the right mouse button. -.. _class_Tree_item_rmb_selected: +.. _class_Tree_signal_item_rmb_selected: - **item_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when an item is selected with the right mouse button. -.. _class_Tree_item_selected: +.. _class_Tree_signal_item_selected: - **item_selected** **(** **)** Emitted when an item is selected. -.. _class_Tree_multi_selected: +.. _class_Tree_signal_multi_selected: - **multi_selected** **(** :ref:`TreeItem` item, :ref:`int` column, :ref:`bool` selected **)** Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``. -.. _class_Tree_nothing_selected: +.. _class_Tree_signal_nothing_selected: - **nothing_selected** **(** **)** @@ -263,6 +263,12 @@ Enumerations .. _enum_Tree_SelectMode: +.. _class_Tree_constant_SELECT_SINGLE: + +.. _class_Tree_constant_SELECT_ROW: + +.. _class_Tree_constant_SELECT_MULTI: + enum **SelectMode**: - **SELECT_SINGLE** = **0** --- Allow selection of a single item at a time. @@ -273,6 +279,12 @@ enum **SelectMode**: .. _enum_Tree_DropModeFlags: +.. _class_Tree_constant_DROP_MODE_DISABLED: + +.. _class_Tree_constant_DROP_MODE_ON_ITEM: + +.. _class_Tree_constant_DROP_MODE_INBETWEEN: + enum **DropModeFlags**: - **DROP_MODE_DISABLED** = **0** @@ -302,7 +314,7 @@ Trees are built via code, using :ref:`TreeItem` objects to creat Property Descriptions --------------------- -.. _class_Tree_allow_reselect: +.. _class_Tree_property_allow_reselect: - :ref:`bool` **allow_reselect** @@ -314,7 +326,7 @@ Property Descriptions If ``true``, the currently selected cell may be selected again. -.. _class_Tree_allow_rmb_select: +.. _class_Tree_property_allow_rmb_select: - :ref:`bool` **allow_rmb_select** @@ -326,7 +338,7 @@ If ``true``, the currently selected cell may be selected again. If ``true``, a right mouse button click can select items. -.. _class_Tree_columns: +.. _class_Tree_property_columns: - :ref:`int` **columns** @@ -338,7 +350,7 @@ If ``true``, a right mouse button click can select items. The amount of columns. -.. _class_Tree_drop_mode_flags: +.. _class_Tree_property_drop_mode_flags: - :ref:`int` **drop_mode_flags** @@ -348,9 +360,9 @@ The amount of columns. | *Getter* | get_drop_mode_flags() | +----------+----------------------------+ -The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once dropping is done, reverts to ``DROP_MODE_DISABLED``. Setting this during :ref:`Control.can_drop_data` is recommended. +The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once dropping is done, reverts to ``DROP_MODE_DISABLED``. Setting this during :ref:`Control.can_drop_data` is recommended. -.. _class_Tree_hide_folding: +.. _class_Tree_property_hide_folding: - :ref:`bool` **hide_folding** @@ -362,7 +374,7 @@ The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once If ``true``, the folding arrow is hidden. -.. _class_Tree_hide_root: +.. _class_Tree_property_hide_root: - :ref:`bool` **hide_root** @@ -374,7 +386,7 @@ If ``true``, the folding arrow is hidden. If ``true``, the tree's root is hidden. -.. _class_Tree_select_mode: +.. _class_Tree_property_select_mode: - :ref:`SelectMode` **select_mode** @@ -389,141 +401,141 @@ Allow single or multiple selection. See the ``SELECT_*`` constants. Method Descriptions ------------------- -.. _class_Tree_are_column_titles_visible: +.. _class_Tree_method_are_column_titles_visible: - :ref:`bool` **are_column_titles_visible** **(** **)** const Returns ``true`` if the column titles are being shown. -.. _class_Tree_clear: +.. _class_Tree_method_clear: - void **clear** **(** **)** Clears the tree. This removes all items. -.. _class_Tree_create_item: +.. _class_Tree_method_create_item: - :ref:`TreeItem` **create_item** **(** :ref:`Object` parent=null, :ref:`int` idx=-1 **)** Create an item in the tree and add it as the last child of ``parent``. If parent is not given, it will be added as the root's last child, or it'll the be the root itself if the tree is empty. -.. _class_Tree_ensure_cursor_is_visible: +.. _class_Tree_method_ensure_cursor_is_visible: - void **ensure_cursor_is_visible** **(** **)** Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible. -.. _class_Tree_get_column_at_position: +.. _class_Tree_method_get_column_at_position: - :ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** const Returns the column index under the given point. -.. _class_Tree_get_column_title: +.. _class_Tree_method_get_column_title: - :ref:`String` **get_column_title** **(** :ref:`int` column **)** const Returns the column's title. -.. _class_Tree_get_column_width: +.. _class_Tree_method_get_column_width: - :ref:`int` **get_column_width** **(** :ref:`int` column **)** const Returns the column's width in pixels. -.. _class_Tree_get_custom_popup_rect: +.. _class_Tree_method_get_custom_popup_rect: - :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`. +Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See :ref:`TreeItem.set_cell_mode`. -.. _class_Tree_get_drop_section_at_position: +.. _class_Tree_method_get_drop_section_at_position: - :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const -If :ref:`drop_mode_flags` includes ``DROP_MODE_INBETWEEN``, returns -1 if ``position`` is the upper part of a tree item at that position, 1 for the lower part, and additionally 0 for the middle part if :ref:`drop_mode_flags` includes ``DROP_MODE_ON_ITEM``. +If :ref:`drop_mode_flags` includes ``DROP_MODE_INBETWEEN``, returns -1 if ``position`` is the upper part of a tree item at that position, 1 for the lower part, and additionally 0 for the middle part if :ref:`drop_mode_flags` includes ``DROP_MODE_ON_ITEM``. Otherwise, returns 0. If there are no tree item at ``position``, returns -100. -.. _class_Tree_get_edited: +.. _class_Tree_method_get_edited: - :ref:`TreeItem` **get_edited** **(** **)** const Returns the currently edited item. This is only available for custom cell mode. -.. _class_Tree_get_edited_column: +.. _class_Tree_method_get_edited_column: - :ref:`int` **get_edited_column** **(** **)** const Returns the column for the currently edited item. This is only available for custom cell mode. -.. _class_Tree_get_item_area_rect: +.. _class_Tree_method_get_item_area_rect: - :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. -.. _class_Tree_get_item_at_position: +.. _class_Tree_method_get_item_at_position: - :ref:`TreeItem` **get_item_at_position** **(** :ref:`Vector2` position **)** const Returns the tree item at the specified position (relative to the tree origin position). -.. _class_Tree_get_next_selected: +.. _class_Tree_method_get_next_selected: - :ref:`TreeItem` **get_next_selected** **(** :ref:`Object` from **)** Returns the next selected item after the given one. -.. _class_Tree_get_pressed_button: +.. _class_Tree_method_get_pressed_button: - :ref:`int` **get_pressed_button** **(** **)** const Returns the last pressed button's index. -.. _class_Tree_get_root: +.. _class_Tree_method_get_root: - :ref:`TreeItem` **get_root** **(** **)** Returns the tree's root item. -.. _class_Tree_get_scroll: +.. _class_Tree_method_get_scroll: - :ref:`Vector2` **get_scroll** **(** **)** const Returns the current scrolling position. -.. _class_Tree_get_selected: +.. _class_Tree_method_get_selected: - :ref:`TreeItem` **get_selected** **(** **)** const Returns the currently selected item. -.. _class_Tree_get_selected_column: +.. _class_Tree_method_get_selected_column: - :ref:`int` **get_selected_column** **(** **)** const Returns the current selection's column. -.. _class_Tree_set_column_expand: +.. _class_Tree_method_set_column_expand: - void **set_column_expand** **(** :ref:`int` column, :ref:`bool` expand **)** If ``true``, the column will have the "Expand" flag of :ref:`Control`. -.. _class_Tree_set_column_min_width: +.. _class_Tree_method_set_column_min_width: - void **set_column_min_width** **(** :ref:`int` column, :ref:`int` min_width **)** Set the minimum width of a column. -.. _class_Tree_set_column_title: +.. _class_Tree_method_set_column_title: - void **set_column_title** **(** :ref:`int` column, :ref:`String` title **)** Set the title of a column. -.. _class_Tree_set_column_titles_visible: +.. _class_Tree_method_set_column_titles_visible: - void **set_column_titles_visible** **(** :ref:`bool` visible **)** diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index f715977e6..33b45330d 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -19,132 +19,142 @@ Control for a single item inside a :ref:`Tree`. Properties ---------- -+-------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collapsed` | -+-------------------------+--------------------------------------------------------------------+ -| :ref:`int` | :ref:`custom_minimum_height` | -+-------------------------+--------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disable_folding` | -+-------------------------+--------------------------------------------------------------------+ ++-------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collapsed` | ++-------------------------+-----------------------------------------------------------------------------+ +| :ref:`int` | :ref:`custom_minimum_height` | ++-------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disable_folding` | ++-------------------------+-----------------------------------------------------------------------------+ Methods ------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** :ref:`int` column **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`int` | :ref:`get_button_count` **(** :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:`bool` | :ref:`get_expand_right` **(** :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:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TextAlign` | :ref:`get_text_align` **(** :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_checked` **(** :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_selected` **(** :ref:`int` column **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_bottom` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_top` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Object` child **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` column **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`TextAlign` text_align **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** :ref:`int` column **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`int` | :ref:`get_button_count` **(** :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:`bool` | :ref:`get_expand_right` **(** :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:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next` **(** **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TextAlign` | :ref:`get_text_align` **(** :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_checked` **(** :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_selected` **(** :ref:`int` column **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_bottom` **(** **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_top` **(** **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Object` child **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` column **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`TextAlign` text_align **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_TreeItem_TreeCellMode: +.. _class_TreeItem_constant_CELL_MODE_STRING: + +.. _class_TreeItem_constant_CELL_MODE_CHECK: + +.. _class_TreeItem_constant_CELL_MODE_RANGE: + +.. _class_TreeItem_constant_CELL_MODE_ICON: + +.. _class_TreeItem_constant_CELL_MODE_CUSTOM: + enum **TreeCellMode**: - **CELL_MODE_STRING** = **0** --- Cell contains a string. @@ -159,6 +169,12 @@ enum **TreeCellMode**: .. _enum_TreeItem_TextAlign: +.. _class_TreeItem_constant_ALIGN_LEFT: + +.. _class_TreeItem_constant_ALIGN_CENTER: + +.. _class_TreeItem_constant_ALIGN_RIGHT: + enum **TextAlign**: - **ALIGN_LEFT** = **0** --- Align text to the left. See ``set_text_align()``. @@ -175,7 +191,7 @@ Control for a single item inside a :ref:`Tree`. May have child ``Tre Property Descriptions --------------------- -.. _class_TreeItem_collapsed: +.. _class_TreeItem_property_collapsed: - :ref:`bool` **collapsed** @@ -187,7 +203,7 @@ Property Descriptions If ``true``, the TreeItem is collapsed. -.. _class_TreeItem_custom_minimum_height: +.. _class_TreeItem_property_custom_minimum_height: - :ref:`int` **custom_minimum_height** @@ -199,7 +215,7 @@ If ``true``, the TreeItem is collapsed. The custom minimum height. -.. _class_TreeItem_disable_folding: +.. _class_TreeItem_property_disable_folding: - :ref:`bool` **disable_folding** @@ -214,243 +230,243 @@ If ``true``, folding is disabled for this TreeItem. Method Descriptions ------------------- -.. _class_TreeItem_add_button: +.. _class_TreeItem_method_add_button: - void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** -Adds a button with :ref:`Texture` ``button`` at column ``column``. The ``button_idx`` index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip``. +Adds a button with :ref:`Texture` ``button`` at column ``column``. The ``button_idx`` index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip``. -.. _class_TreeItem_clear_custom_bg_color: +.. _class_TreeItem_method_clear_custom_bg_color: - void **clear_custom_bg_color** **(** :ref:`int` column **)** Resets the background color for the given column to default. -.. _class_TreeItem_clear_custom_color: +.. _class_TreeItem_method_clear_custom_color: - void **clear_custom_color** **(** :ref:`int` column **)** Resets the color for the given column to default. -.. _class_TreeItem_deselect: +.. _class_TreeItem_method_deselect: - void **deselect** **(** :ref:`int` column **)** Deselects the given column. -.. _class_TreeItem_erase_button: +.. _class_TreeItem_method_erase_button: - void **erase_button** **(** :ref:`int` column, :ref:`int` button_idx **)** Removes the button at index ``button_idx`` in column ``column``. -.. _class_TreeItem_get_button: +.. _class_TreeItem_method_get_button: - :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``. -.. _class_TreeItem_get_button_count: +.. _class_TreeItem_method_get_button_count: - :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. -.. _class_TreeItem_get_cell_mode: +.. _class_TreeItem_method_get_cell_mode: - :ref:`TreeCellMode` **get_cell_mode** **(** :ref:`int` column **)** const Returns the column's cell mode. See ``CELL_MODE_*`` constants. -.. _class_TreeItem_get_children: +.. _class_TreeItem_method_get_children: - :ref:`TreeItem` **get_children** **(** **)** Returns the TreeItem's child items. -.. _class_TreeItem_get_custom_bg_color: +.. _class_TreeItem_method_get_custom_bg_color: - :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const Returns the custom background color of column ``column``. -.. _class_TreeItem_get_expand_right: +.. _class_TreeItem_method_get_expand_right: - :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** const Returns ``true`` if ``expand_right`` is set. -.. _class_TreeItem_get_icon: +.. _class_TreeItem_method_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const Returns the given column's icon :ref:`Texture`. Error if no icon is set. -.. _class_TreeItem_get_icon_max_width: +.. _class_TreeItem_method_get_icon_max_width: - :ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** const Returns the column's icon's maximum width. -.. _class_TreeItem_get_icon_region: +.. _class_TreeItem_method_get_icon_region: - :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const Returns the icon :ref:`Texture` region as :ref:`Rect2`. -.. _class_TreeItem_get_metadata: +.. _class_TreeItem_method_get_metadata: - :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const -.. _class_TreeItem_get_next: +.. _class_TreeItem_method_get_next: - :ref:`TreeItem` **get_next** **(** **)** Returns the next TreeItem in the tree. -.. _class_TreeItem_get_next_visible: +.. _class_TreeItem_method_get_next_visible: - :ref:`TreeItem` **get_next_visible** **(** **)** Returns the next visible TreeItem in the tree. -.. _class_TreeItem_get_parent: +.. _class_TreeItem_method_get_parent: - :ref:`TreeItem` **get_parent** **(** **)** Returns the parent TreeItem. -.. _class_TreeItem_get_prev: +.. _class_TreeItem_method_get_prev: - :ref:`TreeItem` **get_prev** **(** **)** Returns the previous TreeItem in the tree. -.. _class_TreeItem_get_prev_visible: +.. _class_TreeItem_method_get_prev_visible: - :ref:`TreeItem` **get_prev_visible** **(** **)** Returns the previous visible TreeItem in the tree. -.. _class_TreeItem_get_range: +.. _class_TreeItem_method_get_range: - :ref:`float` **get_range** **(** :ref:`int` column **)** const -.. _class_TreeItem_get_range_config: +.. _class_TreeItem_method_get_range_config: - :ref:`Dictionary` **get_range_config** **(** :ref:`int` column **)** -.. _class_TreeItem_get_text: +.. _class_TreeItem_method_get_text: - :ref:`String` **get_text** **(** :ref:`int` column **)** const Returns the given column's text. -.. _class_TreeItem_get_text_align: +.. _class_TreeItem_method_get_text_align: - :ref:`TextAlign` **get_text_align** **(** :ref:`int` column **)** const Returns the given column's text alignment. -.. _class_TreeItem_get_tooltip: +.. _class_TreeItem_method_get_tooltip: - :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const Returns the given column's tooltip. -.. _class_TreeItem_is_button_disabled: +.. _class_TreeItem_method_is_button_disabled: - :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. -.. _class_TreeItem_is_checked: +.. _class_TreeItem_method_is_checked: - :ref:`bool` **is_checked** **(** :ref:`int` column **)** const Returns ``true`` if the given column is checked. -.. _class_TreeItem_is_custom_set_as_button: +.. _class_TreeItem_method_is_custom_set_as_button: - :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** const -.. _class_TreeItem_is_editable: +.. _class_TreeItem_method_is_editable: - :ref:`bool` **is_editable** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is editable. -.. _class_TreeItem_is_selectable: +.. _class_TreeItem_method_is_selectable: - :ref:`bool` **is_selectable** **(** :ref:`int` column **)** const Returns ``true`` if column ``column`` is selectable. -.. _class_TreeItem_is_selected: +.. _class_TreeItem_method_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is selected. -.. _class_TreeItem_move_to_bottom: +.. _class_TreeItem_method_move_to_bottom: - void **move_to_bottom** **(** **)** Moves this TreeItem to the bottom in the :ref:`Tree` hierarchy. -.. _class_TreeItem_move_to_top: +.. _class_TreeItem_method_move_to_top: - void **move_to_top** **(** **)** Moves this TreeItem to the top in the :ref:`Tree` hierarchy. -.. _class_TreeItem_remove_child: +.. _class_TreeItem_method_remove_child: - void **remove_child** **(** :ref:`Object` child **)** Removes the given child TreeItem. -.. _class_TreeItem_select: +.. _class_TreeItem_method_select: - void **select** **(** :ref:`int` column **)** Selects the column ``column``. -.. _class_TreeItem_set_button: +.. _class_TreeItem_method_set_button: - void **set_button** **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** Sets the given column's button :ref:`Texture` at index ``button_idx`` to ``button``. -.. _class_TreeItem_set_cell_mode: +.. _class_TreeItem_method_set_cell_mode: - void **set_cell_mode** **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** Sets the given column's cell mode to ``mode``. See ``CELL_MODE_*`` constants. -.. _class_TreeItem_set_checked: +.. _class_TreeItem_method_set_checked: - void **set_checked** **(** :ref:`int` column, :ref:`bool` checked **)** If ``true``, the column ``column`` is checked. -.. _class_TreeItem_set_custom_as_button: +.. _class_TreeItem_method_set_custom_as_button: - void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** -.. _class_TreeItem_set_custom_bg_color: +.. _class_TreeItem_method_set_custom_bg_color: - void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** Sets the given column's custom background color and whether to just use it as an outline. -.. _class_TreeItem_set_custom_color: +.. _class_TreeItem_method_set_custom_color: - void **set_custom_color** **(** :ref:`int` column, :ref:`Color` color **)** Sets the given column's custom color. -.. _class_TreeItem_set_custom_draw: +.. _class_TreeItem_method_set_custom_draw: - void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** @@ -458,65 +474,65 @@ Sets the given column's custom draw callback to ``callback`` method on ``object` The ``callback`` should accept two arguments: the :ref:`TreeItem` that is drawn and its position and size as a :ref:`Rect2`. -.. _class_TreeItem_set_editable: +.. _class_TreeItem_method_set_editable: - void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** If ``true``, column ``column`` is editable. -.. _class_TreeItem_set_expand_right: +.. _class_TreeItem_method_set_expand_right: - void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** If ``true``, column ``column`` is expanded to the right. -.. _class_TreeItem_set_icon: +.. _class_TreeItem_method_set_icon: - void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** Sets the given column's icon :ref:`Texture`. -.. _class_TreeItem_set_icon_max_width: +.. _class_TreeItem_method_set_icon_max_width: - void **set_icon_max_width** **(** :ref:`int` column, :ref:`int` width **)** Sets the given column's icon's maximum width. -.. _class_TreeItem_set_icon_region: +.. _class_TreeItem_method_set_icon_region: - void **set_icon_region** **(** :ref:`int` column, :ref:`Rect2` region **)** Sets the given column's icon's texture region. -.. _class_TreeItem_set_metadata: +.. _class_TreeItem_method_set_metadata: - void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** -.. _class_TreeItem_set_range: +.. _class_TreeItem_method_set_range: - void **set_range** **(** :ref:`int` column, :ref:`float` value **)** -.. _class_TreeItem_set_range_config: +.. _class_TreeItem_method_set_range_config: - void **set_range_config** **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** -.. _class_TreeItem_set_selectable: +.. _class_TreeItem_method_set_selectable: - void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** If ``true``, the given column is selectable. -.. _class_TreeItem_set_text: +.. _class_TreeItem_method_set_text: - void **set_text** **(** :ref:`int` column, :ref:`String` text **)** -.. _class_TreeItem_set_text_align: +.. _class_TreeItem_method_set_text_align: - void **set_text_align** **(** :ref:`int` column, :ref:`TextAlign` text_align **)** Sets the given column's text alignment. See ``ALIGN_*`` constants. -.. _class_TreeItem_set_tooltip: +.. _class_TreeItem_method_set_tooltip: - void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)** diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 7d47474f9..da37ee8af 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -19,79 +19,79 @@ Smoothly animates a node's properties over time. Properties ---------- -+------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`TweenProcessMode` | :ref:`playback_process_mode` | -+------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`float` | :ref:`playback_speed` | -+------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`bool` | :ref:`repeat` | -+------------------------------------------------------+-----------------------------------------------------------------+ ++------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`TweenProcessMode` | :ref:`playback_process_mode` | ++------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`playback_speed` | ++------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`repeat` | ++------------------------------------------------------+--------------------------------------------------------------------------+ Methods ------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_all` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset_all` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume_all` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`start` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop_all` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tell` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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 **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_all` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`reset_all` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resume_all` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`start` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stop_all` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tell` **(** **)** const | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Tween_tween_completed: +.. _class_Tween_signal_tween_completed: - **tween_completed** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween ends. -.. _class_Tween_tween_started: +.. _class_Tween_signal_tween_started: - **tween_started** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween starts. -.. _class_Tween_tween_step: +.. _class_Tween_signal_tween_step: - **tween_step** **(** :ref:`Object` object, :ref:`NodePath` key, :ref:`float` elapsed, :ref:`Object` value **)** @@ -102,6 +102,10 @@ Enumerations .. _enum_Tween_TweenProcessMode: +.. _class_Tween_constant_TWEEN_PROCESS_PHYSICS: + +.. _class_Tween_constant_TWEEN_PROCESS_IDLE: + enum **TweenProcessMode**: - **TWEEN_PROCESS_PHYSICS** = **0** --- The tween updates with the ``_physics_process`` callback. @@ -110,6 +114,28 @@ enum **TweenProcessMode**: .. _enum_Tween_TransitionType: +.. _class_Tween_constant_TRANS_LINEAR: + +.. _class_Tween_constant_TRANS_SINE: + +.. _class_Tween_constant_TRANS_QUINT: + +.. _class_Tween_constant_TRANS_QUART: + +.. _class_Tween_constant_TRANS_QUAD: + +.. _class_Tween_constant_TRANS_EXPO: + +.. _class_Tween_constant_TRANS_ELASTIC: + +.. _class_Tween_constant_TRANS_CUBIC: + +.. _class_Tween_constant_TRANS_CIRC: + +.. _class_Tween_constant_TRANS_BOUNCE: + +.. _class_Tween_constant_TRANS_BACK: + enum **TransitionType**: - **TRANS_LINEAR** = **0** --- The animation is interpolated linearly. @@ -136,6 +162,14 @@ enum **TransitionType**: .. _enum_Tween_EaseType: +.. _class_Tween_constant_EASE_IN: + +.. _class_Tween_constant_EASE_OUT: + +.. _class_Tween_constant_EASE_IN_OUT: + +.. _class_Tween_constant_EASE_OUT_IN: + enum **EaseType**: - **EASE_IN** = **0** --- The interpolation starts slowly and speeds up towards the end. @@ -163,12 +197,12 @@ Here is a brief usage example that causes a 2D node to move smoothly between two Many methods require a property name, such as "position" above. You can find the correct property name by hovering over the property in the Inspector. -Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an :ref:`TransitionType` constant, and refers to the way the timing of the animation is handled (see ``http://easings.net/`` for some examples). The second accepts an :ref:`EaseType` constant, and controls the where ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different :ref:`TransitionType` constants with ``EASE_IN_OUT``, and use the one that looks best. +Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an :ref:`TransitionType` constant, and refers to the way the timing of the animation is handled (see ``http://easings.net/`` for some examples). The second accepts an :ref:`EaseType` constant, and controls the where ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different :ref:`TransitionType` constants with ``EASE_IN_OUT``, and use the one that looks best. Property Descriptions --------------------- -.. _class_Tween_playback_process_mode: +.. _class_Tween_property_playback_process_mode: - :ref:`TweenProcessMode` **playback_process_mode** @@ -178,9 +212,9 @@ Property Descriptions | *Getter* | get_tween_process_mode() | +----------+-------------------------------+ -The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: :ref:`TWEEN_PROCESS_IDLE`. +The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: TWEEN_PROCESS_IDLE. -.. _class_Tween_playback_speed: +.. _class_Tween_property_playback_speed: - :ref:`float` **playback_speed** @@ -190,9 +224,9 @@ The tween's animation process thread. See :ref:`TweenProcessMode` or :ref:`stop_all` for this. +The tween's speed multiplier. For example, set it to ``1.0`` for normal speed, ``2.0`` for two times normal speed, or ``0.5`` for half of the normal speed. A value of ``0`` pauses the animation, but see also :ref:`set_active` or :ref:`stop_all` for this. -.. _class_Tween_repeat: +.. _class_Tween_property_repeat: - :ref:`bool` **repeat** @@ -207,145 +241,145 @@ If ``true``, the tween loops. Method Descriptions ------------------- -.. _class_Tween_follow_method: +.. _class_Tween_method_follow_method: - :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Follows ``method`` of ``object`` and applies the returned value on ``target_method`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` later. Methods are called with consecutive values. -Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information -.. _class_Tween_follow_property: +.. _class_Tween_method_follow_property: - :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Follows ``property`` of ``object`` and applies it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` seconds later. -Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information -.. _class_Tween_get_runtime: +.. _class_Tween_method_get_runtime: - :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. -.. _class_Tween_interpolate_callback: +.. _class_Tween_method_interpolate_callback: - :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** Calls ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are arguments to be passed to the callback. -.. _class_Tween_interpolate_deferred_callback: +.. _class_Tween_method_interpolate_deferred_callback: - :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** -Calls ``callback`` of ``object`` after ``duration`` on the main thread (similar to :ref:`Object.call_deferred`). ``arg1``-``arg5`` are arguments to be passed to the callback. +Calls ``callback`` of ``object`` after ``duration`` on the main thread (similar to :ref:`Object.call_deferred`). ``arg1``-``arg5`` are arguments to be passed to the callback. -.. _class_Tween_interpolate_method: +.. _class_Tween_method_interpolate_method: - :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Animates ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are called with consecutive values. -Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information -.. _class_Tween_interpolate_property: +.. _class_Tween_method_interpolate_property: - :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Animates ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Setting the initial value to ``null`` uses the current value of the property. -Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information -.. _class_Tween_is_active: +.. _class_Tween_method_is_active: - :ref:`bool` **is_active** **(** **)** const Returns ``true`` if any tweens are currently running. Note that this method doesn't consider tweens that have ended. -.. _class_Tween_remove: +.. _class_Tween_method_remove: - :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key="" **)** Stops animation and removes a tween, given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified. -.. _class_Tween_remove_all: +.. _class_Tween_method_remove_all: - :ref:`bool` **remove_all** **(** **)** Stops animation and removes all tweens. -.. _class_Tween_reset: +.. _class_Tween_method_reset: - :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key="" **)** Resets a tween to its initial value (the one given, not the one before the tween), given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified. -.. _class_Tween_reset_all: +.. _class_Tween_method_reset_all: - :ref:`bool` **reset_all** **(** **)** Resets all tweens to their initial values (the ones given, not those before the tween). -.. _class_Tween_resume: +.. _class_Tween_method_resume: - :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key="" **)** Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless ``key`` is specified. -.. _class_Tween_resume_all: +.. _class_Tween_method_resume_all: - :ref:`bool` **resume_all** **(** **)** Continues animating all stopped tweens. -.. _class_Tween_seek: +.. _class_Tween_method_seek: - :ref:`bool` **seek** **(** :ref:`float` time **)** Sets the interpolation to the given ``time`` in seconds. -.. _class_Tween_set_active: +.. _class_Tween_method_set_active: - void **set_active** **(** :ref:`bool` active **)** -Activates/deactivates the tween. See also :ref:`stop_all` and :ref:`resume_all`. +Activates/deactivates the tween. See also :ref:`stop_all` and :ref:`resume_all`. -.. _class_Tween_start: +.. _class_Tween_method_start: - :ref:`bool` **start** **(** **)** Starts the tween. You can define animations both before and after this. -.. _class_Tween_stop: +.. _class_Tween_method_stop: - :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key="" **)** Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless ``key`` is specified. -.. _class_Tween_stop_all: +.. _class_Tween_method_stop_all: - :ref:`bool` **stop_all** **(** **)** Stops animating all tweens. -.. _class_Tween_targeting_method: +.. _class_Tween_method_targeting_method: - :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Animates ``method`` of ``object`` from the value returned by ``initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecutive values. -Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information -.. _class_Tween_targeting_property: +.. _class_Tween_method_targeting_property: - :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Animates ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. -Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information +Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information -.. _class_Tween_tell: +.. _class_Tween_method_tell: - :ref:`float` **tell** **(** **)** const diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 5951285db..7786a9dec 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -19,39 +19,45 @@ Helper to manage UndoRedo in the editor or custom tools. Methods ------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :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 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :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 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_history` **(** :ref:`bool` increase_version=true **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_action` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_version` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`redo` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`undo` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :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 **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :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 **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_history` **(** :ref:`bool` increase_version=true **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_action` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_version` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`redo` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`undo` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_UndoRedo_MergeMode: +.. _class_UndoRedo_constant_MERGE_DISABLE: + +.. _class_UndoRedo_constant_MERGE_ENDS: + +.. _class_UndoRedo_constant_MERGE_ALL: + enum **MergeMode**: - **MERGE_DISABLE** = **0** @@ -88,50 +94,50 @@ Here's an example on how to add an action to Godot editor's own 'undoredo': undoredo.add_undo_property(node, "position", node.position) undoredo.commit_action() -:ref:`create_action`, :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, :ref:`add_undo_property`, and :ref:`commit_action` should be called one after the other, like in the example. Not doing so could lead to crashes. +:ref:`create_action`, :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, :ref:`add_undo_property`, and :ref:`commit_action` should be called one after the other, like in the example. Not doing so could lead to crashes. -If you don't need to register a method you can leave :ref:`add_do_method` and :ref:`add_undo_method` out, and so it goes for properties. You can register more than one method/property. +If you don't need to register a method you can leave :ref:`add_do_method` and :ref:`add_undo_method` out, and so it goes for properties. You can register more than one method/property. Method Descriptions ------------------- -.. _class_UndoRedo_add_do_method: +.. _class_UndoRedo_method_add_do_method: - :ref:`Variant` **add_do_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg Register a method that will be called when the action is committed. -.. _class_UndoRedo_add_do_property: +.. _class_UndoRedo_method_add_do_property: - void **add_do_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** Register a property value change for 'do'. -.. _class_UndoRedo_add_do_reference: +.. _class_UndoRedo_method_add_do_reference: - void **add_do_reference** **(** :ref:`Object` object **)** Register a reference for 'do' that will be erased if the 'do' history is lost. This is useful mostly for new nodes created for the 'do' call. Do not use for resources. -.. _class_UndoRedo_add_undo_method: +.. _class_UndoRedo_method_add_undo_method: - :ref:`Variant` **add_undo_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg Register a method that will be called when the action is undone. -.. _class_UndoRedo_add_undo_property: +.. _class_UndoRedo_method_add_undo_property: - void **add_undo_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** Register a property value change for 'undo'. -.. _class_UndoRedo_add_undo_reference: +.. _class_UndoRedo_method_add_undo_reference: - void **add_undo_reference** **(** :ref:`Object` object **)** Register a reference for 'undo' that will be erased if the 'undo' history is lost. This is useful mostly for nodes removed with the 'do' call (not the 'undo' call!). -.. _class_UndoRedo_clear_history: +.. _class_UndoRedo_method_clear_history: - void **clear_history** **(** :ref:`bool` increase_version=true **)** @@ -139,25 +145,25 @@ Clear the undo/redo history and associated references. Passing ``false`` to ``increase_version`` will prevent the version number to be increased from this. -.. _class_UndoRedo_commit_action: +.. _class_UndoRedo_method_commit_action: - void **commit_action** **(** **)** Commit the action. All 'do' methods/properties are called/set when this function is called. -.. _class_UndoRedo_create_action: +.. _class_UndoRedo_method_create_action: - void **create_action** **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** -Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, and :ref:`add_undo_property`, then commit the action with :ref:`commit_action`. +Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, and :ref:`add_undo_property`, then commit the action with :ref:`commit_action`. -.. _class_UndoRedo_get_current_action_name: +.. _class_UndoRedo_method_get_current_action_name: - :ref:`String` **get_current_action_name** **(** **)** const Get the name of the current action. -.. _class_UndoRedo_get_version: +.. _class_UndoRedo_method_get_version: - :ref:`int` **get_version** **(** **)** const @@ -165,13 +171,13 @@ Get the version, each time a new action is committed, the version number of the This is useful mostly to check if something changed from a saved version. -.. _class_UndoRedo_redo: +.. _class_UndoRedo_method_redo: - :ref:`bool` **redo** **(** **)** Redo last action. -.. _class_UndoRedo_undo: +.. _class_UndoRedo_method_undo: - :ref:`bool` **undo** **(** **)** diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index c16d0f8d5..1280e30da 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -19,46 +19,104 @@ UPNP network functions. Properties ---------- -+-----------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`discover_ipv6` | -+-----------------------------+----------------------------------------------------------------+ -| :ref:`int` | :ref:`discover_local_port` | -+-----------------------------+----------------------------------------------------------------+ -| :ref:`String` | :ref:`discover_multicast_if` | -+-----------------------------+----------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`discover_ipv6` | ++-----------------------------+-------------------------------------------------------------------------+ +| :ref:`int` | :ref:`discover_local_port` | ++-----------------------------+-------------------------------------------------------------------------+ +| :ref:`String` | :ref:`discover_multicast_if` | ++-----------------------------+-------------------------------------------------------------------------+ 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 ------------ .. _enum_UPNP_UPNPResult: +.. _class_UPNP_constant_UPNP_RESULT_SUCCESS: + +.. _class_UPNP_constant_UPNP_RESULT_NOT_AUTHORIZED: + +.. _class_UPNP_constant_UPNP_RESULT_PORT_MAPPING_NOT_FOUND: + +.. _class_UPNP_constant_UPNP_RESULT_INCONSISTENT_PARAMETERS: + +.. _class_UPNP_constant_UPNP_RESULT_NO_SUCH_ENTRY_IN_ARRAY: + +.. _class_UPNP_constant_UPNP_RESULT_ACTION_FAILED: + +.. _class_UPNP_constant_UPNP_RESULT_SRC_IP_WILDCARD_NOT_PERMITTED: + +.. _class_UPNP_constant_UPNP_RESULT_EXT_PORT_WILDCARD_NOT_PERMITTED: + +.. _class_UPNP_constant_UPNP_RESULT_INT_PORT_WILDCARD_NOT_PERMITTED: + +.. _class_UPNP_constant_UPNP_RESULT_REMOTE_HOST_MUST_BE_WILDCARD: + +.. _class_UPNP_constant_UPNP_RESULT_EXT_PORT_MUST_BE_WILDCARD: + +.. _class_UPNP_constant_UPNP_RESULT_NO_PORT_MAPS_AVAILABLE: + +.. _class_UPNP_constant_UPNP_RESULT_CONFLICT_WITH_OTHER_MECHANISM: + +.. _class_UPNP_constant_UPNP_RESULT_CONFLICT_WITH_OTHER_MAPPING: + +.. _class_UPNP_constant_UPNP_RESULT_SAME_PORT_VALUES_REQUIRED: + +.. _class_UPNP_constant_UPNP_RESULT_ONLY_PERMANENT_LEASE_SUPPORTED: + +.. _class_UPNP_constant_UPNP_RESULT_INVALID_GATEWAY: + +.. _class_UPNP_constant_UPNP_RESULT_INVALID_PORT: + +.. _class_UPNP_constant_UPNP_RESULT_INVALID_PROTOCOL: + +.. _class_UPNP_constant_UPNP_RESULT_INVALID_DURATION: + +.. _class_UPNP_constant_UPNP_RESULT_INVALID_ARGS: + +.. _class_UPNP_constant_UPNP_RESULT_INVALID_RESPONSE: + +.. _class_UPNP_constant_UPNP_RESULT_INVALID_PARAM: + +.. _class_UPNP_constant_UPNP_RESULT_HTTP_ERROR: + +.. _class_UPNP_constant_UPNP_RESULT_SOCKET_ERROR: + +.. _class_UPNP_constant_UPNP_RESULT_MEM_ALLOC_ERROR: + +.. _class_UPNP_constant_UPNP_RESULT_NO_GATEWAY: + +.. _class_UPNP_constant_UPNP_RESULT_NO_DEVICES: + +.. _class_UPNP_constant_UPNP_RESULT_UNKNOWN_ERROR: + enum **UPNPResult**: - **UPNP_RESULT_SUCCESS** = **0** --- UPNP command or discovery was successful. @@ -113,9 +171,9 @@ enum **UPNPResult**: - **UPNP_RESULT_MEM_ALLOC_ERROR** = **25** --- Error allocating memory. -- **UPNP_RESULT_NO_GATEWAY** = **26** --- No gateway available. You may need to call :ref:`discover` first, or discovery didn't detect any valid IGDs (InternetGatewayDevices). +- **UPNP_RESULT_NO_GATEWAY** = **26** --- No gateway available. You may need to call :ref:`discover` first, or discovery didn't detect any valid IGDs (InternetGatewayDevices). -- **UPNP_RESULT_NO_DEVICES** = **27** --- No devices available. You may need to call :ref:`discover` first, or discovery didn't detect any valid :ref:`UPNPDevice`\ s. +- **UPNP_RESULT_NO_DEVICES** = **27** --- No devices available. You may need to call :ref:`discover` first, or discovery didn't detect any valid :ref:`UPNPDevice`\ s. - **UPNP_RESULT_UNKNOWN_ERROR** = **28** --- Unknown error. @@ -127,7 +185,7 @@ Provides UPNP functionality to discover :ref:`UPNPDevice`\ s o Property Descriptions --------------------- -.. _class_UPNP_discover_ipv6: +.. _class_UPNP_property_discover_ipv6: - :ref:`bool` **discover_ipv6** @@ -139,7 +197,7 @@ Property Descriptions If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. -.. _class_UPNP_discover_local_port: +.. _class_UPNP_property_discover_local_port: - :ref:`int` **discover_local_port** @@ -151,7 +209,7 @@ If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. If ``0``, the local port to use for discovery is chosen automatically by the system. If ``1``, discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port. -.. _class_UPNP_discover_multicast_if: +.. _class_UPNP_property_discover_multicast_if: - :ref:`String` **discover_multicast_if** @@ -166,37 +224,37 @@ Multicast interface to use for discovery. Uses the default multicast interface i Method Descriptions ------------------- -.. _class_UPNP_add_device: +.. _class_UPNP_method_add_device: - void **add_device** **(** :ref:`UPNPDevice` device **)** Adds the given :ref:`UPNPDevice` to the list of discovered devices. -.. _class_UPNP_add_port_mapping: +.. _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 -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. +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. If ``internal_port`` is ``0`` (the default), the same port number is used for both the external and the internal port (the ``port`` value). The description (``desc``) is shown in some router UIs and can be used to point out which application added the mapping, and the lifetime of the mapping can be limited by ``duration``. However, some routers are incompatible with one or both of these, so use with caution and add fallback logic in case of errors to retry without them if in doubt. -See :ref:`UPNPResult` for possible return values. +See :ref:`UPNPResult` for possible return values. -.. _class_UPNP_clear_devices: +.. _class_UPNP_method_clear_devices: - void **clear_devices** **(** **)** Clears the list of discovered devices. -.. _class_UPNP_delete_port_mapping: +.. _class_UPNP_method_delete_port_mapping: - :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. +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. -.. _class_UPNP_discover: +.. _class_UPNP_method_discover: - :ref:`int` **discover** **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** @@ -204,39 +262,39 @@ Discovers local :ref:`UPNPDevice`\ s. Clears the list of previ Filters for IGD (InternetGatewayDevice) type devices by default, as those manage port forwarding. ``timeout`` is the time to wait for responses in milliseconds. ``ttl`` is the time-to-live; only touch this if you know what you're doing. -See :ref:`UPNPResult` for possible return values. +See :ref:`UPNPResult` for possible return values. -.. _class_UPNP_get_device: +.. _class_UPNP_method_get_device: - :ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** const Returns the :ref:`UPNPDevice` at the given ``index``. -.. _class_UPNP_get_device_count: +.. _class_UPNP_method_get_device_count: - :ref:`int` **get_device_count** **(** **)** const Returns the number of discovered :ref:`UPNPDevice`\ s. -.. _class_UPNP_get_gateway: +.. _class_UPNP_method_get_gateway: - :ref:`UPNPDevice` **get_gateway** **(** **)** const Returns the default gateway. That is the first discovered :ref:`UPNPDevice` that is also a valid IGD (InternetGatewayDevice). -.. _class_UPNP_query_external_address: +.. _class_UPNP_method_query_external_address: - :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. +Returns the external :ref:`IP` address of the default gateway (see :ref:`get_gateway`) as string. Returns an empty string on error. -.. _class_UPNP_remove_device: +.. _class_UPNP_method_remove_device: - void **remove_device** **(** :ref:`int` index **)** Removes the device at ``index`` from the list of discovered devices. -.. _class_UPNP_set_device: +.. _class_UPNP_method_set_device: - void **set_device** **(** :ref:`int` index, :ref:`UPNPDevice` device **)** diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index 19e8c4fd5..66eea5810 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -19,38 +19,58 @@ UPNP device. Properties ---------- -+---------------------------------------------+------------------------------------------------------------+ -| :ref:`String` | :ref:`description_url` | -+---------------------------------------------+------------------------------------------------------------+ -| :ref:`String` | :ref:`igd_control_url` | -+---------------------------------------------+------------------------------------------------------------+ -| :ref:`String` | :ref:`igd_our_addr` | -+---------------------------------------------+------------------------------------------------------------+ -| :ref:`String` | :ref:`igd_service_type` | -+---------------------------------------------+------------------------------------------------------------+ -| :ref:`IGDStatus` | :ref:`igd_status` | -+---------------------------------------------+------------------------------------------------------------+ -| :ref:`String` | :ref:`service_type` | -+---------------------------------------------+------------------------------------------------------------+ ++---------------------------------------------+---------------------------------------------------------------------+ +| :ref:`String` | :ref:`description_url` | ++---------------------------------------------+---------------------------------------------------------------------+ +| :ref:`String` | :ref:`igd_control_url` | ++---------------------------------------------+---------------------------------------------------------------------+ +| :ref:`String` | :ref:`igd_our_addr` | ++---------------------------------------------+---------------------------------------------------------------------+ +| :ref:`String` | :ref:`igd_service_type` | ++---------------------------------------------+---------------------------------------------------------------------+ +| :ref:`IGDStatus` | :ref:`igd_status` | ++---------------------------------------------+---------------------------------------------------------------------+ +| :ref:`String` | :ref:`service_type` | ++---------------------------------------------+---------------------------------------------------------------------+ 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 ------------ .. _enum_UPNPDevice_IGDStatus: +.. _class_UPNPDevice_constant_IGD_STATUS_OK: + +.. _class_UPNPDevice_constant_IGD_STATUS_HTTP_ERROR: + +.. _class_UPNPDevice_constant_IGD_STATUS_HTTP_EMPTY: + +.. _class_UPNPDevice_constant_IGD_STATUS_NO_URLS: + +.. _class_UPNPDevice_constant_IGD_STATUS_NO_IGD: + +.. _class_UPNPDevice_constant_IGD_STATUS_DISCONNECTED: + +.. _class_UPNPDevice_constant_IGD_STATUS_UNKNOWN_DEVICE: + +.. _class_UPNPDevice_constant_IGD_STATUS_INVALID_CONTROL: + +.. _class_UPNPDevice_constant_IGD_STATUS_MALLOC_ERROR: + +.. _class_UPNPDevice_constant_IGD_STATUS_UNKNOWN_ERROR: + enum **IGDStatus**: - **IGD_STATUS_OK** = **0** --- OK. @@ -81,7 +101,7 @@ UPNP device. See :ref:`UPNP` for UPNP discovery and utility function Property Descriptions --------------------- -.. _class_UPNPDevice_description_url: +.. _class_UPNPDevice_property_description_url: - :ref:`String` **description_url** @@ -93,7 +113,7 @@ Property Descriptions URL to the device description. -.. _class_UPNPDevice_igd_control_url: +.. _class_UPNPDevice_property_igd_control_url: - :ref:`String` **igd_control_url** @@ -105,7 +125,7 @@ URL to the device description. IDG control URL. -.. _class_UPNPDevice_igd_our_addr: +.. _class_UPNPDevice_property_igd_our_addr: - :ref:`String` **igd_our_addr** @@ -117,7 +137,7 @@ IDG control URL. Address of the local machine in the network connecting it to this :ref:`UPNPDevice`. -.. _class_UPNPDevice_igd_service_type: +.. _class_UPNPDevice_property_igd_service_type: - :ref:`String` **igd_service_type** @@ -129,7 +149,7 @@ Address of the local machine in the network connecting it to this :ref:`UPNPDevi IGD service type. -.. _class_UPNPDevice_igd_status: +.. _class_UPNPDevice_property_igd_status: - :ref:`IGDStatus` **igd_status** @@ -139,9 +159,9 @@ IGD service type. | *Getter* | get_igd_status() | +----------+-----------------------+ -IGD status. See :ref:`IGDStatus`. +IGD status. See :ref:`IGDStatus`. -.. _class_UPNPDevice_service_type: +.. _class_UPNPDevice_property_service_type: - :ref:`String` **service_type** @@ -156,25 +176,25 @@ Service type. Method Descriptions ------------------- -.. _class_UPNPDevice_add_port_mapping: +.. _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 -Adds a port mapping to forward the given external port on this :ref:`UPNPDevice` for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. +Adds a port mapping to forward the given external port on this :ref:`UPNPDevice` for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. -.. _class_UPNPDevice_delete_port_mapping: +.. _class_UPNPDevice_method_delete_port_mapping: - :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`. +Deletes the port mapping identified by the given port and protocol combination on this device. See :ref:`UPNP.delete_port_mapping`. -.. _class_UPNPDevice_is_valid_gateway: +.. _class_UPNPDevice_method_is_valid_gateway: - :ref:`bool` **is_valid_gateway** **(** **)** const Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding. -.. _class_UPNPDevice_query_external_address: +.. _class_UPNPDevice_method_query_external_address: - :ref:`String` **query_external_address** **(** **)** const diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index 7680bdbd2..f993263ee 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -19,9 +19,9 @@ Vertical box container. Theme Properties ---------------- -+-----------------------+---------------------------------------------------+ -| :ref:`int` | :ref:`separation` | -+-----------------------+---------------------------------------------------+ ++-----------------------+------------+ +| :ref:`int` | separation | ++-----------------------+------------+ Description ----------- diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 741e31e19..961e6c8c0 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -17,76 +17,90 @@ Vector used for 2D math. Properties ---------- -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`x` | -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`y` | -+---------------------------+---------------------------+ ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`x` | ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`y` | ++---------------------------+------------------------------------+ Methods ------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`float` x, :ref:`float` y **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`abs` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector2` to **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_to_point` **(** :ref:`Vector2` to **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`aspect` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`bounce` **(** :ref:`Vector2` n **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`ceil` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`clamped` **(** :ref:`float` length **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cross` **(** :ref:`Vector2` with **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector2` to **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector2` to **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dot` **(** :ref:`Vector2` with **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`floor` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_normalized` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length_squared` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`linear_interpolate` **(** :ref:`Vector2` b, :ref:`float` t **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`normalized` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`project` **(** :ref:`Vector2` b **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` n **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rotated` **(** :ref:`float` phi **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`round` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`slerp` **(** :ref:`Vector2` b, :ref:`float` t **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`slide` **(** :ref:`Vector2` n **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`snapped` **(** :ref:`Vector2` by **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tangent` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`float` x, :ref:`float` y **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`abs` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector2` to **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_to_point` **(** :ref:`Vector2` to **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`aspect` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`bounce` **(** :ref:`Vector2` n **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`ceil` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`clamped` **(** :ref:`float` length **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cross` **(** :ref:`Vector2` with **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector2` to **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector2` to **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dot` **(** :ref:`Vector2` with **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`floor` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_normalized` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length_squared` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`linear_interpolate` **(** :ref:`Vector2` b, :ref:`float` t **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`normalized` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`project` **(** :ref:`Vector2` b **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` n **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`rotated` **(** :ref:`float` phi **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`round` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`slerp` **(** :ref:`Vector2` b, :ref:`float` t **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`slide` **(** :ref:`Vector2` n **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`snapped` **(** :ref:`Vector2` by **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tangent` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- +.. _class_Vector2_constant_ZERO: + +.. _class_Vector2_constant_ONE: + +.. _class_Vector2_constant_INF: + +.. _class_Vector2_constant_LEFT: + +.. _class_Vector2_constant_RIGHT: + +.. _class_Vector2_constant_UP: + +.. _class_Vector2_constant_DOWN: + - **ZERO** = **Vector2( 0, 0 )** --- Zero vector. - **ONE** = **Vector2( 1, 1 )** --- One vector. @@ -114,13 +128,13 @@ Tutorials Property Descriptions --------------------- -.. _class_Vector2_x: +.. _class_Vector2_property_x: - :ref:`float` **x** The vector's x component. Also accessible by using the index position ``[0]``. -.. _class_Vector2_y: +.. _class_Vector2_property_y: - :ref:`float` **y** @@ -129,19 +143,19 @@ The vector's y component. Also accessible by using the index position ``[1]``. Method Descriptions ------------------- -.. _class_Vector2_Vector2: +.. _class_Vector2_method_Vector2: - :ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** Constructs a new Vector2 from the given x and y. -.. _class_Vector2_abs: +.. _class_Vector2_method_abs: - :ref:`Vector2` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). -.. _class_Vector2_angle: +.. _class_Vector2_method_angle: - :ref:`float` **angle** **(** **)** @@ -149,133 +163,133 @@ Returns the vector's angle in radians with respect to the x-axis, or ``(1, 0)`` Equivalent to the result of atan2 when called with the vector's x and y as parameters: ``atan2(x, y)``. -.. _class_Vector2_angle_to: +.. _class_Vector2_method_angle_to: - :ref:`float` **angle_to** **(** :ref:`Vector2` to **)** Returns the angle in radians between the two vectors. -.. _class_Vector2_angle_to_point: +.. _class_Vector2_method_angle_to_point: - :ref:`float` **angle_to_point** **(** :ref:`Vector2` to **)** Returns the angle in radians between the line connecting the two points and the x coordinate. -.. _class_Vector2_aspect: +.. _class_Vector2_method_aspect: - :ref:`float` **aspect** **(** **)** Returns the ratio of x to y. -.. _class_Vector2_bounce: +.. _class_Vector2_method_bounce: - :ref:`Vector2` **bounce** **(** :ref:`Vector2` n **)** Returns the vector "bounced off" from a plane defined by the given normal. -.. _class_Vector2_ceil: +.. _class_Vector2_method_ceil: - :ref:`Vector2` **ceil** **(** **)** Returns the vector with all components rounded up. -.. _class_Vector2_clamped: +.. _class_Vector2_method_clamped: - :ref:`Vector2` **clamped** **(** :ref:`float` length **)** Returns the vector with a maximum length. -.. _class_Vector2_cross: +.. _class_Vector2_method_cross: - :ref:`float` **cross** **(** :ref:`Vector2` with **)** Returns the 2 dimensional analog of the cross product with the given vector. -.. _class_Vector2_cubic_interpolate: +.. _class_Vector2_method_cubic_interpolate: - :ref:`Vector2` **cubic_interpolate** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** Cubicly interpolates between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. -.. _class_Vector2_distance_squared_to: +.. _class_Vector2_method_distance_squared_to: - :ref:`float` **distance_squared_to** **(** :ref:`Vector2` to **)** -Returns the squared distance to vector ``b``. Prefer this function over :ref:`distance_to` if you need to sort vectors or need the squared distance for some formula. +Returns the squared distance to vector ``b``. Prefer this function over :ref:`distance_to` if you need to sort vectors or need the squared distance for some formula. -.. _class_Vector2_distance_to: +.. _class_Vector2_method_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector2` to **)** Returns the distance to vector ``b``. -.. _class_Vector2_dot: +.. _class_Vector2_method_dot: - :ref:`float` **dot** **(** :ref:`Vector2` with **)** Returns the dot product with vector ``b``. -.. _class_Vector2_floor: +.. _class_Vector2_method_floor: - :ref:`Vector2` **floor** **(** **)** Returns the vector with all components rounded down. -.. _class_Vector2_is_normalized: +.. _class_Vector2_method_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns ``true`` if the vector is normalized. -.. _class_Vector2_length: +.. _class_Vector2_method_length: - :ref:`float` **length** **(** **)** Returns the vector's length. -.. _class_Vector2_length_squared: +.. _class_Vector2_method_length_squared: - :ref:`float` **length_squared** **(** **)** -Returns the vector's length squared. Prefer this function over :ref:`length` if you need to sort vectors or need the squared length for some formula. +Returns the vector's length squared. Prefer this function over :ref:`length` if you need to sort vectors or need the squared length for some formula. -.. _class_Vector2_linear_interpolate: +.. _class_Vector2_method_linear_interpolate: - :ref:`Vector2` **linear_interpolate** **(** :ref:`Vector2` b, :ref:`float` t **)** Returns the result of the linear interpolation between this vector and ``b`` by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. -.. _class_Vector2_normalized: +.. _class_Vector2_method_normalized: - :ref:`Vector2` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. -.. _class_Vector2_project: +.. _class_Vector2_method_project: - :ref:`Vector2` **project** **(** :ref:`Vector2` b **)** Returns the vector projected onto the vector ``b``. -.. _class_Vector2_reflect: +.. _class_Vector2_method_reflect: - :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** Returns the vector reflected from a plane defined by the given normal. -.. _class_Vector2_rotated: +.. _class_Vector2_method_rotated: - :ref:`Vector2` **rotated** **(** :ref:`float` phi **)** Returns the vector rotated by ``phi`` radians. -.. _class_Vector2_round: +.. _class_Vector2_method_round: - :ref:`Vector2` **round** **(** **)** Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. -.. _class_Vector2_slerp: +.. _class_Vector2_method_slerp: - :ref:`Vector2` **slerp** **(** :ref:`Vector2` b, :ref:`float` t **)** @@ -283,19 +297,19 @@ Returns the result of SLERP between this vector and ``b``, by amount ``t``. ``t` Both vectors need to be normalized. -.. _class_Vector2_slide: +.. _class_Vector2_method_slide: - :ref:`Vector2` **slide** **(** :ref:`Vector2` n **)** Returns the component of the vector along a plane defined by the given normal. -.. _class_Vector2_snapped: +.. _class_Vector2_method_snapped: - :ref:`Vector2` **snapped** **(** :ref:`Vector2` by **)** Returns the vector snapped to a grid with the given size. -.. _class_Vector2_tangent: +.. _class_Vector2_method_tangent: - :ref:`Vector2` **tangent** **(** **)** diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index d3de83dda..1393a5553 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -17,79 +17,103 @@ Vector class, which performs basic 3D vector math operations. Properties ---------- -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`x` | -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`y` | -+---------------------------+---------------------------+ -| :ref:`float` | :ref:`z` | -+---------------------------+---------------------------+ ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`x` | ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`y` | ++---------------------------+------------------------------------+ +| :ref:`float` | :ref:`z` | ++---------------------------+------------------------------------+ Methods ------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`abs` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector3` to **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`bounce` **(** :ref:`Vector3` n **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`ceil` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cross` **(** :ref:`Vector3` b **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cubic_interpolate` **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector3` b **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` b **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dot` **(** :ref:`Vector3` b **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`floor` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`inverse` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_normalized` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`length_squared` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`linear_interpolate` **(** :ref:`Vector3` b, :ref:`float` t **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`max_axis` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`min_axis` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`normalized` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` b **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` b **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` n **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`round` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`slerp` **(** :ref:`Vector3` b, :ref:`float` t **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` n **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`snapped` **(** :ref:`Vector3` by **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`to_diagonal_matrix` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`abs` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector3` to **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`bounce` **(** :ref:`Vector3` n **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`ceil` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`cross` **(** :ref:`Vector3` b **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`cubic_interpolate` **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector3` b **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` b **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dot` **(** :ref:`Vector3` b **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`floor` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`inverse` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_normalized` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`length_squared` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`linear_interpolate` **(** :ref:`Vector3` b, :ref:`float` t **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`max_axis` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`min_axis` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`normalized` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` b **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` b **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` n **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`round` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`slerp` **(** :ref:`Vector3` b, :ref:`float` t **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` n **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`snapped` **(** :ref:`Vector3` by **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`to_diagonal_matrix` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- -- **AXIS_X** = **0** --- Enumerated value for the X axis. Returned by :ref:`max_axis` and :ref:`min_axis`. +.. _class_Vector3_constant_AXIS_X: + +.. _class_Vector3_constant_AXIS_Y: + +.. _class_Vector3_constant_AXIS_Z: + +.. _class_Vector3_constant_ZERO: + +.. _class_Vector3_constant_ONE: + +.. _class_Vector3_constant_INF: + +.. _class_Vector3_constant_LEFT: + +.. _class_Vector3_constant_RIGHT: + +.. _class_Vector3_constant_UP: + +.. _class_Vector3_constant_DOWN: + +.. _class_Vector3_constant_FORWARD: + +.. _class_Vector3_constant_BACK: + +- **AXIS_X** = **0** --- Enumerated value for the X axis. Returned by :ref:`max_axis` and :ref:`min_axis`. - **AXIS_Y** = **1** --- Enumerated value for the Y axis. @@ -126,19 +150,19 @@ Tutorials Property Descriptions --------------------- -.. _class_Vector3_x: +.. _class_Vector3_property_x: - :ref:`float` **x** The vector's x component. Also accessible by using the index position ``[0]``. -.. _class_Vector3_y: +.. _class_Vector3_property_y: - :ref:`float` **y** The vector's y component. Also accessible by using the index position ``[1]``. -.. _class_Vector3_z: +.. _class_Vector3_property_z: - :ref:`float` **z** @@ -147,151 +171,151 @@ The vector's z component. Also accessible by using the index position ``[2]``. Method Descriptions ------------------- -.. _class_Vector3_Vector3: +.. _class_Vector3_method_Vector3: - :ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** Returns a Vector3 with the given components. -.. _class_Vector3_abs: +.. _class_Vector3_method_abs: - :ref:`Vector3` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). -.. _class_Vector3_angle_to: +.. _class_Vector3_method_angle_to: - :ref:`float` **angle_to** **(** :ref:`Vector3` to **)** Returns the minimum angle to the given vector. -.. _class_Vector3_bounce: +.. _class_Vector3_method_bounce: - :ref:`Vector3` **bounce** **(** :ref:`Vector3` n **)** Returns the vector "bounced off" from a plane defined by the given normal. -.. _class_Vector3_ceil: +.. _class_Vector3_method_ceil: - :ref:`Vector3` **ceil** **(** **)** Returns a new vector with all components rounded up. -.. _class_Vector3_cross: +.. _class_Vector3_method_cross: - :ref:`Vector3` **cross** **(** :ref:`Vector3` b **)** Returns the cross product with ``b``. -.. _class_Vector3_cubic_interpolate: +.. _class_Vector3_method_cubic_interpolate: - :ref:`Vector3` **cubic_interpolate** **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** Performs a cubic interpolation between vectors ``pre_a``, ``a``, ``b``, ``post_b`` (``a`` is current), by the given amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. -.. _class_Vector3_distance_squared_to: +.. _class_Vector3_method_distance_squared_to: - :ref:`float` **distance_squared_to** **(** :ref:`Vector3` b **)** -Returns the squared distance to ``b``. Prefer this function over :ref:`distance_to` if you need to sort vectors or need the squared distance for some formula. +Returns the squared distance to ``b``. Prefer this function over :ref:`distance_to` if you need to sort vectors or need the squared distance for some formula. -.. _class_Vector3_distance_to: +.. _class_Vector3_method_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector3` b **)** Returns the distance to ``b``. -.. _class_Vector3_dot: +.. _class_Vector3_method_dot: - :ref:`float` **dot** **(** :ref:`Vector3` b **)** Returns the dot product with ``b``. -.. _class_Vector3_floor: +.. _class_Vector3_method_floor: - :ref:`Vector3` **floor** **(** **)** Returns a new vector with all components rounded down. -.. _class_Vector3_inverse: +.. _class_Vector3_method_inverse: - :ref:`Vector3` **inverse** **(** **)** Returns the inverse of the vector. This is the same as ``Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )``. -.. _class_Vector3_is_normalized: +.. _class_Vector3_method_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns ``true`` if the vector is normalized. -.. _class_Vector3_length: +.. _class_Vector3_method_length: - :ref:`float` **length** **(** **)** Returns the vector's length. -.. _class_Vector3_length_squared: +.. _class_Vector3_method_length_squared: - :ref:`float` **length_squared** **(** **)** -Returns the vector's length squared. Prefer this function over :ref:`length` if you need to sort vectors or need the squared length for some formula. +Returns the vector's length squared. Prefer this function over :ref:`length` if you need to sort vectors or need the squared length for some formula. -.. _class_Vector3_linear_interpolate: +.. _class_Vector3_method_linear_interpolate: - :ref:`Vector3` **linear_interpolate** **(** :ref:`Vector3` b, :ref:`float` t **)** Returns the result of the linear interpolation between this vector and ``b`` by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation.. -.. _class_Vector3_max_axis: +.. _class_Vector3_method_max_axis: - :ref:`int` **max_axis** **(** **)** Returns the axis of the vector's largest value. See ``AXIS_*`` constants. -.. _class_Vector3_min_axis: +.. _class_Vector3_method_min_axis: - :ref:`int` **min_axis** **(** **)** Returns the axis of the vector's smallest value. See ``AXIS_*`` constants. -.. _class_Vector3_normalized: +.. _class_Vector3_method_normalized: - :ref:`Vector3` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. -.. _class_Vector3_outer: +.. _class_Vector3_method_outer: - :ref:`Basis` **outer** **(** :ref:`Vector3` b **)** Returns the outer product with ``b``. -.. _class_Vector3_project: +.. _class_Vector3_method_project: - :ref:`Vector3` **project** **(** :ref:`Vector3` b **)** Returns the vector projected onto the vector ``b``. -.. _class_Vector3_reflect: +.. _class_Vector3_method_reflect: - :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** Returns the vector reflected from a plane defined by the given normal. -.. _class_Vector3_rotated: +.. _class_Vector3_method_rotated: - :ref:`Vector3` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Rotates the vector around a given axis by ``phi`` radians. The axis must be a normalized vector. -.. _class_Vector3_round: +.. _class_Vector3_method_round: - :ref:`Vector3` **round** **(** **)** Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. -.. _class_Vector3_slerp: +.. _class_Vector3_method_slerp: - :ref:`Vector3` **slerp** **(** :ref:`Vector3` b, :ref:`float` t **)** @@ -299,19 +323,19 @@ Returns the result of SLERP between this vector and ``b``, by amount ``t``. ``t` Both vectors need to be normalized. -.. _class_Vector3_slide: +.. _class_Vector3_method_slide: - :ref:`Vector3` **slide** **(** :ref:`Vector3` n **)** Returns the component of the vector along a plane defined by the given normal. -.. _class_Vector3_snapped: +.. _class_Vector3_method_snapped: - :ref:`Vector3` **snapped** **(** :ref:`Vector3` by **)** Returns a copy of the vector, snapped to the lowest neared multiple. -.. _class_Vector3_to_diagonal_matrix: +.. _class_Vector3_method_to_diagonal_matrix: - :ref:`Basis` **to_diagonal_matrix** **(** **)** diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 17dab6348..e0c38d45b 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -19,25 +19,25 @@ Physics body that simulates the behaviour of a car. Properties ---------- -+---------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`brake` | -+---------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`engine_force` | -+---------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`steering` | -+---------------------------+-----------------------------------------------------+ ++---------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`brake` | ++---------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`engine_force` | ++---------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`steering` | ++---------------------------+--------------------------------------------------------------+ Description ----------- -This nodes implements all the physics logic needed to simulate a car. It is based on the raycast vehicle system commonly found in physics engines. You will need to add a :ref:`CollisionShape` for the main body of your vehicle and add :ref:`VehicleWheel` nodes for the wheels. You should also add a :ref:`MeshInstance` to this node for the 3D model of your car but this model should not include meshes for the wheels. You should control the vehicle by using the :ref:`brake`, :ref:`engine_force`, and :ref:`steering` properties and not change the position or orientation of this node directly. +This nodes implements all the physics logic needed to simulate a car. It is based on the raycast vehicle system commonly found in physics engines. You will need to add a :ref:`CollisionShape` for the main body of your vehicle and add :ref:`VehicleWheel` nodes for the wheels. You should also add a :ref:`MeshInstance` to this node for the 3D model of your car but this model should not include meshes for the wheels. You should control the vehicle by using the :ref:`brake`, :ref:`engine_force`, and :ref:`steering` properties and not change the position or orientation of this node directly. Note that the origin point of your VehicleBody will determine the center of gravity of your vehicle so it is better to keep this low and move the :ref:`CollisionShape` and :ref:`MeshInstance` upwards. Property Descriptions --------------------- -.. _class_VehicleBody_brake: +.. _class_VehicleBody_property_brake: - :ref:`float` **brake** @@ -47,9 +47,9 @@ Property Descriptions | *Getter* | get_brake() | +----------+------------------+ -Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the :ref:`RigidBody.mass` of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. +Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the :ref:`RigidBody.mass` of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. -.. _class_VehicleBody_engine_force: +.. _class_VehicleBody_property_engine_force: - :ref:`float` **engine_force** @@ -59,11 +59,11 @@ Slows down the vehicle by applying a braking force. The vehicle is only slowed d | *Getter* | get_engine_force() | +----------+-------------------------+ -Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have :ref:`VehicleWheel.set_use_as_traction` set to true and are in contact with a surface. The :ref:`RigidBody.mass` of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. Note that the simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. +Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have :ref:`VehicleWheel.set_use_as_traction` set to true and are in contact with a surface. The :ref:`RigidBody.mass` of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. Note that the simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. A negative value will result in the vehicle reversing. -.. _class_VehicleBody_steering: +.. _class_VehicleBody_property_steering: - :ref:`float` **steering** @@ -73,5 +73,5 @@ A negative value will result in the vehicle reversing. | *Getter* | get_steering() | +----------+---------------------+ -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.set_use_as_steering` set to true will automatically be rotated. +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.set_use_as_steering` set to true will automatically be rotated. diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 2a10df779..df8af8faf 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -19,38 +19,38 @@ Physics object that simulates the behaviour of a wheel. Properties ---------- -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_compression` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`damping_relaxation` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`suspension_max_force` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`suspension_stiffness` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`suspension_travel` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_as_steering` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`use_as_traction` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`wheel_friction_slip` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`wheel_radius` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`wheel_rest_length` | -+---------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`wheel_roll_influence` | -+---------------------------+----------------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping_compression` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`damping_relaxation` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`suspension_max_force` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`suspension_stiffness` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`suspension_travel` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_as_steering` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_as_traction` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`wheel_friction_slip` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`wheel_radius` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`wheel_rest_length` | ++---------------------------+-------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`wheel_roll_influence` | ++---------------------------+-------------------------------------------------------------------------------+ Methods ------- -+----------------------------+--------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_skidinfo` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_contact` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_skidinfo` **(** **)** const | ++---------------------------+---------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_contact` **(** **)** const | ++---------------------------+---------------------------------------------------------------------------------+ Description ----------- @@ -60,7 +60,7 @@ This node needs to be used as a child node of :ref:`VehicleBody` **damping_compression** @@ -72,7 +72,7 @@ Property Descriptions The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. -.. _class_VehicleWheel_damping_relaxation: +.. _class_VehicleWheel_property_damping_relaxation: - :ref:`float` **damping_relaxation** @@ -82,9 +82,9 @@ The damping applied to the spring when the spring is being compressed. This valu | *Getter* | get_damping_relaxation() | +----------+-------------------------------+ -The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the :ref:`damping_compression` property. For a :ref:`damping_compression` value of 0.3, try a relaxation value of 0.5 +The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the :ref:`damping_compression` property. For a :ref:`damping_compression` value of 0.3, try a relaxation value of 0.5 -.. _class_VehicleWheel_suspension_max_force: +.. _class_VehicleWheel_property_suspension_max_force: - :ref:`float` **suspension_max_force** @@ -94,9 +94,9 @@ The damping applied to the spring when relaxing. This value should be between 0. | *Getter* | get_suspension_max_force() | +----------+---------------------------------+ -The maximum force the spring can resist. This value should be higher than a quarter of the :ref:`RigidBody.mass` of the :ref:`VehicleBody` or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number. +The maximum force the spring can resist. This value should be higher than a quarter of the :ref:`RigidBody.mass` of the :ref:`VehicleBody` or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number. -.. _class_VehicleWheel_suspension_stiffness: +.. _class_VehicleWheel_property_suspension_stiffness: - :ref:`float` **suspension_stiffness** @@ -108,7 +108,7 @@ The maximum force the spring can resist. This value should be higher than a quar This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. -.. _class_VehicleWheel_suspension_travel: +.. _class_VehicleWheel_property_suspension_travel: - :ref:`float` **suspension_travel** @@ -120,7 +120,7 @@ This value defines the stiffness of the suspension. Use a value lower than 50 fo This is the distance the suspension can travel. As Godot measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car . -.. _class_VehicleWheel_use_as_steering: +.. _class_VehicleWheel_property_use_as_steering: - :ref:`bool` **use_as_steering** @@ -132,7 +132,7 @@ This is the distance the suspension can travel. As Godot measures are in meters If true this wheel will be turned when the car steers. -.. _class_VehicleWheel_use_as_traction: +.. _class_VehicleWheel_property_use_as_traction: - :ref:`bool` **use_as_traction** @@ -144,7 +144,7 @@ If true this wheel will be turned when the car steers. If true this wheel transfers engine force to the ground to propel the vehicle forward. -.. _class_VehicleWheel_wheel_friction_slip: +.. _class_VehicleWheel_property_wheel_friction_slip: - :ref:`float` **wheel_friction_slip** @@ -158,7 +158,7 @@ This determines how much grip this wheel has. It is combined with the friction s It's best to set this to 1.0 when starting out. -.. _class_VehicleWheel_wheel_radius: +.. _class_VehicleWheel_property_wheel_radius: - :ref:`float` **wheel_radius** @@ -170,7 +170,7 @@ It's best to set this to 1.0 when starting out. The radius of the wheel in meters. -.. _class_VehicleWheel_wheel_rest_length: +.. _class_VehicleWheel_property_wheel_rest_length: - :ref:`float` **wheel_rest_length** @@ -182,7 +182,7 @@ The radius of the wheel in meters. This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest. -.. _class_VehicleWheel_wheel_roll_influence: +.. _class_VehicleWheel_property_wheel_roll_influence: - :ref:`float` **wheel_roll_influence** @@ -197,13 +197,13 @@ This value effects the roll of your vehicle. If set to 0.0 for all wheels your v Method Descriptions ------------------- -.. _class_VehicleWheel_get_skidinfo: +.. _class_VehicleWheel_method_get_skidinfo: - :ref:`float` **get_skidinfo** **(** **)** const Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is not skidding, 1.0 means the wheel has lost grip. -.. _class_VehicleWheel_is_in_contact: +.. _class_VehicleWheel_method_is_in_contact: - :ref:`bool` **is_in_contact** **(** **)** const diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 4356903e3..2a67f1f48 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -19,47 +19,47 @@ Control for playing video streams. Properties ---------- -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`audio_track` | -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`autoplay` | -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`int` | :ref:`buffering_msec` | -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`bus` | -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`expand` | -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`bool` | :ref:`paused` | -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`VideoStream` | :ref:`stream` | -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`stream_position` | -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`volume` | -+---------------------------------------+-----------------------------------------------------------+ -| :ref:`float` | :ref:`volume_db` | -+---------------------------------------+-----------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio_track` | ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`autoplay` | ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`buffering_msec` | ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`bus` | ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`expand` | ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`paused` | ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`VideoStream` | :ref:`stream` | ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`stream_position` | ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`volume` | ++---------------------------------------+--------------------------------------------------------------------+ +| :ref:`float` | :ref:`volume_db` | ++---------------------------------------+--------------------------------------------------------------------+ Methods ------- -+--------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_stream_name` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_video_texture` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------+ -| :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` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++-------------------------------+------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------------+------------------------------------------------------------------------------------+ Signals ------- -.. _class_VideoPlayer_finished: +.. _class_VideoPlayer_signal_finished: - **finished** **(** **)** @@ -73,7 +73,7 @@ Control node for playing video streams. Supported formats are WebM and OGV Theor Property Descriptions --------------------- -.. _class_VideoPlayer_audio_track: +.. _class_VideoPlayer_property_audio_track: - :ref:`int` **audio_track** @@ -85,7 +85,7 @@ Property Descriptions The embedded audio track to play. -.. _class_VideoPlayer_autoplay: +.. _class_VideoPlayer_property_autoplay: - :ref:`bool` **autoplay** @@ -97,7 +97,7 @@ The embedded audio track to play. If ``true``, playback starts when the scene loads. Default value: ``false``. -.. _class_VideoPlayer_buffering_msec: +.. _class_VideoPlayer_property_buffering_msec: - :ref:`int` **buffering_msec** @@ -109,7 +109,7 @@ If ``true``, playback starts when the scene loads. Default value: ``false``. Amount of time in milliseconds to store in buffer while playing. -.. _class_VideoPlayer_bus: +.. _class_VideoPlayer_property_bus: - :ref:`String` **bus** @@ -121,7 +121,7 @@ Amount of time in milliseconds to store in buffer while playing. Audio bus to use for sound playback. -.. _class_VideoPlayer_expand: +.. _class_VideoPlayer_property_expand: - :ref:`bool` **expand** @@ -133,7 +133,7 @@ Audio bus to use for sound playback. If ``true``, the video scales to the control size. Default value: ``true``. -.. _class_VideoPlayer_paused: +.. _class_VideoPlayer_property_paused: - :ref:`bool` **paused** @@ -145,7 +145,7 @@ If ``true``, the video scales to the control size. Default value: ``true``. If ``true``, the video is paused. -.. _class_VideoPlayer_stream: +.. _class_VideoPlayer_property_stream: - :ref:`VideoStream` **stream** @@ -155,7 +155,7 @@ If ``true``, the video is paused. | *Getter* | get_stream() | +----------+-------------------+ -.. _class_VideoPlayer_stream_position: +.. _class_VideoPlayer_property_stream_position: - :ref:`float` **stream_position** @@ -167,7 +167,7 @@ If ``true``, the video is paused. The current position of the stream, in seconds. -.. _class_VideoPlayer_volume: +.. _class_VideoPlayer_property_volume: - :ref:`float` **volume** @@ -179,7 +179,7 @@ The current position of the stream, in seconds. Audio volume as a linear value. -.. _class_VideoPlayer_volume_db: +.. _class_VideoPlayer_property_volume_db: - :ref:`float` **volume_db** @@ -194,31 +194,31 @@ Audio volume in dB. Method Descriptions ------------------- -.. _class_VideoPlayer_get_stream_name: +.. _class_VideoPlayer_method_get_stream_name: - :ref:`String` **get_stream_name** **(** **)** const Returns the video stream's name. -.. _class_VideoPlayer_get_video_texture: +.. _class_VideoPlayer_method_get_video_texture: - :ref:`Texture` **get_video_texture** **(** **)** Returns the current frame as a :ref:`Texture`. -.. _class_VideoPlayer_is_playing: +.. _class_VideoPlayer_method_is_playing: - :ref:`bool` **is_playing** **(** **)** const Returns ``true`` if the video is playing. -.. _class_VideoPlayer_play: +.. _class_VideoPlayer_method_play: - void **play** **(** **)** Starts the video playback. -.. _class_VideoPlayer_stop: +.. _class_VideoPlayer_method_stop: - void **stop** **(** **)** diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index 3ee874a4e..9025b0706 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -19,20 +19,20 @@ Brief Description Methods ------- -+------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_file` **(** :ref:`String` file **)** | -+------------------------------+------------------------------------------------------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_file` **(** :ref:`String` file **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_VideoStreamTheora_get_file: +.. _class_VideoStreamTheora_method_get_file: - :ref:`String` **get_file** **(** **)** -.. _class_VideoStreamTheora_set_file: +.. _class_VideoStreamTheora_method_set_file: - void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst index 118901739..3ada6451b 100644 --- a/classes/class_videostreamwebm.rst +++ b/classes/class_videostreamwebm.rst @@ -19,20 +19,20 @@ Brief Description Methods ------- -+------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_file` **(** :ref:`String` file **)** | -+------------------------------+----------------------------------------------------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_file` **(** :ref:`String` file **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_VideoStreamWebm_get_file: +.. _class_VideoStreamWebm_method_get_file: - :ref:`String` **get_file** **(** **)** -.. _class_VideoStreamWebm_set_file: +.. _class_VideoStreamWebm_method_set_file: - void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index ab1e3cd77..eb351d136 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -19,133 +19,141 @@ Creates a sub-view into the screen. Properties ---------- -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`arvr` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio_listener_enable_2d` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio_listener_enable_3d` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`canvas_transform` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`DebugDraw` | :ref:`debug_draw` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`disable_3d` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`global_canvas_transform` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_disable_input` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_snap_controls_to_pixels` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handle_input_locally` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hdr` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`keep_3d_linear` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`MSAA` | :ref:`msaa` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`own_world` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics_object_picking` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`ClearMode` | :ref:`render_target_clear_mode` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`UpdateMode` | :ref:`render_target_update_mode` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`render_target_v_flip` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_0` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_1` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_2` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_3` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_atlas_size` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`transparent_bg` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Usage` | :ref:`usage` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`world` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`world_2d` | -+---------------------------------------------------------------------------+--------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`arvr` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio_listener_enable_2d` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio_listener_enable_3d` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`canvas_transform` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`DebugDraw` | :ref:`debug_draw` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disable_3d` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`global_canvas_transform` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui_disable_input` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui_snap_controls_to_pixels` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handle_input_locally` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hdr` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`keep_3d_linear` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`MSAA` | :ref:`msaa` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`own_world` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics_object_picking` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`ClearMode` | :ref:`render_target_clear_mode` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`UpdateMode` | :ref:`render_target_update_mode` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`render_target_v_flip` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_0` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_1` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_2` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_3` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shadow_atlas_size` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`size` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`transparent_bg` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`Usage` | :ref:`usage` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`world` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`world_2d` | ++---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ Methods ------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`find_world` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Camera` | :ref:`get_camera` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_modal_stack_top` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** 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_size_override_enabled` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_as_handled` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_worlds` **(** **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`find_world` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Camera` | :ref:`get_camera` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_modal_stack_top` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** 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_size_override_enabled` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_as_handled` **(** **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_worlds` **(** **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_Viewport_size_changed: +.. _class_Viewport_signal_size_changed: - **size_changed** **(** **)** -Emitted when the size of the viewport is changed, whether by :ref:`set_size_override`, resize of window, or some other means. +Emitted when the size of the viewport is changed, whether by :ref:`set_size_override`, resize of window, or some other means. Enumerations ------------ .. _enum_Viewport_UpdateMode: +.. _class_Viewport_constant_UPDATE_DISABLED: + +.. _class_Viewport_constant_UPDATE_ONCE: + +.. _class_Viewport_constant_UPDATE_WHEN_VISIBLE: + +.. _class_Viewport_constant_UPDATE_ALWAYS: + enum **UpdateMode**: - **UPDATE_DISABLED** = **0** --- Do not update the render target. @@ -158,6 +166,22 @@ enum **UpdateMode**: .. _enum_Viewport_ShadowAtlasQuadrantSubdiv: +.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED: + +.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_1: + +.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_4: + +.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_16: + +.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_64: + +.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_256: + +.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_1024: + +.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_MAX: + enum **ShadowAtlasQuadrantSubdiv**: - **SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED** = **0** @@ -178,6 +202,20 @@ enum **ShadowAtlasQuadrantSubdiv**: .. _enum_Viewport_RenderInfo: +.. _class_Viewport_constant_RENDER_INFO_OBJECTS_IN_FRAME: + +.. _class_Viewport_constant_RENDER_INFO_VERTICES_IN_FRAME: + +.. _class_Viewport_constant_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME: + +.. _class_Viewport_constant_RENDER_INFO_SHADER_CHANGES_IN_FRAME: + +.. _class_Viewport_constant_RENDER_INFO_SURFACE_CHANGES_IN_FRAME: + +.. _class_Viewport_constant_RENDER_INFO_DRAW_CALLS_IN_FRAME: + +.. _class_Viewport_constant_RENDER_INFO_MAX: + enum **RenderInfo**: - **RENDER_INFO_OBJECTS_IN_FRAME** = **0** --- Amount of objects in frame. @@ -196,6 +234,14 @@ enum **RenderInfo**: .. _enum_Viewport_DebugDraw: +.. _class_Viewport_constant_DEBUG_DRAW_DISABLED: + +.. _class_Viewport_constant_DEBUG_DRAW_UNSHADED: + +.. _class_Viewport_constant_DEBUG_DRAW_OVERDRAW: + +.. _class_Viewport_constant_DEBUG_DRAW_WIREFRAME: + enum **DebugDraw**: - **DEBUG_DRAW_DISABLED** = **0** --- Objects are displayed normally. @@ -208,6 +254,16 @@ enum **DebugDraw**: .. _enum_Viewport_MSAA: +.. _class_Viewport_constant_MSAA_DISABLED: + +.. _class_Viewport_constant_MSAA_2X: + +.. _class_Viewport_constant_MSAA_4X: + +.. _class_Viewport_constant_MSAA_8X: + +.. _class_Viewport_constant_MSAA_16X: + enum **MSAA**: - **MSAA_DISABLED** = **0** --- Multisample anti-aliasing mode disabled. This is the default value. @@ -222,6 +278,14 @@ enum **MSAA**: .. _enum_Viewport_Usage: +.. _class_Viewport_constant_USAGE_2D: + +.. _class_Viewport_constant_USAGE_2D_NO_SAMPLING: + +.. _class_Viewport_constant_USAGE_3D: + +.. _class_Viewport_constant_USAGE_3D_NO_EFFECTS: + enum **Usage**: - **USAGE_2D** = **0** @@ -234,6 +298,12 @@ enum **Usage**: .. _enum_Viewport_ClearMode: +.. _class_Viewport_constant_CLEAR_MODE_ALWAYS: + +.. _class_Viewport_constant_CLEAR_MODE_NEVER: + +.. _class_Viewport_constant_CLEAR_MODE_ONLY_NEXT_FRAME: + enum **ClearMode**: - **CLEAR_MODE_ALWAYS** = **0** --- Always clear the render target before drawing. @@ -267,7 +337,7 @@ Tutorials Property Descriptions --------------------- -.. _class_Viewport_arvr: +.. _class_Viewport_property_arvr: - :ref:`bool` **arvr** @@ -279,7 +349,7 @@ Property Descriptions If ``true``, the viewport will be used in AR/VR process. Default value: ``false``. -.. _class_Viewport_audio_listener_enable_2d: +.. _class_Viewport_property_audio_listener_enable_2d: - :ref:`bool` **audio_listener_enable_2d** @@ -291,7 +361,7 @@ If ``true``, the viewport will be used in AR/VR process. Default value: ``false` If ``true``, the viewport will process 2D audio streams. Default value: ``false``. -.. _class_Viewport_audio_listener_enable_3d: +.. _class_Viewport_property_audio_listener_enable_3d: - :ref:`bool` **audio_listener_enable_3d** @@ -303,7 +373,7 @@ If ``true``, the viewport will process 2D audio streams. Default value: ``false` If ``true``, the viewport will process 3D audio streams. Default value: ``false``. -.. _class_Viewport_canvas_transform: +.. _class_Viewport_property_canvas_transform: - :ref:`Transform2D` **canvas_transform** @@ -315,7 +385,7 @@ If ``true``, the viewport will process 3D audio streams. Default value: ``false` The canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`\ s. This is relative to the global canvas transform of the viewport. -.. _class_Viewport_debug_draw: +.. _class_Viewport_property_debug_draw: - :ref:`DebugDraw` **debug_draw** @@ -327,7 +397,7 @@ The canvas transform of the viewport, useful for changing the on-screen position The overlay mode for test rendered geometry in debug purposes. Default value: ``DEBUG_DRAW_DISABLED``. -.. _class_Viewport_disable_3d: +.. _class_Viewport_property_disable_3d: - :ref:`bool` **disable_3d** @@ -339,7 +409,7 @@ The overlay mode for test rendered geometry in debug purposes. Default value: `` If ``true``, the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. -.. _class_Viewport_global_canvas_transform: +.. _class_Viewport_property_global_canvas_transform: - :ref:`Transform2D` **global_canvas_transform** @@ -351,7 +421,7 @@ If ``true``, the viewport will disable 3D rendering. For actual disabling use `` The global canvas transform of the viewport. The canvas transform is relative to this. -.. _class_Viewport_gui_disable_input: +.. _class_Viewport_property_gui_disable_input: - :ref:`bool` **gui_disable_input** @@ -363,7 +433,7 @@ The global canvas transform of the viewport. The canvas transform is relative to If ``true``, the viewport will not receive input event. Default value: ``false``. -.. _class_Viewport_gui_snap_controls_to_pixels: +.. _class_Viewport_property_gui_snap_controls_to_pixels: - :ref:`bool` **gui_snap_controls_to_pixels** @@ -375,7 +445,7 @@ If ``true``, the viewport will not receive input event. Default value: ``false`` If ``true``, the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. -.. _class_Viewport_handle_input_locally: +.. _class_Viewport_property_handle_input_locally: - :ref:`bool` **handle_input_locally** @@ -385,7 +455,7 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly. Default | *Getter* | is_handling_input_locally() | +----------+---------------------------------+ -.. _class_Viewport_hdr: +.. _class_Viewport_property_hdr: - :ref:`bool` **hdr** @@ -397,7 +467,7 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly. Default If ``true``, the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. -.. _class_Viewport_keep_3d_linear: +.. _class_Viewport_property_keep_3d_linear: - :ref:`bool` **keep_3d_linear** @@ -409,7 +479,7 @@ If ``true``, the viewport rendering will receive benefits from High Dynamic Rang If ``true``, the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. -.. _class_Viewport_msaa: +.. _class_Viewport_property_msaa: - :ref:`MSAA` **msaa** @@ -421,7 +491,7 @@ If ``true``, the result after 3D rendering will not have a linear to sRGB color The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. -.. _class_Viewport_own_world: +.. _class_Viewport_property_own_world: - :ref:`bool` **own_world** @@ -433,7 +503,7 @@ The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. If ``true``, the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. -.. _class_Viewport_physics_object_picking: +.. _class_Viewport_property_physics_object_picking: - :ref:`bool` **physics_object_picking** @@ -445,7 +515,7 @@ If ``true``, the viewport will use :ref:`World` defined in ``world` If ``true``, the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. -.. _class_Viewport_render_target_clear_mode: +.. _class_Viewport_property_render_target_clear_mode: - :ref:`ClearMode` **render_target_clear_mode** @@ -457,7 +527,7 @@ If ``true``, the objects rendered by viewport become subjects of mouse picking p The clear mode when viewport used as a render target. Default value: ``CLEAR_MODE_ALWAYS``. -.. _class_Viewport_render_target_update_mode: +.. _class_Viewport_property_render_target_update_mode: - :ref:`UpdateMode` **render_target_update_mode** @@ -469,7 +539,7 @@ The clear mode when viewport used as a render target. Default value: ``CLEAR_MOD The update mode when viewport used as a render target. Default value: ``UPDATE_WHEN_VISIBLE``. -.. _class_Viewport_render_target_v_flip: +.. _class_Viewport_property_render_target_v_flip: - :ref:`bool` **render_target_v_flip** @@ -481,7 +551,7 @@ The update mode when viewport used as a render target. Default value: ``UPDATE_W If ``true``, the result of rendering will be flipped vertically. Default value: ``false``. -.. _class_Viewport_shadow_atlas_quad_0: +.. _class_Viewport_property_shadow_atlas_quad_0: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** @@ -493,7 +563,7 @@ If ``true``, the result of rendering will be flipped vertically. Default value: The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. -.. _class_Viewport_shadow_atlas_quad_1: +.. _class_Viewport_property_shadow_atlas_quad_1: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** @@ -505,7 +575,7 @@ The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADO The subdivision amount of second quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. -.. _class_Viewport_shadow_atlas_quad_2: +.. _class_Viewport_property_shadow_atlas_quad_2: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** @@ -517,7 +587,7 @@ The subdivision amount of second quadrant on shadow atlas. Default value: ``SHAD The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_16``. -.. _class_Viewport_shadow_atlas_quad_3: +.. _class_Viewport_property_shadow_atlas_quad_3: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** @@ -529,7 +599,7 @@ The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADO The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_64``. -.. _class_Viewport_shadow_atlas_size: +.. _class_Viewport_property_shadow_atlas_size: - :ref:`int` **shadow_atlas_size** @@ -541,7 +611,7 @@ The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHAD The resolution of shadow atlas. Both width and height is equal to one value. -.. _class_Viewport_size: +.. _class_Viewport_property_size: - :ref:`Vector2` **size** @@ -553,7 +623,7 @@ The resolution of shadow atlas. Both width and height is equal to one value. The width and height of viewport. -.. _class_Viewport_transparent_bg: +.. _class_Viewport_property_transparent_bg: - :ref:`bool` **transparent_bg** @@ -565,7 +635,7 @@ The width and height of viewport. If ``true``, the viewport should render its background as transparent. Default value: ``false``. -.. _class_Viewport_usage: +.. _class_Viewport_property_usage: - :ref:`Usage` **usage** @@ -577,7 +647,7 @@ If ``true``, the viewport should render its background as transparent. Default v The rendering mode of viewport. Default value: ``USAGE_3D``. -.. _class_Viewport_world: +.. _class_Viewport_property_world: - :ref:`World` **world** @@ -589,7 +659,7 @@ The rendering mode of viewport. Default value: ``USAGE_3D``. The custom :ref:`World` which can be used as 3D environment source. -.. _class_Viewport_world_2d: +.. _class_Viewport_property_world_2d: - :ref:`World2D` **world_2d** @@ -604,139 +674,139 @@ The custom :ref:`World2D` which can be used as 2D environment sou Method Descriptions ------------------- -.. _class_Viewport_find_world: +.. _class_Viewport_method_find_world: - :ref:`World` **find_world** **(** **)** const Returns the 3D world of the viewport, or if none the world of the parent viewport. -.. _class_Viewport_find_world_2d: +.. _class_Viewport_method_find_world_2d: - :ref:`World2D` **find_world_2d** **(** **)** const Returns the 2D world of the viewport. -.. _class_Viewport_get_camera: +.. _class_Viewport_method_get_camera: - :ref:`Camera` **get_camera** **(** **)** const Returns the active 3D camera. -.. _class_Viewport_get_final_transform: +.. _class_Viewport_method_get_final_transform: - :ref:`Transform2D` **get_final_transform** **(** **)** const Returns the total transform of the viewport. -.. _class_Viewport_get_modal_stack_top: +.. _class_Viewport_method_get_modal_stack_top: - :ref:`Control` **get_modal_stack_top** **(** **)** const Returns the topmost modal in the stack. -.. _class_Viewport_get_mouse_position: +.. _class_Viewport_method_get_mouse_position: - :ref:`Vector2` **get_mouse_position** **(** **)** const Returns the mouse position relative to the viewport. -.. _class_Viewport_get_render_info: +.. _class_Viewport_method_get_render_info: - :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** Returns information about the viewport from the rendering pipeline. -.. _class_Viewport_get_size_override: +.. _class_Viewport_method_get_size_override: - :ref:`Vector2` **get_size_override** **(** **)** const -Returns the size override set with :ref:`set_size_override`. +Returns the size override set with :ref:`set_size_override`. -.. _class_Viewport_get_texture: +.. _class_Viewport_method_get_texture: - :ref:`ViewportTexture` **get_texture** **(** **)** const Returns the viewport's texture. -.. _class_Viewport_get_viewport_rid: +.. _class_Viewport_method_get_viewport_rid: - :ref:`RID` **get_viewport_rid** **(** **)** const Returns the viewport's RID from the :ref:`VisualServer`. -.. _class_Viewport_get_visible_rect: +.. _class_Viewport_method_get_visible_rect: - :ref:`Rect2` **get_visible_rect** **(** **)** const Returns the visible rectangle in global screen coordinates. -.. _class_Viewport_gui_get_drag_data: +.. _class_Viewport_method_gui_get_drag_data: - :ref:`Variant` **gui_get_drag_data** **(** **)** const -Returns the drag data from the GUI, that was previously returned by :ref:`Control.get_drag_data`. +Returns the drag data from the GUI, that was previously returned by :ref:`Control.get_drag_data`. -.. _class_Viewport_gui_has_modal_stack: +.. _class_Viewport_method_gui_has_modal_stack: - :ref:`bool` **gui_has_modal_stack** **(** **)** const Returns ``true`` if there are visible modals on-screen. -.. _class_Viewport_gui_is_dragging: +.. _class_Viewport_method_gui_is_dragging: - :ref:`bool` **gui_is_dragging** **(** **)** const -.. _class_Viewport_input: +.. _class_Viewport_method_input: - void **input** **(** :ref:`InputEvent` local_event **)** -.. _class_Viewport_is_input_handled: +.. _class_Viewport_method_is_input_handled: - :ref:`bool` **is_input_handled** **(** **)** const -.. _class_Viewport_is_size_override_enabled: +.. _class_Viewport_method_is_size_override_enabled: - :ref:`bool` **is_size_override_enabled** **(** **)** const -Returns ``true`` if the size override is enabled. See :ref:`set_size_override`. +Returns ``true`` if the size override is enabled. See :ref:`set_size_override`. -.. _class_Viewport_is_size_override_stretch_enabled: +.. _class_Viewport_method_is_size_override_stretch_enabled: - :ref:`bool` **is_size_override_stretch_enabled** **(** **)** const -Returns ``true`` if the size stretch override is enabled. See :ref:`set_size_override_stretch`. +Returns ``true`` if the size stretch override is enabled. See :ref:`set_size_override_stretch`. -.. _class_Viewport_set_attach_to_screen_rect: +.. _class_Viewport_method_set_attach_to_screen_rect: - void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** -.. _class_Viewport_set_input_as_handled: +.. _class_Viewport_method_set_input_as_handled: - void **set_input_as_handled** **(** **)** -.. _class_Viewport_set_size_override: +.. _class_Viewport_method_set_size_override: - void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** Sets the size override of the viewport. If the ``enable`` parameter is ``true`` the override is used, otherwise it uses the default size. If the size parameter is ``(-1, -1)``, it won't update the size. -.. _class_Viewport_set_size_override_stretch: +.. _class_Viewport_method_set_size_override_stretch: - void **set_size_override_stretch** **(** :ref:`bool` enabled **)** If ``true``, the size override affects stretch as well. -.. _class_Viewport_unhandled_input: +.. _class_Viewport_method_unhandled_input: - void **unhandled_input** **(** :ref:`InputEvent` local_event **)** -.. _class_Viewport_update_worlds: +.. _class_Viewport_method_update_worlds: - void **update_worlds** **(** **)** Forces update of the 2D and 3D worlds. -.. _class_Viewport_warp_mouse: +.. _class_Viewport_method_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index 724fdfab7..c7320b5b6 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -19,11 +19,11 @@ Control for holding :ref:`Viewport`\ s. Properties ---------- -+-------------------------+---------------------------------------------------------------+ -| :ref:`bool` | :ref:`stretch` | -+-------------------------+---------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_shrink` | -+-------------------------+---------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`stretch` | ++-------------------------+------------------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_shrink` | ++-------------------------+------------------------------------------------------------------------+ Description ----------- @@ -33,7 +33,7 @@ A :ref:`Container` node that holds a :ref:`Viewport` **stretch** @@ -45,7 +45,7 @@ Property Descriptions If ``true``, the viewport will be scaled to the control's size. Default value:``false``. -.. _class_ViewportContainer_stretch_shrink: +.. _class_ViewportContainer_property_stretch_shrink: - :ref:`int` **stretch_shrink** diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index e538b0000..0e81b3a0b 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -19,21 +19,21 @@ Texture which displays the content of a :ref:`Viewport`. Properties ---------- -+---------------------------------+-----------------------------------------------------------+ -| :ref:`NodePath` | :ref:`viewport_path` | -+---------------------------------+-----------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`viewport_path` | ++---------------------------------+--------------------------------------------------------------------+ Description ----------- Displays the content of a :ref:`Viewport` node as a dynamic :ref:`Texture`. This can be used to mix controls, 2D, and 3D elements in the same scene. -To create a ViewportTexture in code, use the :ref:`Viewport.get_texture` method on the target viewport. +To create a ViewportTexture in code, use the :ref:`Viewport.get_texture` method on the target viewport. Property Descriptions --------------------- -.. _class_ViewportTexture_viewport_path: +.. _class_ViewportTexture_property_viewport_path: - :ref:`NodePath` **viewport_path** diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index b37a0c68d..a6d365bbb 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -19,17 +19,23 @@ Enable certain nodes only when visible. Properties ---------- -+-------------------------+-------------------------------------------------------------------+ -| :ref:`bool` | :ref:`freeze_bodies` | -+-------------------------+-------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pause_animations` | -+-------------------------+-------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`freeze_bodies` | ++-------------------------+----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pause_animations` | ++-------------------------+----------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisibilityEnabler_Enabler: +.. _class_VisibilityEnabler_constant_ENABLER_PAUSE_ANIMATIONS: + +.. _class_VisibilityEnabler_constant_ENABLER_FREEZE_BODIES: + +.. _class_VisibilityEnabler_constant_ENABLER_MAX: + enum **Enabler**: - **ENABLER_PAUSE_ANIMATIONS** = **0** --- This enabler will pause :ref:`AnimationPlayer` nodes. @@ -46,7 +52,7 @@ The VisibilityEnabler will disable :ref:`RigidBody` and :ref:`A Property Descriptions --------------------- -.. _class_VisibilityEnabler_freeze_bodies: +.. _class_VisibilityEnabler_property_freeze_bodies: - :ref:`bool` **freeze_bodies** @@ -58,7 +64,7 @@ Property Descriptions If ``true``, :ref:`RigidBody` nodes will be paused. -.. _class_VisibilityEnabler_pause_animations: +.. _class_VisibilityEnabler_property_pause_animations: - :ref:`bool` **pause_animations** diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 061d4a3ed..4bb0b351c 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -19,25 +19,39 @@ Enable certain nodes only when visible. Properties ---------- -+-------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`freeze_bodies` | -+-------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pause_animated_sprites` | -+-------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pause_animations` | -+-------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pause_particles` | -+-------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics_process_parent` | -+-------------------------+---------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`process_parent` | -+-------------------------+---------------------------------------------------------------------------------+ ++-------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`freeze_bodies` | ++-------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pause_animated_sprites` | ++-------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pause_animations` | ++-------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pause_particles` | ++-------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics_process_parent` | ++-------------------------+------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`process_parent` | ++-------------------------+------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisibilityEnabler2D_Enabler: +.. _class_VisibilityEnabler2D_constant_ENABLER_PAUSE_ANIMATIONS: + +.. _class_VisibilityEnabler2D_constant_ENABLER_FREEZE_BODIES: + +.. _class_VisibilityEnabler2D_constant_ENABLER_PAUSE_PARTICLES: + +.. _class_VisibilityEnabler2D_constant_ENABLER_PARENT_PROCESS: + +.. _class_VisibilityEnabler2D_constant_ENABLER_PARENT_PHYSICS_PROCESS: + +.. _class_VisibilityEnabler2D_constant_ENABLER_PAUSE_ANIMATED_SPRITES: + +.. _class_VisibilityEnabler2D_constant_ENABLER_MAX: + enum **Enabler**: - **ENABLER_PAUSE_ANIMATIONS** = **0** --- This enabler will pause :ref:`AnimationPlayer` nodes. @@ -62,7 +76,7 @@ The VisibilityEnabler2D will disable :ref:`RigidBody2D`, :ref Property Descriptions --------------------- -.. _class_VisibilityEnabler2D_freeze_bodies: +.. _class_VisibilityEnabler2D_property_freeze_bodies: - :ref:`bool` **freeze_bodies** @@ -74,7 +88,7 @@ Property Descriptions If ``true``, :ref:`RigidBody2D` nodes will be paused. -.. _class_VisibilityEnabler2D_pause_animated_sprites: +.. _class_VisibilityEnabler2D_property_pause_animated_sprites: - :ref:`bool` **pause_animated_sprites** @@ -86,7 +100,7 @@ If ``true``, :ref:`RigidBody2D` nodes will be paused. If ``true``, :ref:`AnimatedSprite` nodes will be paused. -.. _class_VisibilityEnabler2D_pause_animations: +.. _class_VisibilityEnabler2D_property_pause_animations: - :ref:`bool` **pause_animations** @@ -98,7 +112,7 @@ If ``true``, :ref:`AnimatedSprite` nodes will be paused. If ``true``, :ref:`AnimationPlayer` nodes will be paused. -.. _class_VisibilityEnabler2D_pause_particles: +.. _class_VisibilityEnabler2D_property_pause_particles: - :ref:`bool` **pause_particles** @@ -110,7 +124,7 @@ If ``true``, :ref:`AnimationPlayer` nodes will be paused. If ``true``, :ref:`Particles2D` nodes will be paused. -.. _class_VisibilityEnabler2D_physics_process_parent: +.. _class_VisibilityEnabler2D_property_physics_process_parent: - :ref:`bool` **physics_process_parent** @@ -120,9 +134,9 @@ If ``true``, :ref:`Particles2D` nodes will be paused. | *Getter* | is_enabler_enabled() | +----------+----------------------+ -If ``true``, the parent's :ref:`Node._physics_process` will be stopped. +If ``true``, the parent's :ref:`Node._physics_process` will be stopped. -.. _class_VisibilityEnabler2D_process_parent: +.. _class_VisibilityEnabler2D_property_process_parent: - :ref:`bool` **process_parent** @@ -132,5 +146,5 @@ If ``true``, the parent's :ref:`Node._physics_process` will be stopped. +If ``true``, the parent's :ref:`Node._process` will be stopped. diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 630066b90..d96b07e8b 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -21,39 +21,39 @@ Detects when the node is visible on screen. Properties ---------- -+-------------------------+--------------------------------------------+ -| :ref:`AABB` | :ref:`aabb` | -+-------------------------+--------------------------------------------+ ++-------------------------+-----------------------------------------------------+ +| :ref:`AABB` | :ref:`aabb` | ++-------------------------+-----------------------------------------------------+ Methods ------- -+--------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | -+--------------------------+------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | ++-------------------------+-------------------------------------------------------------------------------------+ Signals ------- -.. _class_VisibilityNotifier_camera_entered: +.. _class_VisibilityNotifier_signal_camera_entered: - **camera_entered** **(** :ref:`Camera` camera **)** Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. -.. _class_VisibilityNotifier_camera_exited: +.. _class_VisibilityNotifier_signal_camera_exited: - **camera_exited** **(** :ref:`Camera` camera **)** Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. -.. _class_VisibilityNotifier_screen_entered: +.. _class_VisibilityNotifier_signal_screen_entered: - **screen_entered** **(** **)** Emitted when the VisibilityNotifier enters the screen. -.. _class_VisibilityNotifier_screen_exited: +.. _class_VisibilityNotifier_signal_screen_exited: - **screen_exited** **(** **)** @@ -67,7 +67,7 @@ The VisibilityNotifier detects when it is visible on the screen. It also notifie Property Descriptions --------------------- -.. _class_VisibilityNotifier_aabb: +.. _class_VisibilityNotifier_property_aabb: - :ref:`AABB` **aabb** @@ -82,7 +82,7 @@ The VisibilityNotifier's bounding box. Method Descriptions ------------------- -.. _class_VisibilityNotifier_is_on_screen: +.. _class_VisibilityNotifier_method_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 33e827d25..811a9ddae 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -21,39 +21,39 @@ Detects when the node is visible on screen. Properties ---------- -+---------------------------+----------------------------------------------+ -| :ref:`Rect2` | :ref:`rect` | -+---------------------------+----------------------------------------------+ ++---------------------------+-------------------------------------------------------+ +| :ref:`Rect2` | :ref:`rect` | ++---------------------------+-------------------------------------------------------+ Methods ------- -+--------------------------+--------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | -+--------------------------+--------------------------------------------------------------------------------+ ++-------------------------+---------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_screen` **(** **)** const | ++-------------------------+---------------------------------------------------------------------------------------+ Signals ------- -.. _class_VisibilityNotifier2D_screen_entered: +.. _class_VisibilityNotifier2D_signal_screen_entered: - **screen_entered** **(** **)** Emitted when the VisibilityNotifier2D enters the screen. -.. _class_VisibilityNotifier2D_screen_exited: +.. _class_VisibilityNotifier2D_signal_screen_exited: - **screen_exited** **(** **)** Emitted when the VisibilityNotifier2D exits the screen. -.. _class_VisibilityNotifier2D_viewport_entered: +.. _class_VisibilityNotifier2D_signal_viewport_entered: - **viewport_entered** **(** :ref:`Viewport` viewport **)** Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`'s view. -.. _class_VisibilityNotifier2D_viewport_exited: +.. _class_VisibilityNotifier2D_signal_viewport_exited: - **viewport_exited** **(** :ref:`Viewport` viewport **)** @@ -67,7 +67,7 @@ The VisibilityNotifier2D detects when it is visible on the screen. It also notif Property Descriptions --------------------- -.. _class_VisibilityNotifier2D_rect: +.. _class_VisibilityNotifier2D_property_rect: - :ref:`Rect2` **rect** @@ -82,7 +82,7 @@ The VisibilityNotifier2D's bounding rectangle. Method Descriptions ------------------- -.. _class_VisibilityNotifier2D_is_on_screen: +.. _class_VisibilityNotifier2D_method_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 544c3a2e6..a075dfedf 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -21,29 +21,29 @@ Brief Description Properties ---------- -+-----------------------+--------------------------------------------+ -| :ref:`int` | :ref:`layers` | -+-----------------------+--------------------------------------------+ ++-----------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`layers` | ++-----------------------+-----------------------------------------------------+ Methods ------- -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` layer **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base` **(** :ref:`RID` base **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask_bit` **(** :ref:`int` layer, :ref:`bool` enabled **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` layer **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_base` **(** :ref:`RID` base **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer_mask_bit` **(** :ref:`int` layer, :ref:`bool` enabled **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualInstance_layers: +.. _class_VisualInstance_property_layers: - :ref:`int` **layers** @@ -60,17 +60,17 @@ This object will only be visible for :ref:`Camera`\ s whose cull m Method Descriptions ------------------- -.. _class_VisualInstance_get_aabb: +.. _class_VisualInstance_method_get_aabb: - :ref:`AABB` **get_aabb** **(** **)** const Returns the :ref:`AABB` (also known as the bounding box) for this VisualInstance. -.. _class_VisualInstance_get_layer_mask_bit: +.. _class_VisualInstance_method_get_layer_mask_bit: - :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` layer **)** const -.. _class_VisualInstance_get_transformed_aabb: +.. _class_VisualInstance_method_get_transformed_aabb: - :ref:`AABB` **get_transformed_aabb** **(** **)** const @@ -78,7 +78,7 @@ Returns the transformed :ref:`AABB` (also known as the bounding box) Transformed in this case means the :ref:`AABB` plus the position, rotation, and scale of the :ref:`Spatial`\ s :ref:`Transform` -.. _class_VisualInstance_set_base: +.. _class_VisualInstance_method_set_base: - void **set_base** **(** :ref:`RID` base **)** @@ -86,7 +86,7 @@ Sets the base of the VisualInstance, which changes how the engine handles the Vi It is recommended to only use set_base if you know what you're doing. -.. _class_VisualInstance_set_layer_mask_bit: +.. _class_VisualInstance_method_set_layer_mask_bit: - void **set_layer_mask_bit** **(** :ref:`int` layer, :ref:`bool` enabled **)** diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 244730509..90a358f1c 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -19,96 +19,96 @@ A script implemented in the Visual Script programming environment. Methods ------- -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_function` **(** :ref:`String` name **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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 | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** 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:`Variant` | :ref:`get_variable_default_value` **(** :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:`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_function` **(** :ref:`String` name **)** 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_variable` **(** :ref:`String` name **)** const | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_function` **(** :ref:`String` name **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_variable` **(** :ref:`String` name **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function_scroll` **(** :ref:`String` name, :ref:`Vector2` ofs **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | -+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_function` **(** :ref:`String` name **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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 | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** 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:`Variant` | :ref:`get_variable_default_value` **(** :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:`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_function` **(** :ref:`String` name **)** 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_variable` **(** :ref:`String` name **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_function` **(** :ref:`String` name **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_variable` **(** :ref:`String` name **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function_scroll` **(** :ref:`String` name, :ref:`Vector2` ofs **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_VisualScript_node_ports_changed: +.. _class_VisualScript_signal_node_ports_changed: - **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** @@ -119,7 +119,7 @@ Description A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it. -:ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. +:ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. You are most likely to use this class via the Visual Script editor or when writing plugins for it. @@ -131,257 +131,257 @@ Tutorials Method Descriptions ------------------- -.. _class_VisualScript_add_custom_signal: +.. _class_VisualScript_method_add_custom_signal: - void **add_custom_signal** **(** :ref:`String` name **)** Add a custom signal with the specified name to the VisualScript. -.. _class_VisualScript_add_function: +.. _class_VisualScript_method_add_function: - void **add_function** **(** :ref:`String` name **)** Add a function with the specified name to the VisualScript. -.. _class_VisualScript_add_node: +.. _class_VisualScript_method_add_node: - void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** Add a node to a function of the VisualScript. -.. _class_VisualScript_add_variable: +.. _class_VisualScript_method_add_variable: - void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** Add a variable to the VisualScript, optionally giving it a default value or marking it as exported. -.. _class_VisualScript_custom_signal_add_argument: +.. _class_VisualScript_method_custom_signal_add_argument: - void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** -Add an argument to a custom signal added with :ref:`add_custom_signal`. +Add an argument to a custom signal added with :ref:`add_custom_signal`. -.. _class_VisualScript_custom_signal_get_argument_count: +.. _class_VisualScript_method_custom_signal_get_argument_count: - :ref:`int` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const Get the count of a custom signal's arguments. -.. _class_VisualScript_custom_signal_get_argument_name: +.. _class_VisualScript_method_custom_signal_get_argument_name: - :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** const Get the name of a custom signal's argument. -.. _class_VisualScript_custom_signal_get_argument_type: +.. _class_VisualScript_method_custom_signal_get_argument_type: - :ref:`Variant.Type` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const Get the type of a custom signal's argument. -.. _class_VisualScript_custom_signal_remove_argument: +.. _class_VisualScript_method_custom_signal_remove_argument: - void **custom_signal_remove_argument** **(** :ref:`String` name, :ref:`int` argidx **)** Remove a specific custom signal's argument. -.. _class_VisualScript_custom_signal_set_argument_name: +.. _class_VisualScript_method_custom_signal_set_argument_name: - void **custom_signal_set_argument_name** **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** Rename a custom signal's argument. -.. _class_VisualScript_custom_signal_set_argument_type: +.. _class_VisualScript_method_custom_signal_set_argument_type: - void **custom_signal_set_argument_type** **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** Change the type of a custom signal's argument. -.. _class_VisualScript_custom_signal_swap_argument: +.. _class_VisualScript_method_custom_signal_swap_argument: - void **custom_signal_swap_argument** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** Swap two of the arguments of a custom signal. -.. _class_VisualScript_data_connect: +.. _class_VisualScript_method_data_connect: - void **data_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Connect two data ports. The value of ``from_node``'s ``from_port`` would be fed into ``to_node``'s ``to_port``. -.. _class_VisualScript_data_disconnect: +.. _class_VisualScript_method_data_disconnect: - void **data_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** -Disconnect two data ports previously connected with :ref:`data_connect`. +Disconnect two data ports previously connected with :ref:`data_connect`. -.. _class_VisualScript_get_function_node_id: +.. _class_VisualScript_method_get_function_node_id: - :ref:`int` **get_function_node_id** **(** :ref:`String` name **)** const Returns the id of a function's entry point node. -.. _class_VisualScript_get_function_scroll: +.. _class_VisualScript_method_get_function_scroll: - :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const Returns the position of the center of the screen for a given function. -.. _class_VisualScript_get_node: +.. _class_VisualScript_method_get_node: - :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const Returns a node given its id and its function. -.. _class_VisualScript_get_node_position: +.. _class_VisualScript_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** const Returns a node's position in pixels. -.. _class_VisualScript_get_variable_default_value: +.. _class_VisualScript_method_get_variable_default_value: - :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const Returns the default (initial) value of a variable. -.. _class_VisualScript_get_variable_export: +.. _class_VisualScript_method_get_variable_export: - :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const Returns whether a variable is exported. -.. _class_VisualScript_get_variable_info: +.. _class_VisualScript_method_get_variable_info: - :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** const Returns the info for a given variable as a dictionary. The information includes its name, type, hint and usage. -.. _class_VisualScript_has_custom_signal: +.. _class_VisualScript_method_has_custom_signal: - :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const Returns whether a signal exists with the specified name. -.. _class_VisualScript_has_data_connection: +.. _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 Returns whether the specified data ports are connected. -.. _class_VisualScript_has_function: +.. _class_VisualScript_method_has_function: - :ref:`bool` **has_function** **(** :ref:`String` name **)** const Returns whether a function exists with the specified name. -.. _class_VisualScript_has_node: +.. _class_VisualScript_method_has_node: - :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const Returns whether a node exists with the given id. -.. _class_VisualScript_has_sequence_connection: +.. _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 Returns whether the specified sequence ports are connected. -.. _class_VisualScript_has_variable: +.. _class_VisualScript_method_has_variable: - :ref:`bool` **has_variable** **(** :ref:`String` name **)** const Returns whether a variable exists with the specified name. -.. _class_VisualScript_remove_custom_signal: +.. _class_VisualScript_method_remove_custom_signal: - void **remove_custom_signal** **(** :ref:`String` name **)** Remove a custom signal with the given name. -.. _class_VisualScript_remove_function: +.. _class_VisualScript_method_remove_function: - void **remove_function** **(** :ref:`String` name **)** Remove a specific function and its nodes from the script. -.. _class_VisualScript_remove_node: +.. _class_VisualScript_method_remove_node: - void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** Remove a specific node. -.. _class_VisualScript_remove_variable: +.. _class_VisualScript_method_remove_variable: - void **remove_variable** **(** :ref:`String` name **)** Remove a variable with the given name. -.. _class_VisualScript_rename_custom_signal: +.. _class_VisualScript_method_rename_custom_signal: - void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a custom signal. -.. _class_VisualScript_rename_function: +.. _class_VisualScript_method_rename_function: - void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a function. -.. _class_VisualScript_rename_variable: +.. _class_VisualScript_method_rename_variable: - void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a variable. -.. _class_VisualScript_sequence_connect: +.. _class_VisualScript_method_sequence_connect: - void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** Connect two sequence ports. The execution will flow from of ``from_node``'s ``from_output`` into ``to_node``. -Unlike :ref:`data_connect`, there isn't a ``to_port``, since the target node can have only one sequence port. +Unlike :ref:`data_connect`, there isn't a ``to_port``, since the target node can have only one sequence port. -.. _class_VisualScript_sequence_disconnect: +.. _class_VisualScript_method_sequence_disconnect: - void **sequence_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** -Disconnect two sequence ports previously connected with :ref:`sequence_connect`. +Disconnect two sequence ports previously connected with :ref:`sequence_connect`. -.. _class_VisualScript_set_function_scroll: +.. _class_VisualScript_method_set_function_scroll: - void **set_function_scroll** **(** :ref:`String` name, :ref:`Vector2` ofs **)** Position the center of the screen for a function. -.. _class_VisualScript_set_instance_base_type: +.. _class_VisualScript_method_set_instance_base_type: - void **set_instance_base_type** **(** :ref:`String` type **)** Set the base type of the script. -.. _class_VisualScript_set_node_position: +.. _class_VisualScript_method_set_node_position: - void **set_node_position** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** Position a node on the screen. -.. _class_VisualScript_set_variable_default_value: +.. _class_VisualScript_method_set_variable_default_value: - void **set_variable_default_value** **(** :ref:`String` name, :ref:`Variant` value **)** Change the default (initial) value of a variable. -.. _class_VisualScript_set_variable_export: +.. _class_VisualScript_method_set_variable_export: - void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** Change whether a variable is exported. -.. _class_VisualScript_set_variable_info: +.. _class_VisualScript_method_set_variable_info: - void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)** -Set a variable's info, using the same format as :ref:`get_variable_info`. +Set a variable's info, using the same format as :ref:`get_variable_info`. diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 5651e6fd2..9ee425bc2 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -19,21 +19,21 @@ A Visual Script node representing a constant from the base types. Properties ---------- -+-----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | -+-----------------------------------------------------+-------------------------------------------------------------------+ -| :ref:`String` | :ref:`constant` | -+-----------------------------------------------------+-------------------------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`basic_type` | ++-----------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`String` | :ref:`constant` | ++-----------------------------------------------------+----------------------------------------------------------------------------+ Description ----------- -A Visual Script node representing a constant from base types, such as constant Vector3.AXIS_X. +A Visual Script node representing a constant from base types, such as :ref:`Vector3.AXIS_X`. Property Descriptions --------------------- -.. _class_VisualScriptBasicTypeConstant_basic_type: +.. _class_VisualScriptBasicTypeConstant_property_basic_type: - :ref:`Variant.Type` **basic_type** @@ -45,7 +45,7 @@ Property Descriptions The type to get the constant from. -.. _class_VisualScriptBasicTypeConstant_constant: +.. _class_VisualScriptBasicTypeConstant_property_constant: - :ref:`String` **constant** diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 529b600f7..08edf3e29 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -19,15 +19,143 @@ A Visual Script node used to call built-in functions. Properties ---------- -+--------------------------------------------------------------+---------------------------------------------------------+ -| :ref:`BuiltinFunc` | :ref:`function` | -+--------------------------------------------------------------+---------------------------------------------------------+ ++--------------------------------------------------------------+------------------------------------------------------------------+ +| :ref:`BuiltinFunc` | :ref:`function` | ++--------------------------------------------------------------+------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualScriptBuiltinFunc_BuiltinFunc: +.. _class_VisualScriptBuiltinFunc_constant_MATH_SIN: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_COS: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_TAN: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_SINH: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_COSH: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_TANH: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_ASIN: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_ACOS: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_ATAN: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_ATAN2: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_SQRT: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_FMOD: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_FPOSMOD: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_FLOOR: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_CEIL: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_ROUND: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_ABS: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_SIGN: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_POW: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_LOG: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_EXP: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_ISNAN: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_ISINF: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_EASE: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_DECIMALS: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_STEPIFY: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_LERP: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_INVERSE_LERP: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_RANGE_LERP: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_DECTIME: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_RANDOMIZE: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_RAND: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_RANDF: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_RANDOM: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_SEED: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_RANDSEED: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_DEG2RAD: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_RAD2DEG: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_LINEAR2DB: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_DB2LINEAR: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_POLAR2CARTESIAN: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_CARTESIAN2POLAR: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_WRAP: + +.. _class_VisualScriptBuiltinFunc_constant_MATH_WRAPF: + +.. _class_VisualScriptBuiltinFunc_constant_LOGIC_MAX: + +.. _class_VisualScriptBuiltinFunc_constant_LOGIC_MIN: + +.. _class_VisualScriptBuiltinFunc_constant_LOGIC_CLAMP: + +.. _class_VisualScriptBuiltinFunc_constant_LOGIC_NEAREST_PO2: + +.. _class_VisualScriptBuiltinFunc_constant_OBJ_WEAKREF: + +.. _class_VisualScriptBuiltinFunc_constant_FUNC_FUNCREF: + +.. _class_VisualScriptBuiltinFunc_constant_TYPE_CONVERT: + +.. _class_VisualScriptBuiltinFunc_constant_TYPE_OF: + +.. _class_VisualScriptBuiltinFunc_constant_TYPE_EXISTS: + +.. _class_VisualScriptBuiltinFunc_constant_TEXT_CHAR: + +.. _class_VisualScriptBuiltinFunc_constant_TEXT_STR: + +.. _class_VisualScriptBuiltinFunc_constant_TEXT_PRINT: + +.. _class_VisualScriptBuiltinFunc_constant_TEXT_PRINTERR: + +.. _class_VisualScriptBuiltinFunc_constant_TEXT_PRINTRAW: + +.. _class_VisualScriptBuiltinFunc_constant_VAR_TO_STR: + +.. _class_VisualScriptBuiltinFunc_constant_STR_TO_VAR: + +.. _class_VisualScriptBuiltinFunc_constant_VAR_TO_BYTES: + +.. _class_VisualScriptBuiltinFunc_constant_BYTES_TO_VAR: + +.. _class_VisualScriptBuiltinFunc_constant_COLORN: + +.. _class_VisualScriptBuiltinFunc_constant_FUNC_MAX: + enum **BuiltinFunc**: - **MATH_SIN** = **0** --- Return the sine of the input. @@ -156,7 +284,7 @@ enum **BuiltinFunc**: - **COLORN** = **62** --- Return the :ref:`Color` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. -- **FUNC_MAX** = **63** --- The maximum value the :ref:`function` property can have. +- **FUNC_MAX** = **63** --- The maximum value the :ref:`function` property can have. Description ----------- @@ -168,7 +296,7 @@ See also :ref:`@GDScript`, for the same functions in the GDScri Property Descriptions --------------------- -.. _class_VisualScriptBuiltinFunc_function: +.. _class_VisualScriptBuiltinFunc_property_function: - :ref:`BuiltinFunc` **function** diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index b767115f8..fc4c5454d 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -19,16 +19,16 @@ Gets a constant from a given class. Properties ---------- -+-----------------------------+-------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+-----------------------------+-------------------------------------------------------------+ -| :ref:`String` | :ref:`constant` | -+-----------------------------+-------------------------------------------------------------+ ++-----------------------------+----------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_type` | ++-----------------------------+----------------------------------------------------------------------+ +| :ref:`String` | :ref:`constant` | ++-----------------------------+----------------------------------------------------------------------+ Description ----------- -This node returns a constant from a given class, such as constant @GlobalScope.TYPE_INT. See the given class' documentation for available constants. +This node returns a constant from a given class, such as :ref:`@GlobalScope.TYPE_INT`. See the given class' documentation for available constants. **Input Ports:** @@ -41,7 +41,7 @@ none Property Descriptions --------------------- -.. _class_VisualScriptClassConstant_base_type: +.. _class_VisualScriptClassConstant_property_base_type: - :ref:`String` **base_type** @@ -53,7 +53,7 @@ Property Descriptions The constant's parent class. -.. _class_VisualScriptClassConstant_constant: +.. _class_VisualScriptClassConstant_property_constant: - :ref:`String` **constant** diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index cd1616ce0..8f3dc9f8a 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -19,13 +19,13 @@ A Visual Script node used to annotate the script. Properties ---------- -+-------------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`description` | -+-------------------------------+-----------------------------------------------------------+ -| :ref:`Vector2` | :ref:`size` | -+-------------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`title` | -+-------------------------------+-----------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`description` | ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`size` | ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`title` | ++-------------------------------+--------------------------------------------------------------------+ Description ----------- @@ -37,7 +37,7 @@ Comment nodes can be resized so they encompass a group of nodes. Property Descriptions --------------------- -.. _class_VisualScriptComment_description: +.. _class_VisualScriptComment_property_description: - :ref:`String` **description** @@ -49,7 +49,7 @@ Property Descriptions The text inside the comment node. -.. _class_VisualScriptComment_size: +.. _class_VisualScriptComment_property_size: - :ref:`Vector2` **size** @@ -61,7 +61,7 @@ The text inside the comment node. The comment node's size (in pixels). -.. _class_VisualScriptComment_title: +.. _class_VisualScriptComment_property_title: - :ref:`String` **title** diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 4d0e23aa7..4a964eab1 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -19,11 +19,11 @@ Gets a contant's value. Properties ---------- -+-----------------------------------------------------+------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+------------------------------------------------+ -| :ref:`Variant` | :ref:`value` | -+-----------------------------------------------------+------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+---------------------------------------------------------+ +| :ref:`Variant` | :ref:`value` | ++-----------------------------------------------------+---------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ none Property Descriptions --------------------- -.. _class_VisualScriptConstant_type: +.. _class_VisualScriptConstant_property_type: - :ref:`Variant.Type` **type** @@ -53,7 +53,7 @@ Property Descriptions The constant's type. -.. _class_VisualScriptConstant_value: +.. _class_VisualScriptConstant_property_value: - :ref:`Variant` **value** diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index 1e0577d61..0c28e4970 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -19,15 +19,15 @@ A Visual Script node which calls a base type constructor. Methods ------- -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`get_constructor_type` **(** **)** const | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constructor_type` **(** :ref:`Variant.Type` type **)** | -+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`get_constructor_type` **(** **)** const | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constructor_type` **(** :ref:`Variant.Type` type **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -37,19 +37,19 @@ A Visual Script node which calls a base type constructor. It can be used for typ Method Descriptions ------------------- -.. _class_VisualScriptConstructor_get_constructor: +.. _class_VisualScriptConstructor_method_get_constructor: - :ref:`Dictionary` **get_constructor** **(** **)** const -.. _class_VisualScriptConstructor_get_constructor_type: +.. _class_VisualScriptConstructor_method_get_constructor_type: - :ref:`Variant.Type` **get_constructor_type** **(** **)** const -.. _class_VisualScriptConstructor_set_constructor: +.. _class_VisualScriptConstructor_method_set_constructor: - void **set_constructor** **(** :ref:`Dictionary` constructor **)** -.. _class_VisualScriptConstructor_set_constructor_type: +.. _class_VisualScriptConstructor_method_set_constructor_type: - void **set_constructor_type** **(** :ref:`Variant.Type` type **)** diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index bf465b6e4..9c5b9ce44 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -19,63 +19,79 @@ A scripted Visual Script node. 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 ------------ .. _enum_VisualScriptCustomNode_StartMode: +.. _class_VisualScriptCustomNode_constant_START_MODE_BEGIN_SEQUENCE: + +.. _class_VisualScriptCustomNode_constant_START_MODE_CONTINUE_SEQUENCE: + +.. _class_VisualScriptCustomNode_constant_START_MODE_RESUME_YIELD: + enum **StartMode**: -- **START_MODE_BEGIN_SEQUENCE** = **0** --- The start mode used the first time when :ref:`_step` is called. +- **START_MODE_BEGIN_SEQUENCE** = **0** --- The start mode used the first time when :ref:`_step` is called. -- **START_MODE_CONTINUE_SEQUENCE** = **1** --- The start mode used when :ref:`_step` is called after coming back from a STEP_PUSH_STACK_BIT. +- **START_MODE_CONTINUE_SEQUENCE** = **1** --- The start mode used when :ref:`_step` is called after coming back from a STEP_PUSH_STACK_BIT. -- **START_MODE_RESUME_YIELD** = **2** --- The start mode used when :ref:`_step` is called after resuming from STEP_YIELD_BIT. +- **START_MODE_RESUME_YIELD** = **2** --- The start mode used when :ref:`_step` is called after resuming from STEP_YIELD_BIT. Constants --------- -- **STEP_PUSH_STACK_BIT** = **16777216** --- Hint used by :ref:`_step` to tell that control should return to it when there is no other node left to execute. +.. _class_VisualScriptCustomNode_constant_STEP_PUSH_STACK_BIT: + +.. _class_VisualScriptCustomNode_constant_STEP_GO_BACK_BIT: + +.. _class_VisualScriptCustomNode_constant_STEP_NO_ADVANCE_BIT: + +.. _class_VisualScriptCustomNode_constant_STEP_EXIT_FUNCTION_BIT: + +.. _class_VisualScriptCustomNode_constant_STEP_YIELD_BIT: + +- **STEP_PUSH_STACK_BIT** = **16777216** --- Hint used by :ref:`_step` to tell that control should return to it when there is no other node left to execute. This is used by :ref:`VisualScriptCondition` to redirect the sequence to the "Done" port after the true/false branch has finished execution. -- **STEP_GO_BACK_BIT** = **33554432** --- Hint used by :ref:`_step` to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function. +- **STEP_GO_BACK_BIT** = **33554432** --- Hint used by :ref:`_step` to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function. - **STEP_NO_ADVANCE_BIT** = **67108864** -- **STEP_EXIT_FUNCTION_BIT** = **134217728** --- Hint used by :ref:`_step` to tell that control should stop and exit the function. +- **STEP_EXIT_FUNCTION_BIT** = **134217728** --- Hint used by :ref:`_step` to tell that control should stop and exit the function. -- **STEP_YIELD_BIT** = **268435456** --- Hint used by :ref:`_step` to tell that the function should be yielded. +- **STEP_YIELD_BIT** = **268435456** --- Hint used by :ref:`_step` to tell that the function should be yielded. Using this requires you to have at least one working memory slot, which is used for the :ref:`VisualScriptFunctionState`. @@ -87,85 +103,85 @@ A custom Visual Script node which can be scripted in powerful ways. Method Descriptions ------------------- -.. _class_VisualScriptCustomNode__get_caption: +.. _class_VisualScriptCustomNode_method__get_caption: - :ref:`String` **_get_caption** **(** **)** virtual Return the node's title. -.. _class_VisualScriptCustomNode__get_category: +.. _class_VisualScriptCustomNode_method__get_category: - :ref:`String` **_get_category** **(** **)** virtual Return the node's category. -.. _class_VisualScriptCustomNode__get_input_value_port_count: +.. _class_VisualScriptCustomNode_method__get_input_value_port_count: - :ref:`int` **_get_input_value_port_count** **(** **)** virtual Return the count of input value ports. -.. _class_VisualScriptCustomNode__get_input_value_port_name: +.. _class_VisualScriptCustomNode_method__get_input_value_port_name: - :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified input port's name. -.. _class_VisualScriptCustomNode__get_input_value_port_type: +.. _class_VisualScriptCustomNode_method__get_input_value_port_type: - :ref:`int` **_get_input_value_port_type** **(** :ref:`int` idx **)** virtual Return the specified input port's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. -.. _class_VisualScriptCustomNode__get_output_sequence_port_count: +.. _class_VisualScriptCustomNode_method__get_output_sequence_port_count: - :ref:`int` **_get_output_sequence_port_count** **(** **)** virtual Return the amount of output **sequence** ports. -.. _class_VisualScriptCustomNode__get_output_sequence_port_text: +.. _class_VisualScriptCustomNode_method__get_output_sequence_port_text: - :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** virtual Return the specified **sequence** output's name. -.. _class_VisualScriptCustomNode__get_output_value_port_count: +.. _class_VisualScriptCustomNode_method__get_output_value_port_count: - :ref:`int` **_get_output_value_port_count** **(** **)** virtual Return the amount of output value ports. -.. _class_VisualScriptCustomNode__get_output_value_port_name: +.. _class_VisualScriptCustomNode_method__get_output_value_port_name: - :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified output's name. -.. _class_VisualScriptCustomNode__get_output_value_port_type: +.. _class_VisualScriptCustomNode_method__get_output_value_port_type: - :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** virtual Return the specified output's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. -.. _class_VisualScriptCustomNode__get_text: +.. _class_VisualScriptCustomNode_method__get_text: - :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). -.. _class_VisualScriptCustomNode__get_working_memory_size: +.. _class_VisualScriptCustomNode_method__get_working_memory_size: - :ref:`int` **_get_working_memory_size** **(** **)** virtual -Return the size of the custom node's working memory. See :ref:`_step` for more details. +Return the size of the custom node's working memory. See :ref:`_step` for more details. -.. _class_VisualScriptCustomNode__has_input_sequence_port: +.. _class_VisualScriptCustomNode_method__has_input_sequence_port: - :ref:`bool` **_has_input_sequence_port** **(** **)** virtual Return whether the custom node has an input **sequence** port. -.. _class_VisualScriptCustomNode__step: +.. _class_VisualScriptCustomNode_method__step: - :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index ae920ffd4..412f5a808 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -19,9 +19,9 @@ A Visual Script node which deconstructs a base type instance into its parts. Properties ---------- -+-----------------------------------------------------+-------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+-------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+----------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ A Visual Script node which deconstructs a base type instance into its parts. Property Descriptions --------------------- -.. _class_VisualScriptDeconstruct_type: +.. _class_VisualScriptDeconstruct_property_type: - :ref:`Variant.Type` **type** diff --git a/classes/class_visualscripteditor.rst b/classes/class_visualscripteditor.rst index 3b81e9f50..574451b65 100644 --- a/classes/class_visualscripteditor.rst +++ b/classes/class_visualscripteditor.rst @@ -19,16 +19,16 @@ Brief Description Methods ------- -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_node` **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_node` **(** :ref:`String` name, :ref:`String` category **)** | -+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_node` **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** | ++------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_node` **(** :ref:`String` name, :ref:`String` category **)** | ++------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_VisualScriptEditor_custom_nodes_updated: +.. _class_VisualScriptEditor_signal_custom_nodes_updated: - **custom_nodes_updated** **(** **)** @@ -37,13 +37,13 @@ Emitted when a custom Visual Script node is added or removed. Method Descriptions ------------------- -.. _class_VisualScriptEditor_add_custom_node: +.. _class_VisualScriptEditor_method_add_custom_node: - void **add_custom_node** **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the ``category`` as the parameter. -.. _class_VisualScriptEditor_remove_custom_node: +.. _class_VisualScriptEditor_method_remove_custom_node: - void **remove_custom_node** **(** :ref:`String` name, :ref:`String` category **)** diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 5e23a0cf3..60f97aeb5 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -19,9 +19,9 @@ Emits a specified signal. Properties ---------- -+-----------------------------+----------------------------------------------------+ -| :ref:`String` | :ref:`signal` | -+-----------------------------+----------------------------------------------------+ ++-----------------------------+-------------------------------------------------------------+ +| :ref:`String` | :ref:`signal` | ++-----------------------------+-------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ Emits a specified signal when it is executed. Property Descriptions --------------------- -.. _class_VisualScriptEmitSignal_signal: +.. _class_VisualScriptEmitSignal_property_signal: - :ref:`String` **signal** diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 3fea58a98..2dd05d343 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -19,9 +19,9 @@ A Visual Script node returning a singleton from :ref:`@GlobalScope` | :ref:`constant` | -+-----------------------------+-------------------------------------------------------------+ ++-----------------------------+----------------------------------------------------------------------+ +| :ref:`String` | :ref:`constant` | ++-----------------------------+----------------------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ A Visual Script node returning a singleton from :ref:`@GlobalScope` **constant** diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 4e5c1fb16..38b4ea468 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -19,33 +19,43 @@ Brief Description Properties ---------- -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_script` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`CallMode` | :ref:`call_mode` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`function` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`RPCCallMode` | :ref:`rpc_call_mode` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`String` | :ref:`singleton` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`int` | :ref:`use_default_args` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`validate` | -+---------------------------------------------------------------+--------------------------------------------------------------------------+ ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_script` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_type` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`basic_type` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`CallMode` | :ref:`call_mode` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`function` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`node_path` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`RPCCallMode` | :ref:`rpc_call_mode` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`singleton` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`use_default_args` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`validate` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualScriptFunctionCall_CallMode: +.. _class_VisualScriptFunctionCall_constant_CALL_MODE_SELF: + +.. _class_VisualScriptFunctionCall_constant_CALL_MODE_NODE_PATH: + +.. _class_VisualScriptFunctionCall_constant_CALL_MODE_INSTANCE: + +.. _class_VisualScriptFunctionCall_constant_CALL_MODE_BASIC_TYPE: + +.. _class_VisualScriptFunctionCall_constant_CALL_MODE_SINGLETON: + enum **CallMode**: - **CALL_MODE_SELF** = **0** @@ -60,6 +70,16 @@ enum **CallMode**: .. _enum_VisualScriptFunctionCall_RPCCallMode: +.. _class_VisualScriptFunctionCall_constant_RPC_DISABLED: + +.. _class_VisualScriptFunctionCall_constant_RPC_RELIABLE: + +.. _class_VisualScriptFunctionCall_constant_RPC_UNRELIABLE: + +.. _class_VisualScriptFunctionCall_constant_RPC_RELIABLE_TO_ID: + +.. _class_VisualScriptFunctionCall_constant_RPC_UNRELIABLE_TO_ID: + enum **RPCCallMode**: - **RPC_DISABLED** = **0** @@ -75,7 +95,7 @@ enum **RPCCallMode**: Property Descriptions --------------------- -.. _class_VisualScriptFunctionCall_base_script: +.. _class_VisualScriptFunctionCall_property_base_script: - :ref:`String` **base_script** @@ -85,7 +105,7 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ -.. _class_VisualScriptFunctionCall_base_type: +.. _class_VisualScriptFunctionCall_property_base_type: - :ref:`String` **base_type** @@ -95,7 +115,7 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ -.. _class_VisualScriptFunctionCall_basic_type: +.. _class_VisualScriptFunctionCall_property_basic_type: - :ref:`Variant.Type` **basic_type** @@ -105,7 +125,7 @@ Property Descriptions | *Getter* | get_basic_type() | +----------+-----------------------+ -.. _class_VisualScriptFunctionCall_call_mode: +.. _class_VisualScriptFunctionCall_property_call_mode: - :ref:`CallMode` **call_mode** @@ -115,7 +135,7 @@ Property Descriptions | *Getter* | get_call_mode() | +----------+----------------------+ -.. _class_VisualScriptFunctionCall_function: +.. _class_VisualScriptFunctionCall_property_function: - :ref:`String` **function** @@ -125,7 +145,7 @@ Property Descriptions | *Getter* | get_function() | +----------+---------------------+ -.. _class_VisualScriptFunctionCall_node_path: +.. _class_VisualScriptFunctionCall_property_node_path: - :ref:`NodePath` **node_path** @@ -135,7 +155,7 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ -.. _class_VisualScriptFunctionCall_rpc_call_mode: +.. _class_VisualScriptFunctionCall_property_rpc_call_mode: - :ref:`RPCCallMode` **rpc_call_mode** @@ -145,7 +165,7 @@ Property Descriptions | *Getter* | get_rpc_call_mode() | +----------+--------------------------+ -.. _class_VisualScriptFunctionCall_singleton: +.. _class_VisualScriptFunctionCall_property_singleton: - :ref:`String` **singleton** @@ -155,7 +175,7 @@ Property Descriptions | *Getter* | get_singleton() | +----------+----------------------+ -.. _class_VisualScriptFunctionCall_use_default_args: +.. _class_VisualScriptFunctionCall_property_use_default_args: - :ref:`int` **use_default_args** @@ -165,7 +185,7 @@ Property Descriptions | *Getter* | get_use_default_args() | +----------+-----------------------------+ -.. _class_VisualScriptFunctionCall_validate: +.. _class_VisualScriptFunctionCall_property_validate: - :ref:`bool` **validate** diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index 64a160657..2e08a10cb 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -19,26 +19,26 @@ Brief Description Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_to_signal` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`resume` **(** :ref:`Array` args=null **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_to_signal` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`resume` **(** :ref:`Array` args=null **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_VisualScriptFunctionState_connect_to_signal: +.. _class_VisualScriptFunctionState_method_connect_to_signal: - void **connect_to_signal** **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** -.. _class_VisualScriptFunctionState_is_valid: +.. _class_VisualScriptFunctionState_method_is_valid: - :ref:`bool` **is_valid** **(** **)** const -.. _class_VisualScriptFunctionState_resume: +.. _class_VisualScriptFunctionState_method_resume: - :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 9d79e00ad..62bfe2a00 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-----------------------+------------------------------------------------------------+ -| :ref:`int` | :ref:`constant` | -+-----------------------+------------------------------------------------------------+ ++-----------------------+---------------------------------------------------------------------+ +| :ref:`int` | :ref:`constant` | ++-----------------------+---------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualScriptGlobalConstant_constant: +.. _class_VisualScriptGlobalConstant_property_constant: - :ref:`int` **constant** diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index f428280d5..2911cdad5 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -19,17 +19,25 @@ Brief Description Properties ---------- -+------------------------------------------------+-----------------------------------------------------+ -| :ref:`String` | :ref:`action` | -+------------------------------------------------+-----------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | -+------------------------------------------------+-----------------------------------------------------+ ++------------------------------------------------+--------------------------------------------------------------+ +| :ref:`String` | :ref:`action` | ++------------------------------------------------+--------------------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++------------------------------------------------+--------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualScriptInputAction_Mode: +.. _class_VisualScriptInputAction_constant_MODE_PRESSED: + +.. _class_VisualScriptInputAction_constant_MODE_RELEASED: + +.. _class_VisualScriptInputAction_constant_MODE_JUST_PRESSED: + +.. _class_VisualScriptInputAction_constant_MODE_JUST_RELEASED: + enum **Mode**: - **MODE_PRESSED** = **0** @@ -43,7 +51,7 @@ enum **Mode**: Property Descriptions --------------------- -.. _class_VisualScriptInputAction_action: +.. _class_VisualScriptInputAction_property_action: - :ref:`String` **action** @@ -53,7 +61,7 @@ Property Descriptions | *Getter* | get_action_name() | +----------+------------------------+ -.. _class_VisualScriptInputAction_mode: +.. _class_VisualScriptInputAction_property_mode: - :ref:`Mode` **mode** diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 26b979353..921a9b1b6 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -19,11 +19,11 @@ Gets a local variable's value. Properties ---------- -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+------------------------------------------------------+ -| :ref:`String` | :ref:`var_name` | -+-----------------------------------------------------+------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+---------------------------------------------------------------+ +| :ref:`String` | :ref:`var_name` | ++-----------------------------------------------------+---------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ none Property Descriptions --------------------- -.. _class_VisualScriptLocalVar_type: +.. _class_VisualScriptLocalVar_property_type: - :ref:`Variant.Type` **type** @@ -53,7 +53,7 @@ Property Descriptions The local variable's type. -.. _class_VisualScriptLocalVar_var_name: +.. _class_VisualScriptLocalVar_property_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index e177cbbf0..07d3e8937 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -19,11 +19,11 @@ Changes a local variable's value. Properties ---------- -+-----------------------------------------------------+---------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+---------------------------------------------------------+ -| :ref:`String` | :ref:`var_name` | -+-----------------------------------------------------+---------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+------------------------------------------------------------------+ +| :ref:`String` | :ref:`var_name` | ++-----------------------------------------------------+------------------------------------------------------------------+ Description ----------- @@ -45,7 +45,7 @@ Changes a local variable's value to the given input. The new value is also provi Property Descriptions --------------------- -.. _class_VisualScriptLocalVarSet_type: +.. _class_VisualScriptLocalVarSet_property_type: - :ref:`Variant.Type` **type** @@ -57,7 +57,7 @@ Property Descriptions The local variable's type. -.. _class_VisualScriptLocalVarSet_var_name: +.. _class_VisualScriptLocalVarSet_property_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 336e12937..afbc9d436 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -19,15 +19,33 @@ Commonly used mathematical constants. Properties ---------- -+-----------------------------------------------------------------+----------------------------------------------------------+ -| :ref:`MathConstant` | :ref:`constant` | -+-----------------------------------------------------------------+----------------------------------------------------------+ ++-----------------------------------------------------------------+-------------------------------------------------------------------+ +| :ref:`MathConstant` | :ref:`constant` | ++-----------------------------------------------------------------+-------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualScriptMathConstant_MathConstant: +.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_ONE: + +.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_PI: + +.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_HALF_PI: + +.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_TAU: + +.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_E: + +.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_SQRT2: + +.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_INF: + +.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_NAN: + +.. _class_VisualScriptMathConstant_constant_MATH_CONSTANT_MAX: + enum **MathConstant**: - **MATH_CONSTANT_ONE** = **0** --- Unity: ``1`` @@ -64,7 +82,7 @@ none Property Descriptions --------------------- -.. _class_VisualScriptMathConstant_constant: +.. _class_VisualScriptMathConstant_property_constant: - :ref:`MathConstant` **constant** diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 2ba3c18f5..658f49f43 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -21,20 +21,20 @@ A node which is part of a :ref:`VisualScript`. Methods ------- -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_default_input_value` **(** :ref:`int` port_idx **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualScript` | :ref:`get_visual_script` **(** **)** const | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ports_changed_notify` **(** **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_input_value` **(** :ref:`int` port_idx, :ref:`Variant` value **)** | -+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_default_input_value` **(** :ref:`int` port_idx **)** const | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VisualScript` | :ref:`get_visual_script` **(** **)** const | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ports_changed_notify` **(** **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_input_value` **(** :ref:`int` port_idx, :ref:`Variant` value **)** | ++-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_VisualScriptNode_ports_changed: +.. _class_VisualScriptNode_signal_ports_changed: - **ports_changed** **(** **)** @@ -48,25 +48,25 @@ A node which is part of a :ref:`VisualScript`. Not to be con Method Descriptions ------------------- -.. _class_VisualScriptNode_get_default_input_value: +.. _class_VisualScriptNode_method_get_default_input_value: - :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. -.. _class_VisualScriptNode_get_visual_script: +.. _class_VisualScriptNode_method_get_visual_script: - :ref:`VisualScript` **get_visual_script** **(** **)** const Returns the :ref:`VisualScript` instance the node is bound to. -.. _class_VisualScriptNode_ports_changed_notify: +.. _class_VisualScriptNode_method_ports_changed_notify: - void **ports_changed_notify** **(** **)** Notify that the node's ports have changed. Usually used in conjunction with :ref:`VisualScriptCustomNode` . -.. _class_VisualScriptNode_set_default_input_value: +.. _class_VisualScriptNode_method_set_default_input_value: - void **set_default_input_value** **(** :ref:`int` port_idx, :ref:`Variant` value **)** diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 9578b3230..151f2c16c 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -19,11 +19,11 @@ Brief Description Properties ---------- -+-------------------------------------------------------------+------------------------------------------------------+ -| :ref:`Variant.Operator` | :ref:`operator` | -+-------------------------------------------------------------+------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-------------------------------------------------------------+------------------------------------------------------+ ++-------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Variant.Operator` | :ref:`operator` | ++-------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-------------------------------------------------------------+---------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ Description Property Descriptions --------------------- -.. _class_VisualScriptOperator_operator: +.. _class_VisualScriptOperator_property_operator: - :ref:`Variant.Operator` **operator** @@ -51,7 +51,7 @@ Property Descriptions | *Getter* | get_operator() | +----------+---------------------+ -.. _class_VisualScriptOperator_type: +.. _class_VisualScriptOperator_property_type: - :ref:`Variant.Type` **type** diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index 37ce6fd96..b002a748c 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -19,9 +19,9 @@ Creates a new :ref:`Resource` or loads one from the filesystem. Properties ---------- -+---------------------------------+-----------------------------------------------------+ -| :ref:`Resource` | :ref:`resource` | -+---------------------------------+-----------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------+ +| :ref:`Resource` | :ref:`resource` | ++---------------------------------+--------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ none Property Descriptions --------------------- -.. _class_VisualScriptPreload_resource: +.. _class_VisualScriptPreload_property_resource: - :ref:`Resource` **resource** diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 106f07a72..5c87d0861 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -19,27 +19,33 @@ Brief Description Properties ---------- -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`base_script` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`index` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`property` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`CallMode` | :ref:`set_mode` | -+--------------------------------------------------------+---------------------------------------------------------------+ ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_script` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_type` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`basic_type` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`index` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`node_path` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`property` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`CallMode` | :ref:`set_mode` | ++--------------------------------------------------------+------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualScriptPropertyGet_CallMode: +.. _class_VisualScriptPropertyGet_constant_CALL_MODE_SELF: + +.. _class_VisualScriptPropertyGet_constant_CALL_MODE_NODE_PATH: + +.. _class_VisualScriptPropertyGet_constant_CALL_MODE_INSTANCE: + enum **CallMode**: - **CALL_MODE_SELF** = **0** @@ -51,7 +57,7 @@ enum **CallMode**: Property Descriptions --------------------- -.. _class_VisualScriptPropertyGet_base_script: +.. _class_VisualScriptPropertyGet_property_base_script: - :ref:`String` **base_script** @@ -61,7 +67,7 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ -.. _class_VisualScriptPropertyGet_base_type: +.. _class_VisualScriptPropertyGet_property_base_type: - :ref:`String` **base_type** @@ -71,7 +77,7 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ -.. _class_VisualScriptPropertyGet_basic_type: +.. _class_VisualScriptPropertyGet_property_basic_type: - :ref:`Variant.Type` **basic_type** @@ -81,7 +87,7 @@ Property Descriptions | *Getter* | get_basic_type() | +----------+-----------------------+ -.. _class_VisualScriptPropertyGet_index: +.. _class_VisualScriptPropertyGet_property_index: - :ref:`String` **index** @@ -91,7 +97,7 @@ Property Descriptions | *Getter* | get_index() | +----------+------------------+ -.. _class_VisualScriptPropertyGet_node_path: +.. _class_VisualScriptPropertyGet_property_node_path: - :ref:`NodePath` **node_path** @@ -101,7 +107,7 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ -.. _class_VisualScriptPropertyGet_property: +.. _class_VisualScriptPropertyGet_property_property: - :ref:`String` **property** @@ -111,7 +117,7 @@ Property Descriptions | *Getter* | get_property() | +----------+---------------------+ -.. _class_VisualScriptPropertyGet_set_mode: +.. _class_VisualScriptPropertyGet_property_set_mode: - :ref:`CallMode` **set_mode** diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index cd842636f..173260934 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -19,29 +19,37 @@ Brief Description Properties ---------- -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`AssignOp` | :ref:`assign_op` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`base_script` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`index` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`String` | :ref:`property` | -+--------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`CallMode` | :ref:`set_mode` | -+--------------------------------------------------------+---------------------------------------------------------------+ ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`AssignOp` | :ref:`assign_op` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_script` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_type` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`basic_type` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`index` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`node_path` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`property` | ++--------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`CallMode` | :ref:`set_mode` | ++--------------------------------------------------------+------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualScriptPropertySet_CallMode: +.. _class_VisualScriptPropertySet_constant_CALL_MODE_SELF: + +.. _class_VisualScriptPropertySet_constant_CALL_MODE_NODE_PATH: + +.. _class_VisualScriptPropertySet_constant_CALL_MODE_INSTANCE: + +.. _class_VisualScriptPropertySet_constant_CALL_MODE_BASIC_TYPE: + enum **CallMode**: - **CALL_MODE_SELF** = **0** @@ -54,6 +62,28 @@ enum **CallMode**: .. _enum_VisualScriptPropertySet_AssignOp: +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_NONE: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_ADD: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_SUB: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_MUL: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_DIV: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_MOD: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_SHIFT_LEFT: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_SHIFT_RIGHT: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_BIT_AND: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_BIT_OR: + +.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_BIT_XOR: + enum **AssignOp**: - **ASSIGN_OP_NONE** = **0** @@ -81,7 +111,7 @@ enum **AssignOp**: Property Descriptions --------------------- -.. _class_VisualScriptPropertySet_assign_op: +.. _class_VisualScriptPropertySet_property_assign_op: - :ref:`AssignOp` **assign_op** @@ -91,7 +121,7 @@ Property Descriptions | *Getter* | get_assign_op() | +----------+----------------------+ -.. _class_VisualScriptPropertySet_base_script: +.. _class_VisualScriptPropertySet_property_base_script: - :ref:`String` **base_script** @@ -101,7 +131,7 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ -.. _class_VisualScriptPropertySet_base_type: +.. _class_VisualScriptPropertySet_property_base_type: - :ref:`String` **base_type** @@ -111,7 +141,7 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ -.. _class_VisualScriptPropertySet_basic_type: +.. _class_VisualScriptPropertySet_property_basic_type: - :ref:`Variant.Type` **basic_type** @@ -121,7 +151,7 @@ Property Descriptions | *Getter* | get_basic_type() | +----------+-----------------------+ -.. _class_VisualScriptPropertySet_index: +.. _class_VisualScriptPropertySet_property_index: - :ref:`String` **index** @@ -131,7 +161,7 @@ Property Descriptions | *Getter* | get_index() | +----------+------------------+ -.. _class_VisualScriptPropertySet_node_path: +.. _class_VisualScriptPropertySet_property_node_path: - :ref:`NodePath` **node_path** @@ -141,7 +171,7 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ -.. _class_VisualScriptPropertySet_property: +.. _class_VisualScriptPropertySet_property_property: - :ref:`String` **property** @@ -151,7 +181,7 @@ Property Descriptions | *Getter* | get_property() | +----------+---------------------+ -.. _class_VisualScriptPropertySet_set_mode: +.. _class_VisualScriptPropertySet_property_set_mode: - :ref:`CallMode` **set_mode** diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index 64bd7a91f..63bfc9812 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-----------------------------+--------------------------------------------------+ -| :ref:`String` | :ref:`path` | -+-----------------------------+--------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------+ +| :ref:`String` | :ref:`path` | ++-----------------------------+-----------------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualScriptResourcePath_path: +.. _class_VisualScriptResourcePath_property_path: - :ref:`String` **path** diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index a3413dc4f..a2acf5553 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -19,11 +19,11 @@ Exits a function and returns an optional value. Properties ---------- -+-----------------------------------------------------+----------------------------------------------------------------+ -| :ref:`bool` | :ref:`return_enabled` | -+-----------------------------------------------------+----------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`return_type` | -+-----------------------------------------------------+----------------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`return_enabled` | ++-----------------------------------------------------+-------------------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`return_type` | ++-----------------------------------------------------+-------------------------------------------------------------------------+ Description ----------- @@ -43,7 +43,7 @@ none Property Descriptions --------------------- -.. _class_VisualScriptReturn_return_enabled: +.. _class_VisualScriptReturn_property_return_enabled: - :ref:`bool` **return_enabled** @@ -55,7 +55,7 @@ Property Descriptions If ``true``, the ``return`` input port is available. -.. _class_VisualScriptReturn_return_type: +.. _class_VisualScriptReturn_property_return_type: - :ref:`Variant.Type` **return_type** diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index 3b5e7f689..2412e8dff 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -19,9 +19,9 @@ Node reference. Properties ---------- -+---------------------------------+---------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+---------------------------------+---------------------------------------------------------+ ++---------------------------------+------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`node_path` | ++---------------------------------+------------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ none Property Descriptions --------------------- -.. _class_VisualScriptSceneNode_node_path: +.. _class_VisualScriptSceneNode_property_node_path: - :ref:`NodePath` **node_path** diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index 897879717..e34906e5b 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -19,9 +19,9 @@ Chooses between two input values. Properties ---------- -+-----------------------------------------------------+--------------------------------------------+ -| :ref:`Variant.Type` | :ref:`type` | -+-----------------------------------------------------+--------------------------------------------+ ++-----------------------------------------------------+-----------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+-----------------------------------------------------+ Description ----------- @@ -43,7 +43,7 @@ Chooses between two input values based on a Boolean condition. Property Descriptions --------------------- -.. _class_VisualScriptSelect_type: +.. _class_VisualScriptSelect_property_type: - :ref:`Variant.Type` **type** diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index d2c3a5946..d75bfd49d 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -19,9 +19,9 @@ Executes a series of Sequence ports. Properties ---------- -+-----------------------+------------------------------------------------+ -| :ref:`int` | :ref:`steps` | -+-----------------------+------------------------------------------------+ ++-----------------------+---------------------------------------------------------+ +| :ref:`int` | :ref:`steps` | ++-----------------------+---------------------------------------------------------+ Description ----------- @@ -43,7 +43,7 @@ Steps through a series of one or more output Sequence ports. The ``current`` dat Property Descriptions --------------------- -.. _class_VisualScriptSequence_steps: +.. _class_VisualScriptSequence_property_steps: - :ref:`int` **steps** diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index cbf04a2d2..6b56b2055 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -19,14 +19,14 @@ Brief Description Methods ------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_VisualScriptSubCall__subcall: +.. _class_VisualScriptSubCall_method__subcall: - :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** virtual diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 7dd7b4c5d..5f5ba69ad 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -19,16 +19,16 @@ Brief Description Properties ---------- -+-----------------------------+------------------------------------------------------------+ -| :ref:`String` | :ref:`base_script` | -+-----------------------------+------------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+-----------------------------+------------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_script` | ++-----------------------------+---------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_type` | ++-----------------------------+---------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualScriptTypeCast_base_script: +.. _class_VisualScriptTypeCast_property_base_script: - :ref:`String` **base_script** @@ -38,7 +38,7 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ -.. _class_VisualScriptTypeCast_base_type: +.. _class_VisualScriptTypeCast_property_base_type: - :ref:`String` **base_type** diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 7c7232f7c..9ba84d0e8 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -19,9 +19,9 @@ Gets a variable's value. Properties ---------- -+-----------------------------+---------------------------------------------------------+ -| :ref:`String` | :ref:`var_name` | -+-----------------------------+---------------------------------------------------------+ ++-----------------------------+------------------------------------------------------------------+ +| :ref:`String` | :ref:`var_name` | ++-----------------------------+------------------------------------------------------------------+ Description ----------- @@ -39,7 +39,7 @@ none Property Descriptions --------------------- -.. _class_VisualScriptVariableGet_var_name: +.. _class_VisualScriptVariableGet_property_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index dc57b234b..f819ddba6 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -19,9 +19,9 @@ Changes a variable's value. Properties ---------- -+-----------------------------+---------------------------------------------------------+ -| :ref:`String` | :ref:`var_name` | -+-----------------------------+---------------------------------------------------------+ ++-----------------------------+------------------------------------------------------------------+ +| :ref:`String` | :ref:`var_name` | ++-----------------------------+------------------------------------------------------------------+ Description ----------- @@ -41,7 +41,7 @@ Changes a variable's value to the given input. Property Descriptions --------------------- -.. _class_VisualScriptVariableSet_var_name: +.. _class_VisualScriptVariableSet_property_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 2dcec30e2..803e14d53 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -19,17 +19,23 @@ Brief Description Properties ---------- -+----------------------------------------------------+-----------------------------------------------------+ -| :ref:`YieldMode` | :ref:`mode` | -+----------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`wait_time` | -+----------------------------------------------------+-----------------------------------------------------+ ++----------------------------------------------------+--------------------------------------------------------------+ +| :ref:`YieldMode` | :ref:`mode` | ++----------------------------------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`wait_time` | ++----------------------------------------------------+--------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualScriptYield_YieldMode: +.. _class_VisualScriptYield_constant_YIELD_FRAME: + +.. _class_VisualScriptYield_constant_YIELD_PHYSICS_FRAME: + +.. _class_VisualScriptYield_constant_YIELD_WAIT: + enum **YieldMode**: - **YIELD_FRAME** = **1** @@ -41,7 +47,7 @@ enum **YieldMode**: Property Descriptions --------------------- -.. _class_VisualScriptYield_mode: +.. _class_VisualScriptYield_property_mode: - :ref:`YieldMode` **mode** @@ -51,7 +57,7 @@ Property Descriptions | *Getter* | get_yield_mode() | +----------+-----------------------+ -.. _class_VisualScriptYield_wait_time: +.. _class_VisualScriptYield_property_wait_time: - :ref:`float` **wait_time** diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 5b25afa13..85248e7b9 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -19,21 +19,27 @@ Brief Description Properties ---------- -+--------------------------------------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`base_type` | -+--------------------------------------------------------+-----------------------------------------------------------+ -| :ref:`CallMode` | :ref:`call_mode` | -+--------------------------------------------------------+-----------------------------------------------------------+ -| :ref:`NodePath` | :ref:`node_path` | -+--------------------------------------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`signal` | -+--------------------------------------------------------+-----------------------------------------------------------+ ++--------------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`base_type` | ++--------------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`CallMode` | :ref:`call_mode` | ++--------------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`node_path` | ++--------------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`signal` | ++--------------------------------------------------------+--------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualScriptYieldSignal_CallMode: +.. _class_VisualScriptYieldSignal_constant_CALL_MODE_SELF: + +.. _class_VisualScriptYieldSignal_constant_CALL_MODE_NODE_PATH: + +.. _class_VisualScriptYieldSignal_constant_CALL_MODE_INSTANCE: + enum **CallMode**: - **CALL_MODE_SELF** = **0** @@ -45,7 +51,7 @@ enum **CallMode**: Property Descriptions --------------------- -.. _class_VisualScriptYieldSignal_base_type: +.. _class_VisualScriptYieldSignal_property_base_type: - :ref:`String` **base_type** @@ -55,7 +61,7 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ -.. _class_VisualScriptYieldSignal_call_mode: +.. _class_VisualScriptYieldSignal_property_call_mode: - :ref:`CallMode` **call_mode** @@ -65,7 +71,7 @@ Property Descriptions | *Getter* | get_call_mode() | +----------+----------------------+ -.. _class_VisualScriptYieldSignal_node_path: +.. _class_VisualScriptYieldSignal_property_node_path: - :ref:`NodePath` **node_path** @@ -75,7 +81,7 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ -.. _class_VisualScriptYieldSignal_signal: +.. _class_VisualScriptYieldSignal_property_signal: - :ref:`String` **signal** diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 586abcdb3..643b923a6 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -19,728 +19,728 @@ Server for anything visible. Methods ------- -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`camera_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_gradient_length` **(** :ref:`RID` light, :ref:`float` length **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`directional_light_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`environment_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_dof_blur_far` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_dof_blur_near` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog_depth` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_end, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky_orientation` **(** :ref:`RID` env, :ref:`Basis` orientation **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`finish` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_sync` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_cube` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_texture` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_white_texture` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`gi_probe_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_bias` **(** :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:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :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_normal_bias` **(** :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:`bool` | :ref:`gi_probe_is_compressed` **(** :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 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_bounds` **(** :ref:`RID` probe, :ref:`AABB` bounds **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_cell_size` **(** :ref:`RID` probe, :ref:`float` range **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_compress` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_dynamic_data` **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_dynamic_range` **(** :ref:`RID` probe, :ref:`int` range **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_normal_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_propagation` **(** :ref:`RID` probe, :ref:`float` propagation **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_to_cell_xform` **(** :ref:`RID` probe, :ref:`Transform` xform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_changed` **(** **)** const | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` 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 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_clear` **(** :ref:`RID` immediate **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_color` **(** :ref:`RID` immediate, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`immediate_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_set_material` **(** :ref:`RID` immediate, :ref:`RID` material **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_tangent` **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_uv` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_uv2` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_vertex` **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_vertex_2d` **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`init` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_as_instance_lod` **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_draw_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_exterior` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_surface_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_use_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_convex` **(** :ref:`Array` convex, :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 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_shadow_depth_range_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_omni_set_shadow_detail` **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :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:`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 | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_energy` **(** :ref:`RID` capture, :ref:`float` energy **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree` **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree_cell_subdiv` **(** :ref:`RID` capture, :ref:`int` subdiv **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree_cell_transform` **(** :ref:`RID` capture, :ref:`Transform` xform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`AABB` | :ref:`mesh_get_custom_aabb` **(** :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 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_count` **(** :ref:`RID` mesh, :ref:`int` amount **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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_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_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_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:`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:`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 | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_update_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :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:`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_custom_data` **(** :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 | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_as_bulk_array` **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`omni_light_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`particles_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient` **(** :ref:`RID` probe, :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution` **(** :ref:`RID` probe, :ref:`float` contrib **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`scenario_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_debug` **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` size, :ref:`int` subdiv **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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:`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 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`skeleton_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`sky_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`spot_light_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sync` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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_flags` **(** :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:`String` | :ref:`texture_get_path` **(** :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:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_data_partial` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`textures_keep_original` **(** :ref:`bool` enable **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_create` **(** **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_stacking` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hdr` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_usage` **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`camera_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_gradient_length` **(** :ref:`RID` light, :ref:`float` length **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`directional_light_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`environment_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_dof_blur_far` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_dof_blur_near` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog_depth` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_end, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky_orientation` **(** :ref:`RID` env, :ref:`Basis` orientation **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`finish` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_sync` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_cube` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_texture` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_white_texture` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`gi_probe_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gi_probe_get_bias` **(** :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:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :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_normal_bias` **(** :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:`bool` | :ref:`gi_probe_is_compressed` **(** :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 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_bounds` **(** :ref:`RID` probe, :ref:`AABB` bounds **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_cell_size` **(** :ref:`RID` probe, :ref:`float` range **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_compress` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_dynamic_data` **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_dynamic_range` **(** :ref:`RID` probe, :ref:`int` range **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_normal_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_propagation` **(** :ref:`RID` probe, :ref:`float` propagation **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_probe_set_to_cell_xform` **(** :ref:`RID` probe, :ref:`Transform` xform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_changed` **(** **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` 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 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_clear` **(** :ref:`RID` immediate **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_color` **(** :ref:`RID` immediate, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`immediate_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_set_material` **(** :ref:`RID` immediate, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_tangent` **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_uv` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_uv2` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_vertex` **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_vertex_2d` **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`init` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_as_instance_lod` **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_draw_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_exterior` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_surface_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_use_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_convex` **(** :ref:`Array` convex, :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 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_shadow_depth_range_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_omni_set_shadow_detail` **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :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:`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 | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_energy` **(** :ref:`RID` capture, :ref:`float` energy **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree` **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree_cell_subdiv` **(** :ref:`RID` capture, :ref:`int` subdiv **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree_cell_transform` **(** :ref:`RID` capture, :ref:`Transform` xform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`material_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`AABB` | :ref:`mesh_get_custom_aabb` **(** :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 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_blend_shape_count` **(** :ref:`RID` mesh, :ref:`int` amount **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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_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_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_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:`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:`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 | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_update_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, VisualServer.MultimeshCustomDataFormat custom_data_format=0 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :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:`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_custom_data` **(** :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 | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_as_bulk_array` **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`omni_light_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`particles_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient` **(** :ref:`RID` probe, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution` **(** :ref:`RID` probe, :ref:`float` contrib **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`scenario_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_debug` **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` size, :ref:`int` subdiv **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shader_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`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 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`skeleton_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`sky_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`spot_light_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sync` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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_flags` **(** :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:`String` | :ref:`texture_get_path` **(** :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:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_data_partial` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`textures_keep_original` **(** :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_stacking` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hdr` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_usage` **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_VisualServer_frame_post_draw: +.. _class_VisualServer_signal_frame_post_draw: - **frame_post_draw** **(** **)** -.. _class_VisualServer_frame_pre_draw: +.. _class_VisualServer_signal_frame_pre_draw: - **frame_pre_draw** **(** **)** @@ -749,6 +749,18 @@ Enumerations .. _enum_VisualServer_CubeMapSide: +.. _class_VisualServer_constant_CUBEMAP_LEFT: + +.. _class_VisualServer_constant_CUBEMAP_RIGHT: + +.. _class_VisualServer_constant_CUBEMAP_BOTTOM: + +.. _class_VisualServer_constant_CUBEMAP_TOP: + +.. _class_VisualServer_constant_CUBEMAP_FRONT: + +.. _class_VisualServer_constant_CUBEMAP_BACK: + enum **CubeMapSide**: - **CUBEMAP_LEFT** = **0** --- Marks the left side of a cubemap. @@ -765,6 +777,14 @@ enum **CubeMapSide**: .. _enum_VisualServer_TextureType: +.. _class_VisualServer_constant_TEXTURE_TYPE_2D: + +.. _class_VisualServer_constant_TEXTURE_TYPE_CUBEMAP: + +.. _class_VisualServer_constant_TEXTURE_TYPE_2D_ARRAY: + +.. _class_VisualServer_constant_TEXTURE_TYPE_3D: + enum **TextureType**: - **TEXTURE_TYPE_2D** = **0** @@ -777,6 +797,22 @@ enum **TextureType**: .. _enum_VisualServer_TextureFlags: +.. _class_VisualServer_constant_TEXTURE_FLAG_MIPMAPS: + +.. _class_VisualServer_constant_TEXTURE_FLAG_REPEAT: + +.. _class_VisualServer_constant_TEXTURE_FLAG_FILTER: + +.. _class_VisualServer_constant_TEXTURE_FLAG_ANISOTROPIC_FILTER: + +.. _class_VisualServer_constant_TEXTURE_FLAG_CONVERT_TO_LINEAR: + +.. _class_VisualServer_constant_TEXTURE_FLAG_MIRRORED_REPEAT: + +.. _class_VisualServer_constant_TEXTURE_FLAG_USED_FOR_STREAMING: + +.. _class_VisualServer_constant_TEXTURE_FLAGS_DEFAULT: + enum **TextureFlags**: - **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. @@ -799,6 +835,14 @@ More effective on planes often shown going to the horrizon as those textures (Wa .. _enum_VisualServer_ShaderMode: +.. _class_VisualServer_constant_SHADER_SPATIAL: + +.. _class_VisualServer_constant_SHADER_CANVAS_ITEM: + +.. _class_VisualServer_constant_SHADER_PARTICLES: + +.. _class_VisualServer_constant_SHADER_MAX: + enum **ShaderMode**: - **SHADER_SPATIAL** = **0** --- Shader is a 3D shader. @@ -811,6 +855,26 @@ enum **ShaderMode**: .. _enum_VisualServer_ArrayType: +.. _class_VisualServer_constant_ARRAY_VERTEX: + +.. _class_VisualServer_constant_ARRAY_NORMAL: + +.. _class_VisualServer_constant_ARRAY_TANGENT: + +.. _class_VisualServer_constant_ARRAY_COLOR: + +.. _class_VisualServer_constant_ARRAY_TEX_UV: + +.. _class_VisualServer_constant_ARRAY_TEX_UV2: + +.. _class_VisualServer_constant_ARRAY_BONES: + +.. _class_VisualServer_constant_ARRAY_WEIGHTS: + +.. _class_VisualServer_constant_ARRAY_INDEX: + +.. _class_VisualServer_constant_ARRAY_MAX: + enum **ArrayType**: - **ARRAY_VERTEX** = **0** --- Array is a vertex array. @@ -835,6 +899,48 @@ enum **ArrayType**: .. _enum_VisualServer_ArrayFormat: +.. _class_VisualServer_constant_ARRAY_FORMAT_VERTEX: + +.. _class_VisualServer_constant_ARRAY_FORMAT_NORMAL: + +.. _class_VisualServer_constant_ARRAY_FORMAT_TANGENT: + +.. _class_VisualServer_constant_ARRAY_FORMAT_COLOR: + +.. _class_VisualServer_constant_ARRAY_FORMAT_TEX_UV: + +.. _class_VisualServer_constant_ARRAY_FORMAT_TEX_UV2: + +.. _class_VisualServer_constant_ARRAY_FORMAT_BONES: + +.. _class_VisualServer_constant_ARRAY_FORMAT_WEIGHTS: + +.. _class_VisualServer_constant_ARRAY_FORMAT_INDEX: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_VERTEX: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_NORMAL: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_TANGENT: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_COLOR: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_TEX_UV: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_TEX_UV2: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_BONES: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_WEIGHTS: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_INDEX: + +.. _class_VisualServer_constant_ARRAY_FLAG_USE_2D_VERTICES: + +.. _class_VisualServer_constant_ARRAY_FLAG_USE_16_BIT_BONES: + +.. _class_VisualServer_constant_ARRAY_COMPRESS_DEFAULT: + enum **ArrayFormat**: - **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array. @@ -881,6 +987,22 @@ enum **ArrayFormat**: .. _enum_VisualServer_PrimitiveType: +.. _class_VisualServer_constant_PRIMITIVE_POINTS: + +.. _class_VisualServer_constant_PRIMITIVE_LINES: + +.. _class_VisualServer_constant_PRIMITIVE_LINE_STRIP: + +.. _class_VisualServer_constant_PRIMITIVE_LINE_LOOP: + +.. _class_VisualServer_constant_PRIMITIVE_TRIANGLES: + +.. _class_VisualServer_constant_PRIMITIVE_TRIANGLE_STRIP: + +.. _class_VisualServer_constant_PRIMITIVE_TRIANGLE_FAN: + +.. _class_VisualServer_constant_PRIMITIVE_MAX: + enum **PrimitiveType**: - **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points. @@ -901,6 +1023,10 @@ enum **PrimitiveType**: .. _enum_VisualServer_BlendShapeMode: +.. _class_VisualServer_constant_BLEND_SHAPE_MODE_NORMALIZED: + +.. _class_VisualServer_constant_BLEND_SHAPE_MODE_RELATIVE: + enum **BlendShapeMode**: - **BLEND_SHAPE_MODE_NORMALIZED** = **0** @@ -909,6 +1035,12 @@ enum **BlendShapeMode**: .. _enum_VisualServer_LightType: +.. _class_VisualServer_constant_LIGHT_DIRECTIONAL: + +.. _class_VisualServer_constant_LIGHT_OMNI: + +.. _class_VisualServer_constant_LIGHT_SPOT: + enum **LightType**: - **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light. @@ -919,6 +1051,36 @@ enum **LightType**: .. _enum_VisualServer_LightParam: +.. _class_VisualServer_constant_LIGHT_PARAM_ENERGY: + +.. _class_VisualServer_constant_LIGHT_PARAM_SPECULAR: + +.. _class_VisualServer_constant_LIGHT_PARAM_RANGE: + +.. _class_VisualServer_constant_LIGHT_PARAM_ATTENUATION: + +.. _class_VisualServer_constant_LIGHT_PARAM_SPOT_ANGLE: + +.. _class_VisualServer_constant_LIGHT_PARAM_SPOT_ATTENUATION: + +.. _class_VisualServer_constant_LIGHT_PARAM_CONTACT_SHADOW_SIZE: + +.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE: + +.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET: + +.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET: + +.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET: + +.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS: + +.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_BIAS: + +.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE: + +.. _class_VisualServer_constant_LIGHT_PARAM_MAX: + enum **LightParam**: - **LIGHT_PARAM_ENERGY** = **0** --- The light's energy. @@ -953,6 +1115,10 @@ enum **LightParam**: .. _enum_VisualServer_LightOmniShadowMode: +.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID: + +.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_CUBE: + enum **LightOmniShadowMode**: - **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0** @@ -961,6 +1127,10 @@ enum **LightOmniShadowMode**: .. _enum_VisualServer_LightOmniShadowDetail: +.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DETAIL_VERTICAL: + +.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL: + enum **LightOmniShadowDetail**: - **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0** @@ -969,6 +1139,12 @@ enum **LightOmniShadowDetail**: .. _enum_VisualServer_LightDirectionalShadowMode: +.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL: + +.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS: + +.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS: + enum **LightDirectionalShadowMode**: - **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = **0** @@ -979,6 +1155,10 @@ enum **LightDirectionalShadowMode**: .. _enum_VisualServer_LightDirectionalShadowDepthRangeMode: +.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE: + +.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED: + enum **LightDirectionalShadowDepthRangeMode**: - **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE** = **0** @@ -987,6 +1167,14 @@ enum **LightDirectionalShadowDepthRangeMode**: .. _enum_VisualServer_ViewportUpdateMode: +.. _class_VisualServer_constant_VIEWPORT_UPDATE_DISABLED: + +.. _class_VisualServer_constant_VIEWPORT_UPDATE_ONCE: + +.. _class_VisualServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE: + +.. _class_VisualServer_constant_VIEWPORT_UPDATE_ALWAYS: + enum **ViewportUpdateMode**: - **VIEWPORT_UPDATE_DISABLED** = **0** @@ -999,6 +1187,12 @@ enum **ViewportUpdateMode**: .. _enum_VisualServer_ViewportClearMode: +.. _class_VisualServer_constant_VIEWPORT_CLEAR_ALWAYS: + +.. _class_VisualServer_constant_VIEWPORT_CLEAR_NEVER: + +.. _class_VisualServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME: + enum **ViewportClearMode**: - **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing. @@ -1009,6 +1203,16 @@ enum **ViewportClearMode**: .. _enum_VisualServer_ViewportMSAA: +.. _class_VisualServer_constant_VIEWPORT_MSAA_DISABLED: + +.. _class_VisualServer_constant_VIEWPORT_MSAA_2X: + +.. _class_VisualServer_constant_VIEWPORT_MSAA_4X: + +.. _class_VisualServer_constant_VIEWPORT_MSAA_8X: + +.. _class_VisualServer_constant_VIEWPORT_MSAA_16X: + enum **ViewportMSAA**: - **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled. @@ -1023,6 +1227,14 @@ enum **ViewportMSAA**: .. _enum_VisualServer_ViewportUsage: +.. _class_VisualServer_constant_VIEWPORT_USAGE_2D: + +.. _class_VisualServer_constant_VIEWPORT_USAGE_2D_NO_SAMPLING: + +.. _class_VisualServer_constant_VIEWPORT_USAGE_3D: + +.. _class_VisualServer_constant_VIEWPORT_USAGE_3D_NO_EFFECTS: + enum **ViewportUsage**: - **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples. @@ -1035,6 +1247,20 @@ enum **ViewportUsage**: .. _enum_VisualServer_ViewportRenderInfo: +.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME: + +.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME: + +.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME: + +.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME: + +.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME: + +.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME: + +.. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_MAX: + enum **ViewportRenderInfo**: - **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0** @@ -1053,6 +1279,14 @@ enum **ViewportRenderInfo**: .. _enum_VisualServer_ViewportDebugDraw: +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME: + enum **ViewportDebugDraw**: - **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting. @@ -1065,6 +1299,14 @@ enum **ViewportDebugDraw**: .. _enum_VisualServer_ScenarioDebugMode: +.. _class_VisualServer_constant_SCENARIO_DEBUG_DISABLED: + +.. _class_VisualServer_constant_SCENARIO_DEBUG_WIREFRAME: + +.. _class_VisualServer_constant_SCENARIO_DEBUG_OVERDRAW: + +.. _class_VisualServer_constant_SCENARIO_DEBUG_SHADELESS: + enum **ScenarioDebugMode**: - **SCENARIO_DEBUG_DISABLED** = **0** @@ -1077,6 +1319,28 @@ enum **ScenarioDebugMode**: .. _enum_VisualServer_InstanceType: +.. _class_VisualServer_constant_INSTANCE_NONE: + +.. _class_VisualServer_constant_INSTANCE_MESH: + +.. _class_VisualServer_constant_INSTANCE_MULTIMESH: + +.. _class_VisualServer_constant_INSTANCE_IMMEDIATE: + +.. _class_VisualServer_constant_INSTANCE_PARTICLES: + +.. _class_VisualServer_constant_INSTANCE_LIGHT: + +.. _class_VisualServer_constant_INSTANCE_REFLECTION_PROBE: + +.. _class_VisualServer_constant_INSTANCE_GI_PROBE: + +.. _class_VisualServer_constant_INSTANCE_LIGHTMAP_CAPTURE: + +.. _class_VisualServer_constant_INSTANCE_MAX: + +.. _class_VisualServer_constant_INSTANCE_GEOMETRY_MASK: + enum **InstanceType**: - **INSTANCE_NONE** = **0** --- The instance does not have a type. @@ -1103,6 +1367,12 @@ enum **InstanceType**: .. _enum_VisualServer_InstanceFlags: +.. _class_VisualServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT: + +.. _class_VisualServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: + +.. _class_VisualServer_constant_INSTANCE_FLAG_MAX: + enum **InstanceFlags**: - **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0** @@ -1113,6 +1383,14 @@ enum **InstanceFlags**: .. _enum_VisualServer_ShadowCastingSetting: +.. _class_VisualServer_constant_SHADOW_CASTING_SETTING_OFF: + +.. _class_VisualServer_constant_SHADOW_CASTING_SETTING_ON: + +.. _class_VisualServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED: + +.. _class_VisualServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY: + enum **ShadowCastingSetting**: - **SHADOW_CASTING_SETTING_OFF** = **0** @@ -1125,6 +1403,12 @@ enum **ShadowCastingSetting**: .. _enum_VisualServer_NinePatchAxisMode: +.. _class_VisualServer_constant_NINE_PATCH_STRETCH: + +.. _class_VisualServer_constant_NINE_PATCH_TILE: + +.. _class_VisualServer_constant_NINE_PATCH_TILE_FIT: + enum **NinePatchAxisMode**: - **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed. @@ -1135,6 +1419,14 @@ enum **NinePatchAxisMode**: .. _enum_VisualServer_CanvasLightMode: +.. _class_VisualServer_constant_CANVAS_LIGHT_MODE_ADD: + +.. _class_VisualServer_constant_CANVAS_LIGHT_MODE_SUB: + +.. _class_VisualServer_constant_CANVAS_LIGHT_MODE_MIX: + +.. _class_VisualServer_constant_CANVAS_LIGHT_MODE_MASK: + enum **CanvasLightMode**: - **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas. @@ -1147,6 +1439,18 @@ enum **CanvasLightMode**: .. _enum_VisualServer_CanvasLightShadowFilter: +.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_NONE: + +.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF3: + +.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF5: + +.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF7: + +.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF9: + +.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF13: + enum **CanvasLightShadowFilter**: - **CANVAS_LIGHT_FILTER_NONE** = **0** @@ -1163,6 +1467,12 @@ enum **CanvasLightShadowFilter**: .. _enum_VisualServer_CanvasOccluderPolygonCullMode: +.. _class_VisualServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED: + +.. _class_VisualServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE: + +.. _class_VisualServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE: + enum **CanvasOccluderPolygonCullMode**: - **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled. @@ -1173,6 +1483,26 @@ enum **CanvasOccluderPolygonCullMode**: .. _enum_VisualServer_RenderInfo: +.. _class_VisualServer_constant_INFO_OBJECTS_IN_FRAME: + +.. _class_VisualServer_constant_INFO_VERTICES_IN_FRAME: + +.. _class_VisualServer_constant_INFO_MATERIAL_CHANGES_IN_FRAME: + +.. _class_VisualServer_constant_INFO_SHADER_CHANGES_IN_FRAME: + +.. _class_VisualServer_constant_INFO_SURFACE_CHANGES_IN_FRAME: + +.. _class_VisualServer_constant_INFO_DRAW_CALLS_IN_FRAME: + +.. _class_VisualServer_constant_INFO_USAGE_VIDEO_MEM_TOTAL: + +.. _class_VisualServer_constant_INFO_VIDEO_MEM_USED: + +.. _class_VisualServer_constant_INFO_TEXTURE_MEM_USED: + +.. _class_VisualServer_constant_INFO_VERTEX_MEM_USED: + enum **RenderInfo**: - **INFO_OBJECTS_IN_FRAME** = **0** --- The amount of objects in the frame. @@ -1197,6 +1527,10 @@ enum **RenderInfo**: .. _enum_VisualServer_Features: +.. _class_VisualServer_constant_FEATURE_SHADERS: + +.. _class_VisualServer_constant_FEATURE_MULTITHREADED: + enum **Features**: - **FEATURE_SHADERS** = **0** @@ -1205,6 +1539,10 @@ enum **Features**: .. _enum_VisualServer_MultimeshTransformFormat: +.. _class_VisualServer_constant_MULTIMESH_TRANSFORM_2D: + +.. _class_VisualServer_constant_MULTIMESH_TRANSFORM_3D: + enum **MultimeshTransformFormat**: - **MULTIMESH_TRANSFORM_2D** = **0** @@ -1213,6 +1551,12 @@ enum **MultimeshTransformFormat**: .. _enum_VisualServer_MultimeshColorFormat: +.. _class_VisualServer_constant_MULTIMESH_COLOR_NONE: + +.. _class_VisualServer_constant_MULTIMESH_COLOR_8BIT: + +.. _class_VisualServer_constant_MULTIMESH_COLOR_FLOAT: + enum **MultimeshColorFormat**: - **MULTIMESH_COLOR_NONE** = **0** @@ -1223,6 +1567,10 @@ enum **MultimeshColorFormat**: .. _enum_VisualServer_ReflectionProbeUpdateMode: +.. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ONCE: + +.. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS: + enum **ReflectionProbeUpdateMode**: - **REFLECTION_PROBE_UPDATE_ONCE** = **0** @@ -1231,6 +1579,12 @@ enum **ReflectionProbeUpdateMode**: .. _enum_VisualServer_ParticlesDrawOrder: +.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_INDEX: + +.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_LIFETIME: + +.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH: + enum **ParticlesDrawOrder**: - **PARTICLES_DRAW_ORDER_INDEX** = **0** @@ -1241,6 +1595,20 @@ enum **ParticlesDrawOrder**: .. _enum_VisualServer_EnvironmentBG: +.. _class_VisualServer_constant_ENV_BG_CLEAR_COLOR: + +.. _class_VisualServer_constant_ENV_BG_COLOR: + +.. _class_VisualServer_constant_ENV_BG_SKY: + +.. _class_VisualServer_constant_ENV_BG_COLOR_SKY: + +.. _class_VisualServer_constant_ENV_BG_CANVAS: + +.. _class_VisualServer_constant_ENV_BG_KEEP: + +.. _class_VisualServer_constant_ENV_BG_MAX: + enum **EnvironmentBG**: - **ENV_BG_CLEAR_COLOR** = **0** @@ -1259,6 +1627,12 @@ enum **EnvironmentBG**: .. _enum_VisualServer_EnvironmentDOFBlurQuality: +.. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_LOW: + +.. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_MEDIUM: + +.. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_HIGH: + enum **EnvironmentDOFBlurQuality**: - **ENV_DOF_BLUR_QUALITY_LOW** = **0** @@ -1269,6 +1643,14 @@ enum **EnvironmentDOFBlurQuality**: .. _enum_VisualServer_EnvironmentGlowBlendMode: +.. _class_VisualServer_constant_GLOW_BLEND_MODE_ADDITIVE: + +.. _class_VisualServer_constant_GLOW_BLEND_MODE_SCREEN: + +.. _class_VisualServer_constant_GLOW_BLEND_MODE_SOFTLIGHT: + +.. _class_VisualServer_constant_GLOW_BLEND_MODE_REPLACE: + enum **EnvironmentGlowBlendMode**: - **GLOW_BLEND_MODE_ADDITIVE** = **0** @@ -1281,6 +1663,14 @@ enum **EnvironmentGlowBlendMode**: .. _enum_VisualServer_EnvironmentToneMapper: +.. _class_VisualServer_constant_ENV_TONE_MAPPER_LINEAR: + +.. _class_VisualServer_constant_ENV_TONE_MAPPER_REINHARD: + +.. _class_VisualServer_constant_ENV_TONE_MAPPER_FILMIC: + +.. _class_VisualServer_constant_ENV_TONE_MAPPER_ACES: + enum **EnvironmentToneMapper**: - **ENV_TONE_MAPPER_LINEAR** = **0** @@ -1293,6 +1683,12 @@ enum **EnvironmentToneMapper**: .. _enum_VisualServer_EnvironmentSSAOQuality: +.. _class_VisualServer_constant_ENV_SSAO_QUALITY_LOW: + +.. _class_VisualServer_constant_ENV_SSAO_QUALITY_MEDIUM: + +.. _class_VisualServer_constant_ENV_SSAO_QUALITY_HIGH: + enum **EnvironmentSSAOQuality**: - **ENV_SSAO_QUALITY_LOW** = **0** @@ -1303,6 +1699,14 @@ enum **EnvironmentSSAOQuality**: .. _enum_VisualServer_EnvironmentSSAOBlur: +.. _class_VisualServer_constant_ENV_SSAO_BLUR_DISABLED: + +.. _class_VisualServer_constant_ENV_SSAO_BLUR_1x1: + +.. _class_VisualServer_constant_ENV_SSAO_BLUR_2x2: + +.. _class_VisualServer_constant_ENV_SSAO_BLUR_3x3: + enum **EnvironmentSSAOBlur**: - **ENV_SSAO_BLUR_DISABLED** = **0** @@ -1316,6 +1720,22 @@ enum **EnvironmentSSAOBlur**: Constants --------- +.. _class_VisualServer_constant_NO_INDEX_ARRAY: + +.. _class_VisualServer_constant_ARRAY_WEIGHTS_SIZE: + +.. _class_VisualServer_constant_CANVAS_ITEM_Z_MIN: + +.. _class_VisualServer_constant_CANVAS_ITEM_Z_MAX: + +.. _class_VisualServer_constant_MAX_GLOW_LEVELS: + +.. _class_VisualServer_constant_MAX_CURSORS: + +.. _class_VisualServer_constant_MATERIAL_RENDER_PRIORITY_MIN: + +.. _class_VisualServer_constant_MATERIAL_RENDER_PRIORITY_MAX: + - **NO_INDEX_ARRAY** = **-1** --- Marks an error that shows that the index array is empty. - **ARRAY_WEIGHTS_SIZE** = **4** @@ -1342,83 +1762,83 @@ The visual server is completely opaque, the internals are entirely implementatio Method Descriptions ------------------- -.. _class_VisualServer_black_bars_set_images: +.. _class_VisualServer_method_black_bars_set_images: - void **black_bars_set_images** **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** Sets images to be rendered in the window margin. -.. _class_VisualServer_black_bars_set_margins: +.. _class_VisualServer_method_black_bars_set_margins: - void **black_bars_set_margins** **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** -Sets margin size, where black bars (or images, if :ref:`black_bars_set_images` was used) are rendered. +Sets margin size, where black bars (or images, if :ref:`black_bars_set_images` was used) are rendered. -.. _class_VisualServer_camera_create: +.. _class_VisualServer_method_camera_create: - :ref:`RID` **camera_create** **(** **)** -.. _class_VisualServer_camera_set_cull_mask: +.. _class_VisualServer_method_camera_set_cull_mask: - void **camera_set_cull_mask** **(** :ref:`RID` camera, :ref:`int` layers **)** -.. _class_VisualServer_camera_set_environment: +.. _class_VisualServer_method_camera_set_environment: - void **camera_set_environment** **(** :ref:`RID` camera, :ref:`RID` env **)** -.. _class_VisualServer_camera_set_orthogonal: +.. _class_VisualServer_method_camera_set_orthogonal: - void **camera_set_orthogonal** **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** -.. _class_VisualServer_camera_set_perspective: +.. _class_VisualServer_method_camera_set_perspective: - void **camera_set_perspective** **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** -.. _class_VisualServer_camera_set_transform: +.. _class_VisualServer_method_camera_set_transform: - void **camera_set_transform** **(** :ref:`RID` camera, :ref:`Transform` transform **)** -.. _class_VisualServer_camera_set_use_vertical_aspect: +.. _class_VisualServer_method_camera_set_use_vertical_aspect: - void **camera_set_use_vertical_aspect** **(** :ref:`RID` camera, :ref:`bool` enable **)** -.. _class_VisualServer_canvas_create: +.. _class_VisualServer_method_canvas_create: - :ref:`RID` **canvas_create** **(** **)** Creates a canvas and returns the assigned :ref:`RID`. -.. _class_VisualServer_canvas_item_add_circle: +.. _class_VisualServer_method_canvas_item_add_circle: - void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** Adds a circle command to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_clip_ignore: +.. _class_VisualServer_method_canvas_item_add_clip_ignore: - void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** If ignore is ``true``, the VisualServer does not perform clipping. -.. _class_VisualServer_canvas_item_add_line: +.. _class_VisualServer_method_canvas_item_add_line: - void **canvas_item_add_line** **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Adds a line command to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_mesh: +.. _class_VisualServer_method_canvas_item_add_mesh: - void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** Adds a :ref:`Mesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. -.. _class_VisualServer_canvas_item_add_multimesh: +.. _class_VisualServer_method_canvas_item_add_multimesh: - void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** Adds a :ref:`MultiMesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. -.. _class_VisualServer_canvas_item_add_nine_patch: +.. _class_VisualServer_method_canvas_item_add_nine_patch: - void **canvas_item_add_nine_patch** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** @@ -1426,37 +1846,37 @@ Adds a nine patch image to the :ref:`CanvasItem`'s draw comman See :ref:`NinePatchRect` for more explanation. -.. _class_VisualServer_canvas_item_add_particles: +.. _class_VisualServer_method_canvas_item_add_particles: - void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map **)** Adds a particles system to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_polygon: +.. _class_VisualServer_method_canvas_item_add_polygon: - void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** Adds a polygon to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_polyline: +.. _class_VisualServer_method_canvas_item_add_polyline: - void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Adds a polyline, which is a line from multiple points with a width, to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_primitive: +.. _class_VisualServer_method_canvas_item_add_primitive: - void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** Adds a primitive to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_rect: +.. _class_VisualServer_method_canvas_item_add_rect: - void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** Adds a rectangle to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_set_transform: +.. _class_VisualServer_method_canvas_item_add_set_transform: - void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** @@ -1464,1221 +1884,1221 @@ Adds a :ref:`Transform2D` command to the :ref:`CanvasItem` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** Adds a textured rect to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_texture_rect_region: +.. _class_VisualServer_method_canvas_item_add_texture_rect_region: - void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** Adds a texture rect with region setting to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_triangle_array: +.. _class_VisualServer_method_canvas_item_add_triangle_array: - void **canvas_item_add_triangle_array** **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** -.. _class_VisualServer_canvas_item_clear: +.. _class_VisualServer_method_canvas_item_clear: - void **canvas_item_clear** **(** :ref:`RID` item **)** Clears the :ref:`CanvasItem` and removes all commands in it. -.. _class_VisualServer_canvas_item_create: +.. _class_VisualServer_method_canvas_item_create: - :ref:`RID` **canvas_item_create** **(** **)** Creates a new :ref:`CanvasItem` and returns its :ref:`RID`. -.. _class_VisualServer_canvas_item_set_clip: +.. _class_VisualServer_method_canvas_item_set_clip: - void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** Sets clipping for the :ref:`CanvasItem`. -.. _class_VisualServer_canvas_item_set_copy_to_backbuffer: +.. _class_VisualServer_method_canvas_item_set_copy_to_backbuffer: - void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. -.. _class_VisualServer_canvas_item_set_custom_rect: +.. _class_VisualServer_method_canvas_item_set_custom_rect: - void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** Defines a custom drawing rectangle for the :ref:`CanvasItem`. -.. _class_VisualServer_canvas_item_set_distance_field_mode: +.. _class_VisualServer_method_canvas_item_set_distance_field_mode: - void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** -.. _class_VisualServer_canvas_item_set_draw_behind_parent: +.. _class_VisualServer_method_canvas_item_set_draw_behind_parent: - void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** Sets :ref:`CanvasItem` to be drawn behind its parent. -.. _class_VisualServer_canvas_item_set_draw_index: +.. _class_VisualServer_method_canvas_item_set_draw_index: - void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** Sets the index for the :ref:`CanvasItem`. -.. _class_VisualServer_canvas_item_set_light_mask: +.. _class_VisualServer_method_canvas_item_set_light_mask: - void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** The light mask. See :ref:`LightOccluder2D` for more information on light masks. -.. _class_VisualServer_canvas_item_set_material: +.. _class_VisualServer_method_canvas_item_set_material: - void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** Sets a new material to the :ref:`CanvasItem`. -.. _class_VisualServer_canvas_item_set_modulate: +.. _class_VisualServer_method_canvas_item_set_modulate: - void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** Sets the color that modulates the :ref:`CanvasItem` and its children. -.. _class_VisualServer_canvas_item_set_parent: +.. _class_VisualServer_method_canvas_item_set_parent: - void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** Sets the parent for the :ref:`CanvasItem`. -.. _class_VisualServer_canvas_item_set_self_modulate: +.. _class_VisualServer_method_canvas_item_set_self_modulate: - void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** Sets the color that modulates the :ref:`CanvasItem` without children. -.. _class_VisualServer_canvas_item_set_sort_children_by_y: +.. _class_VisualServer_method_canvas_item_set_sort_children_by_y: - void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** Sets if :ref:`CanvasItem`'s children should be sorted by y-position. -.. _class_VisualServer_canvas_item_set_transform: +.. _class_VisualServer_method_canvas_item_set_transform: - void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** Sets the :ref:`CanvasItem`'s :ref:`Transform2D`. -.. _class_VisualServer_canvas_item_set_use_parent_material: +.. _class_VisualServer_method_canvas_item_set_use_parent_material: - void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** Sets if the :ref:`CanvasItem` uses its parent's material. -.. _class_VisualServer_canvas_item_set_visible: +.. _class_VisualServer_method_canvas_item_set_visible: - void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** Sets if the canvas item (including its children) is visible. -.. _class_VisualServer_canvas_item_set_z_as_relative_to_parent: +.. _class_VisualServer_method_canvas_item_set_z_as_relative_to_parent: - void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** If this is enabled, the z-index of the parent will be added to the children's z-index. -.. _class_VisualServer_canvas_item_set_z_index: +.. _class_VisualServer_method_canvas_item_set_z_index: - void **canvas_item_set_z_index** **(** :ref:`RID` item, :ref:`int` z_index **)** Sets the :ref:`CanvasItem`'s z-index, i.e. its draw order (lower indexes are drawn first). -.. _class_VisualServer_canvas_light_attach_to_canvas: +.. _class_VisualServer_method_canvas_light_attach_to_canvas: - void **canvas_light_attach_to_canvas** **(** :ref:`RID` light, :ref:`RID` canvas **)** Attaches the canvas light to the canvas. Removes it from its previous canvas. -.. _class_VisualServer_canvas_light_create: +.. _class_VisualServer_method_canvas_light_create: - :ref:`RID` **canvas_light_create** **(** **)** Creates a canvas light. -.. _class_VisualServer_canvas_light_occluder_attach_to_canvas: +.. _class_VisualServer_method_canvas_light_occluder_attach_to_canvas: - void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID` occluder, :ref:`RID` canvas **)** Attaches a light occluder to the canvas. Removes it from its previous canvas. -.. _class_VisualServer_canvas_light_occluder_create: +.. _class_VisualServer_method_canvas_light_occluder_create: - :ref:`RID` **canvas_light_occluder_create** **(** **)** Creates a light occluder. -.. _class_VisualServer_canvas_light_occluder_set_enabled: +.. _class_VisualServer_method_canvas_light_occluder_set_enabled: - void **canvas_light_occluder_set_enabled** **(** :ref:`RID` occluder, :ref:`bool` enabled **)** Enables or disables light occluder. -.. _class_VisualServer_canvas_light_occluder_set_light_mask: +.. _class_VisualServer_method_canvas_light_occluder_set_light_mask: - void **canvas_light_occluder_set_light_mask** **(** :ref:`RID` occluder, :ref:`int` mask **)** The light mask. See :ref:`LightOccluder2D` for more information on light masks -.. _class_VisualServer_canvas_light_occluder_set_polygon: +.. _class_VisualServer_method_canvas_light_occluder_set_polygon: - void **canvas_light_occluder_set_polygon** **(** :ref:`RID` occluder, :ref:`RID` polygon **)** Sets a light occluder's polygon. -.. _class_VisualServer_canvas_light_occluder_set_transform: +.. _class_VisualServer_method_canvas_light_occluder_set_transform: - void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** Sets a light occluder's :ref:`Transform2D`. -.. _class_VisualServer_canvas_light_set_color: +.. _class_VisualServer_method_canvas_light_set_color: - void **canvas_light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color for a light. -.. _class_VisualServer_canvas_light_set_enabled: +.. _class_VisualServer_method_canvas_light_set_enabled: - void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** Enables or disables a canvas light. -.. _class_VisualServer_canvas_light_set_energy: +.. _class_VisualServer_method_canvas_light_set_energy: - void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** Sets a canvas light's energy. -.. _class_VisualServer_canvas_light_set_height: +.. _class_VisualServer_method_canvas_light_set_height: - void **canvas_light_set_height** **(** :ref:`RID` light, :ref:`float` height **)** Sets a canvas light's height. -.. _class_VisualServer_canvas_light_set_item_cull_mask: +.. _class_VisualServer_method_canvas_light_set_item_cull_mask: - void **canvas_light_set_item_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** The light mask. See :ref:`LightOccluder2D` for more information on light masks -.. _class_VisualServer_canvas_light_set_item_shadow_cull_mask: +.. _class_VisualServer_method_canvas_light_set_item_shadow_cull_mask: - void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** The shadow mask. binary about which layers this canvas light affects which canvas item's shadows. See :ref:`LightOccluder2D` for more information on light masks. -.. _class_VisualServer_canvas_light_set_layer_range: +.. _class_VisualServer_method_canvas_light_set_layer_range: - void **canvas_light_set_layer_range** **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** The layer range that gets rendered with this light. -.. _class_VisualServer_canvas_light_set_mode: +.. _class_VisualServer_method_canvas_light_set_mode: - void **canvas_light_set_mode** **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** The mode of the light, see CANVAS_LIGHT_MODE\_\* constants. -.. _class_VisualServer_canvas_light_set_scale: +.. _class_VisualServer_method_canvas_light_set_scale: - void **canvas_light_set_scale** **(** :ref:`RID` light, :ref:`float` scale **)** -.. _class_VisualServer_canvas_light_set_shadow_buffer_size: +.. _class_VisualServer_method_canvas_light_set_shadow_buffer_size: - void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID` light, :ref:`int` size **)** Sets the width of the shadow buffer, size gets scaled to the next power of two for this. -.. _class_VisualServer_canvas_light_set_shadow_color: +.. _class_VisualServer_method_canvas_light_set_shadow_color: - void **canvas_light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color of the canvas light's shadow. -.. _class_VisualServer_canvas_light_set_shadow_enabled: +.. _class_VisualServer_method_canvas_light_set_shadow_enabled: - void **canvas_light_set_shadow_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** Enables or disables the canvas light's shadow. -.. _class_VisualServer_canvas_light_set_shadow_filter: +.. _class_VisualServer_method_canvas_light_set_shadow_filter: - void **canvas_light_set_shadow_filter** **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER\_\* constants. -.. _class_VisualServer_canvas_light_set_shadow_gradient_length: +.. _class_VisualServer_method_canvas_light_set_shadow_gradient_length: - void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID` light, :ref:`float` length **)** Sets the length of the shadow's gradient. -.. _class_VisualServer_canvas_light_set_shadow_smooth: +.. _class_VisualServer_method_canvas_light_set_shadow_smooth: - void **canvas_light_set_shadow_smooth** **(** :ref:`RID` light, :ref:`float` smooth **)** Smoothens the shadow. The lower, the more smooth. -.. _class_VisualServer_canvas_light_set_texture: +.. _class_VisualServer_method_canvas_light_set_texture: - void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** -.. _class_VisualServer_canvas_light_set_texture_offset: +.. _class_VisualServer_method_canvas_light_set_texture_offset: - void **canvas_light_set_texture_offset** **(** :ref:`RID` light, :ref:`Vector2` offset **)** -.. _class_VisualServer_canvas_light_set_transform: +.. _class_VisualServer_method_canvas_light_set_transform: - void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** Sets the canvas light's :ref:`Transform2D`. -.. _class_VisualServer_canvas_light_set_z_range: +.. _class_VisualServer_method_canvas_light_set_z_range: - void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** -.. _class_VisualServer_canvas_occluder_polygon_create: +.. _class_VisualServer_method_canvas_occluder_polygon_create: - :ref:`RID` **canvas_occluder_polygon_create** **(** **)** Creates a new light occluder polygon. -.. _class_VisualServer_canvas_occluder_polygon_set_cull_mode: +.. _class_VisualServer_method_canvas_occluder_polygon_set_cull_mode: - void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE\_\* constants. -.. _class_VisualServer_canvas_occluder_polygon_set_shape: +.. _class_VisualServer_method_canvas_occluder_polygon_set_shape: - void **canvas_occluder_polygon_set_shape** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** Sets the shape of the occluder polygon. -.. _class_VisualServer_canvas_occluder_polygon_set_shape_as_lines: +.. _class_VisualServer_method_canvas_occluder_polygon_set_shape_as_lines: - void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** Sets the shape of the occluder polygon as lines. -.. _class_VisualServer_canvas_set_item_mirroring: +.. _class_VisualServer_method_canvas_set_item_mirroring: - void **canvas_set_item_mirroring** **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2`. -.. _class_VisualServer_canvas_set_modulate: +.. _class_VisualServer_method_canvas_set_modulate: - void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** Modulates all colors in the given canvas. -.. _class_VisualServer_directional_light_create: +.. _class_VisualServer_method_directional_light_create: - :ref:`RID` **directional_light_create** **(** **)** -.. _class_VisualServer_draw: +.. _class_VisualServer_method_draw: - void **draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** -.. _class_VisualServer_environment_create: +.. _class_VisualServer_method_environment_create: - :ref:`RID` **environment_create** **(** **)** -.. _class_VisualServer_environment_set_adjustment: +.. _class_VisualServer_method_environment_set_adjustment: - void **environment_set_adjustment** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** -.. _class_VisualServer_environment_set_ambient_light: +.. _class_VisualServer_method_environment_set_ambient_light: - void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** -.. _class_VisualServer_environment_set_background: +.. _class_VisualServer_method_environment_set_background: - void **environment_set_background** **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** -.. _class_VisualServer_environment_set_bg_color: +.. _class_VisualServer_method_environment_set_bg_color: - void **environment_set_bg_color** **(** :ref:`RID` env, :ref:`Color` color **)** -.. _class_VisualServer_environment_set_bg_energy: +.. _class_VisualServer_method_environment_set_bg_energy: - void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` energy **)** -.. _class_VisualServer_environment_set_canvas_max_layer: +.. _class_VisualServer_method_environment_set_canvas_max_layer: - void **environment_set_canvas_max_layer** **(** :ref:`RID` env, :ref:`int` max_layer **)** -.. _class_VisualServer_environment_set_dof_blur_far: +.. _class_VisualServer_method_environment_set_dof_blur_far: - void **environment_set_dof_blur_far** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** -.. _class_VisualServer_environment_set_dof_blur_near: +.. _class_VisualServer_method_environment_set_dof_blur_near: - void **environment_set_dof_blur_near** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** -.. _class_VisualServer_environment_set_fog: +.. _class_VisualServer_method_environment_set_fog: - void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** -.. _class_VisualServer_environment_set_fog_depth: +.. _class_VisualServer_method_environment_set_fog_depth: - void **environment_set_fog_depth** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_end, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** -.. _class_VisualServer_environment_set_fog_height: +.. _class_VisualServer_method_environment_set_fog_height: - void **environment_set_fog_height** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** -.. _class_VisualServer_environment_set_glow: +.. _class_VisualServer_method_environment_set_glow: - void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** -.. _class_VisualServer_environment_set_sky: +.. _class_VisualServer_method_environment_set_sky: - void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** -.. _class_VisualServer_environment_set_sky_custom_fov: +.. _class_VisualServer_method_environment_set_sky_custom_fov: - void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** -.. _class_VisualServer_environment_set_sky_orientation: +.. _class_VisualServer_method_environment_set_sky_orientation: - void **environment_set_sky_orientation** **(** :ref:`RID` env, :ref:`Basis` orientation **)** -.. _class_VisualServer_environment_set_ssao: +.. _class_VisualServer_method_environment_set_ssao: - void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** -.. _class_VisualServer_environment_set_ssr: +.. _class_VisualServer_method_environment_set_ssr: - void **environment_set_ssr** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** -.. _class_VisualServer_environment_set_tonemap: +.. _class_VisualServer_method_environment_set_tonemap: - void **environment_set_tonemap** **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** -.. _class_VisualServer_finish: +.. _class_VisualServer_method_finish: - void **finish** **(** **)** Removes buffers and clears testcubes. -.. _class_VisualServer_force_draw: +.. _class_VisualServer_method_force_draw: - void **force_draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** -.. _class_VisualServer_force_sync: +.. _class_VisualServer_method_force_sync: - void **force_sync** **(** **)** Synchronizes threads. -.. _class_VisualServer_free_rid: +.. _class_VisualServer_method_free_rid: - void **free_rid** **(** :ref:`RID` rid **)** Tries to free an object in the VisualServer. -.. _class_VisualServer_get_render_info: +.. _class_VisualServer_method_get_render_info: - :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** Returns a certain information, see RENDER_INFO\_\* for options. -.. _class_VisualServer_get_test_cube: +.. _class_VisualServer_method_get_test_cube: - :ref:`RID` **get_test_cube** **(** **)** Returns the id of the test cube. Creates one if none exists. -.. _class_VisualServer_get_test_texture: +.. _class_VisualServer_method_get_test_texture: - :ref:`RID` **get_test_texture** **(** **)** Returns the id of the test texture. Creates one if none exists. -.. _class_VisualServer_get_white_texture: +.. _class_VisualServer_method_get_white_texture: - :ref:`RID` **get_white_texture** **(** **)** Returns the id of a white texture. Creates one if none exists. -.. _class_VisualServer_gi_probe_create: +.. _class_VisualServer_method_gi_probe_create: - :ref:`RID` **gi_probe_create** **(** **)** -.. _class_VisualServer_gi_probe_get_bias: +.. _class_VisualServer_method_gi_probe_get_bias: - :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_bounds: +.. _class_VisualServer_method_gi_probe_get_bounds: - :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_cell_size: +.. _class_VisualServer_method_gi_probe_get_cell_size: - :ref:`float` **gi_probe_get_cell_size** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_dynamic_data: +.. _class_VisualServer_method_gi_probe_get_dynamic_data: - :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_dynamic_range: +.. _class_VisualServer_method_gi_probe_get_dynamic_range: - :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_energy: +.. _class_VisualServer_method_gi_probe_get_energy: - :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_normal_bias: +.. _class_VisualServer_method_gi_probe_get_normal_bias: - :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_propagation: +.. _class_VisualServer_method_gi_probe_get_propagation: - :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_to_cell_xform: +.. _class_VisualServer_method_gi_probe_get_to_cell_xform: - :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_is_compressed: +.. _class_VisualServer_method_gi_probe_is_compressed: - :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_is_interior: +.. _class_VisualServer_method_gi_probe_is_interior: - :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_set_bias: +.. _class_VisualServer_method_gi_probe_set_bias: - void **gi_probe_set_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** -.. _class_VisualServer_gi_probe_set_bounds: +.. _class_VisualServer_method_gi_probe_set_bounds: - void **gi_probe_set_bounds** **(** :ref:`RID` probe, :ref:`AABB` bounds **)** -.. _class_VisualServer_gi_probe_set_cell_size: +.. _class_VisualServer_method_gi_probe_set_cell_size: - void **gi_probe_set_cell_size** **(** :ref:`RID` probe, :ref:`float` range **)** -.. _class_VisualServer_gi_probe_set_compress: +.. _class_VisualServer_method_gi_probe_set_compress: - void **gi_probe_set_compress** **(** :ref:`RID` probe, :ref:`bool` enable **)** -.. _class_VisualServer_gi_probe_set_dynamic_data: +.. _class_VisualServer_method_gi_probe_set_dynamic_data: - void **gi_probe_set_dynamic_data** **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** -.. _class_VisualServer_gi_probe_set_dynamic_range: +.. _class_VisualServer_method_gi_probe_set_dynamic_range: - void **gi_probe_set_dynamic_range** **(** :ref:`RID` probe, :ref:`int` range **)** -.. _class_VisualServer_gi_probe_set_energy: +.. _class_VisualServer_method_gi_probe_set_energy: - void **gi_probe_set_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** -.. _class_VisualServer_gi_probe_set_interior: +.. _class_VisualServer_method_gi_probe_set_interior: - void **gi_probe_set_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** -.. _class_VisualServer_gi_probe_set_normal_bias: +.. _class_VisualServer_method_gi_probe_set_normal_bias: - void **gi_probe_set_normal_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** -.. _class_VisualServer_gi_probe_set_propagation: +.. _class_VisualServer_method_gi_probe_set_propagation: - void **gi_probe_set_propagation** **(** :ref:`RID` probe, :ref:`float` propagation **)** -.. _class_VisualServer_gi_probe_set_to_cell_xform: +.. _class_VisualServer_method_gi_probe_set_to_cell_xform: - void **gi_probe_set_to_cell_xform** **(** :ref:`RID` probe, :ref:`Transform` xform **)** -.. _class_VisualServer_has_changed: +.. _class_VisualServer_method_has_changed: - :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. +Returns ``true`` if changes have been made to the VisualServer's data. :ref:`draw` is usually called if this happens. -.. _class_VisualServer_has_feature: +.. _class_VisualServer_method_has_feature: - :ref:`bool` **has_feature** **(** :ref:`Features` feature **)** const -.. _class_VisualServer_has_os_feature: +.. _class_VisualServer_method_has_os_feature: - :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, -.. _class_VisualServer_immediate_begin: +.. _class_VisualServer_method_immediate_begin: - void **immediate_begin** **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** -.. _class_VisualServer_immediate_clear: +.. _class_VisualServer_method_immediate_clear: - void **immediate_clear** **(** :ref:`RID` immediate **)** -.. _class_VisualServer_immediate_color: +.. _class_VisualServer_method_immediate_color: - void **immediate_color** **(** :ref:`RID` immediate, :ref:`Color` color **)** -.. _class_VisualServer_immediate_create: +.. _class_VisualServer_method_immediate_create: - :ref:`RID` **immediate_create** **(** **)** -.. _class_VisualServer_immediate_end: +.. _class_VisualServer_method_immediate_end: - void **immediate_end** **(** :ref:`RID` immediate **)** -.. _class_VisualServer_immediate_get_material: +.. _class_VisualServer_method_immediate_get_material: - :ref:`RID` **immediate_get_material** **(** :ref:`RID` immediate **)** const -.. _class_VisualServer_immediate_normal: +.. _class_VisualServer_method_immediate_normal: - void **immediate_normal** **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** -.. _class_VisualServer_immediate_set_material: +.. _class_VisualServer_method_immediate_set_material: - void **immediate_set_material** **(** :ref:`RID` immediate, :ref:`RID` material **)** -.. _class_VisualServer_immediate_tangent: +.. _class_VisualServer_method_immediate_tangent: - void **immediate_tangent** **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** -.. _class_VisualServer_immediate_uv: +.. _class_VisualServer_method_immediate_uv: - void **immediate_uv** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** -.. _class_VisualServer_immediate_uv2: +.. _class_VisualServer_method_immediate_uv2: - void **immediate_uv2** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** -.. _class_VisualServer_immediate_vertex: +.. _class_VisualServer_method_immediate_vertex: - void **immediate_vertex** **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** -.. _class_VisualServer_immediate_vertex_2d: +.. _class_VisualServer_method_immediate_vertex_2d: - void **immediate_vertex_2d** **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** -.. _class_VisualServer_init: +.. _class_VisualServer_method_init: - void **init** **(** **)** Initializes the visual server. -.. _class_VisualServer_instance_attach_object_instance_id: +.. _class_VisualServer_method_instance_attach_object_instance_id: - void **instance_attach_object_instance_id** **(** :ref:`RID` instance, :ref:`int` id **)** -.. _class_VisualServer_instance_attach_skeleton: +.. _class_VisualServer_method_instance_attach_skeleton: - void **instance_attach_skeleton** **(** :ref:`RID` instance, :ref:`RID` skeleton **)** -.. _class_VisualServer_instance_create: +.. _class_VisualServer_method_instance_create: - :ref:`RID` **instance_create** **(** **)** -.. _class_VisualServer_instance_create2: +.. _class_VisualServer_method_instance_create2: - :ref:`RID` **instance_create2** **(** :ref:`RID` base, :ref:`RID` scenario **)** -.. _class_VisualServer_instance_geometry_set_as_instance_lod: +.. _class_VisualServer_method_instance_geometry_set_as_instance_lod: - void **instance_geometry_set_as_instance_lod** **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** -.. _class_VisualServer_instance_geometry_set_cast_shadows_setting: +.. _class_VisualServer_method_instance_geometry_set_cast_shadows_setting: - void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** -.. _class_VisualServer_instance_geometry_set_draw_range: +.. _class_VisualServer_method_instance_geometry_set_draw_range: - void **instance_geometry_set_draw_range** **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** -.. _class_VisualServer_instance_geometry_set_flag: +.. _class_VisualServer_method_instance_geometry_set_flag: - void **instance_geometry_set_flag** **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** -.. _class_VisualServer_instance_geometry_set_material_override: +.. _class_VisualServer_method_instance_geometry_set_material_override: - void **instance_geometry_set_material_override** **(** :ref:`RID` instance, :ref:`RID` material **)** -.. _class_VisualServer_instance_set_base: +.. _class_VisualServer_method_instance_set_base: - void **instance_set_base** **(** :ref:`RID` instance, :ref:`RID` base **)** -.. _class_VisualServer_instance_set_blend_shape_weight: +.. _class_VisualServer_method_instance_set_blend_shape_weight: - void **instance_set_blend_shape_weight** **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** -.. _class_VisualServer_instance_set_custom_aabb: +.. _class_VisualServer_method_instance_set_custom_aabb: - void **instance_set_custom_aabb** **(** :ref:`RID` instance, :ref:`AABB` aabb **)** -.. _class_VisualServer_instance_set_exterior: +.. _class_VisualServer_method_instance_set_exterior: - void **instance_set_exterior** **(** :ref:`RID` instance, :ref:`bool` enabled **)** -.. _class_VisualServer_instance_set_extra_visibility_margin: +.. _class_VisualServer_method_instance_set_extra_visibility_margin: - void **instance_set_extra_visibility_margin** **(** :ref:`RID` instance, :ref:`float` margin **)** -.. _class_VisualServer_instance_set_layer_mask: +.. _class_VisualServer_method_instance_set_layer_mask: - void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** -.. _class_VisualServer_instance_set_scenario: +.. _class_VisualServer_method_instance_set_scenario: - void **instance_set_scenario** **(** :ref:`RID` instance, :ref:`RID` scenario **)** -.. _class_VisualServer_instance_set_surface_material: +.. _class_VisualServer_method_instance_set_surface_material: - void **instance_set_surface_material** **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** -.. _class_VisualServer_instance_set_transform: +.. _class_VisualServer_method_instance_set_transform: - void **instance_set_transform** **(** :ref:`RID` instance, :ref:`Transform` transform **)** -.. _class_VisualServer_instance_set_use_lightmap: +.. _class_VisualServer_method_instance_set_use_lightmap: - void **instance_set_use_lightmap** **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** -.. _class_VisualServer_instance_set_visible: +.. _class_VisualServer_method_instance_set_visible: - void **instance_set_visible** **(** :ref:`RID` instance, :ref:`bool` visible **)** -.. _class_VisualServer_instances_cull_aabb: +.. _class_VisualServer_method_instances_cull_aabb: - :ref:`Array` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const -.. _class_VisualServer_instances_cull_convex: +.. _class_VisualServer_method_instances_cull_convex: - :ref:`Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** const -.. _class_VisualServer_instances_cull_ray: +.. _class_VisualServer_method_instances_cull_ray: - :ref:`Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const -.. _class_VisualServer_light_directional_set_blend_splits: +.. _class_VisualServer_method_light_directional_set_blend_splits: - void **light_directional_set_blend_splits** **(** :ref:`RID` light, :ref:`bool` enable **)** -.. _class_VisualServer_light_directional_set_shadow_depth_range_mode: +.. _class_VisualServer_method_light_directional_set_shadow_depth_range_mode: - void **light_directional_set_shadow_depth_range_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** -.. _class_VisualServer_light_directional_set_shadow_mode: +.. _class_VisualServer_method_light_directional_set_shadow_mode: - void **light_directional_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** -.. _class_VisualServer_light_omni_set_shadow_detail: +.. _class_VisualServer_method_light_omni_set_shadow_detail: - void **light_omni_set_shadow_detail** **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** -.. _class_VisualServer_light_omni_set_shadow_mode: +.. _class_VisualServer_method_light_omni_set_shadow_mode: - void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** -.. _class_VisualServer_light_set_color: +.. _class_VisualServer_method_light_set_color: - void **light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** -.. _class_VisualServer_light_set_cull_mask: +.. _class_VisualServer_method_light_set_cull_mask: - void **light_set_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** -.. _class_VisualServer_light_set_negative: +.. _class_VisualServer_method_light_set_negative: - void **light_set_negative** **(** :ref:`RID` light, :ref:`bool` enable **)** -.. _class_VisualServer_light_set_param: +.. _class_VisualServer_method_light_set_param: - void **light_set_param** **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** -.. _class_VisualServer_light_set_projector: +.. _class_VisualServer_method_light_set_projector: - void **light_set_projector** **(** :ref:`RID` light, :ref:`RID` texture **)** -.. _class_VisualServer_light_set_reverse_cull_face_mode: +.. _class_VisualServer_method_light_set_reverse_cull_face_mode: - void **light_set_reverse_cull_face_mode** **(** :ref:`RID` light, :ref:`bool` enabled **)** -.. _class_VisualServer_light_set_shadow: +.. _class_VisualServer_method_light_set_shadow: - void **light_set_shadow** **(** :ref:`RID` light, :ref:`bool` enabled **)** -.. _class_VisualServer_light_set_shadow_color: +.. _class_VisualServer_method_light_set_shadow_color: - void **light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** -.. _class_VisualServer_lightmap_capture_create: +.. _class_VisualServer_method_lightmap_capture_create: - :ref:`RID` **lightmap_capture_create** **(** **)** -.. _class_VisualServer_lightmap_capture_get_bounds: +.. _class_VisualServer_method_lightmap_capture_get_bounds: - :ref:`AABB` **lightmap_capture_get_bounds** **(** :ref:`RID` capture **)** const -.. _class_VisualServer_lightmap_capture_get_energy: +.. _class_VisualServer_method_lightmap_capture_get_energy: - :ref:`float` **lightmap_capture_get_energy** **(** :ref:`RID` capture **)** const -.. _class_VisualServer_lightmap_capture_get_octree: +.. _class_VisualServer_method_lightmap_capture_get_octree: - :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const -.. _class_VisualServer_lightmap_capture_get_octree_cell_subdiv: +.. _class_VisualServer_method_lightmap_capture_get_octree_cell_subdiv: - :ref:`int` **lightmap_capture_get_octree_cell_subdiv** **(** :ref:`RID` capture **)** const -.. _class_VisualServer_lightmap_capture_get_octree_cell_transform: +.. _class_VisualServer_method_lightmap_capture_get_octree_cell_transform: - :ref:`Transform` **lightmap_capture_get_octree_cell_transform** **(** :ref:`RID` capture **)** const -.. _class_VisualServer_lightmap_capture_set_bounds: +.. _class_VisualServer_method_lightmap_capture_set_bounds: - void **lightmap_capture_set_bounds** **(** :ref:`RID` capture, :ref:`AABB` bounds **)** -.. _class_VisualServer_lightmap_capture_set_energy: +.. _class_VisualServer_method_lightmap_capture_set_energy: - void **lightmap_capture_set_energy** **(** :ref:`RID` capture, :ref:`float` energy **)** -.. _class_VisualServer_lightmap_capture_set_octree: +.. _class_VisualServer_method_lightmap_capture_set_octree: - void **lightmap_capture_set_octree** **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** -.. _class_VisualServer_lightmap_capture_set_octree_cell_subdiv: +.. _class_VisualServer_method_lightmap_capture_set_octree_cell_subdiv: - void **lightmap_capture_set_octree_cell_subdiv** **(** :ref:`RID` capture, :ref:`int` subdiv **)** -.. _class_VisualServer_lightmap_capture_set_octree_cell_transform: +.. _class_VisualServer_method_lightmap_capture_set_octree_cell_transform: - void **lightmap_capture_set_octree_cell_transform** **(** :ref:`RID` capture, :ref:`Transform` xform **)** -.. _class_VisualServer_make_sphere_mesh: +.. _class_VisualServer_method_make_sphere_mesh: - :ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions. -.. _class_VisualServer_material_create: +.. _class_VisualServer_method_material_create: - :ref:`RID` **material_create** **(** **)** Returns an empty material. -.. _class_VisualServer_material_get_param: +.. _class_VisualServer_method_material_get_param: - :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** const Returns the value of a certain material's parameter. -.. _class_VisualServer_material_get_param_default: +.. _class_VisualServer_method_material_get_param_default: - :ref:`Variant` **material_get_param_default** **(** :ref:`RID` material, :ref:`String` parameter **)** const -.. _class_VisualServer_material_get_shader: +.. _class_VisualServer_method_material_get_shader: - :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. -.. _class_VisualServer_material_set_line_width: +.. _class_VisualServer_method_material_set_line_width: - void **material_set_line_width** **(** :ref:`RID` material, :ref:`float` width **)** Sets a materials line width. -.. _class_VisualServer_material_set_next_pass: +.. _class_VisualServer_method_material_set_next_pass: - void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** Sets an objects next material. -.. _class_VisualServer_material_set_param: +.. _class_VisualServer_method_material_set_param: - void **material_set_param** **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** Sets a materials parameter. -.. _class_VisualServer_material_set_render_priority: +.. _class_VisualServer_method_material_set_render_priority: - void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** Sets a material's render priority. -.. _class_VisualServer_material_set_shader: +.. _class_VisualServer_method_material_set_shader: - void **material_set_shader** **(** :ref:`RID` shader_material, :ref:`RID` shader **)** Sets a shader material's shader. -.. _class_VisualServer_mesh_add_surface_from_arrays: +.. _class_VisualServer_method_mesh_add_surface_from_arrays: - void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE\_\* constants for types. -.. _class_VisualServer_mesh_clear: +.. _class_VisualServer_method_mesh_clear: - void **mesh_clear** **(** :ref:`RID` mesh **)** Removes all surfaces from a mesh. -.. _class_VisualServer_mesh_create: +.. _class_VisualServer_method_mesh_create: - :ref:`RID` **mesh_create** **(** **)** Creates a new mesh. -.. _class_VisualServer_mesh_get_blend_shape_count: +.. _class_VisualServer_method_mesh_get_blend_shape_count: - :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** const Returns a mesh's blend shape count. -.. _class_VisualServer_mesh_get_blend_shape_mode: +.. _class_VisualServer_method_mesh_get_blend_shape_mode: - :ref:`BlendShapeMode` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** const Returns a mesh's blend shape mode. -.. _class_VisualServer_mesh_get_custom_aabb: +.. _class_VisualServer_method_mesh_get_custom_aabb: - :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const Returns a mesh's custom aabb. -.. _class_VisualServer_mesh_get_surface_count: +.. _class_VisualServer_method_mesh_get_surface_count: - :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** const Returns a mesh's number of surfaces. -.. _class_VisualServer_mesh_remove_surface: +.. _class_VisualServer_method_mesh_remove_surface: - void **mesh_remove_surface** **(** :ref:`RID` mesh, :ref:`int` index **)** Removes a mesh's surface. -.. _class_VisualServer_mesh_set_blend_shape_count: +.. _class_VisualServer_method_mesh_set_blend_shape_count: - void **mesh_set_blend_shape_count** **(** :ref:`RID` mesh, :ref:`int` amount **)** Sets a mesh's blend shape count. -.. _class_VisualServer_mesh_set_blend_shape_mode: +.. _class_VisualServer_method_mesh_set_blend_shape_mode: - void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** Sets a mesh's blend shape mode. -.. _class_VisualServer_mesh_set_custom_aabb: +.. _class_VisualServer_method_mesh_set_custom_aabb: - void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** Sets a mesh's custom aabb. -.. _class_VisualServer_mesh_surface_get_aabb: +.. _class_VisualServer_method_mesh_surface_get_aabb: - :ref:`AABB` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's aabb. -.. _class_VisualServer_mesh_surface_get_array: +.. _class_VisualServer_method_mesh_surface_get_array: - :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's vertex buffer. -.. _class_VisualServer_mesh_surface_get_array_index_len: +.. _class_VisualServer_method_mesh_surface_get_array_index_len: - :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's amount of indices. -.. _class_VisualServer_mesh_surface_get_array_len: +.. _class_VisualServer_method_mesh_surface_get_array_len: - :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's amount of vertices. -.. _class_VisualServer_mesh_surface_get_arrays: +.. _class_VisualServer_method_mesh_surface_get_arrays: - :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's buffer arrays. -.. _class_VisualServer_mesh_surface_get_blend_shape_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 Returns a mesh's surface's arrays for blend shapes -.. _class_VisualServer_mesh_surface_get_format: +.. _class_VisualServer_method_mesh_surface_get_format: - :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the format of a mesh's surface. -.. _class_VisualServer_mesh_surface_get_format_offset: +.. _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 -.. _class_VisualServer_mesh_surface_get_format_stride: +.. _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 -.. _class_VisualServer_mesh_surface_get_index_array: +.. _class_VisualServer_method_mesh_surface_get_index_array: - :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's index buffer. -.. _class_VisualServer_mesh_surface_get_material: +.. _class_VisualServer_method_mesh_surface_get_material: - :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's material. -.. _class_VisualServer_mesh_surface_get_primitive_type: +.. _class_VisualServer_method_mesh_surface_get_primitive_type: - :ref:`PrimitiveType` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the primitive type of a mesh's surface. -.. _class_VisualServer_mesh_surface_get_skeleton_aabb: +.. _class_VisualServer_method_mesh_surface_get_skeleton_aabb: - :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the aabb of a mesh's surface's skeleton. -.. _class_VisualServer_mesh_surface_set_material: +.. _class_VisualServer_method_mesh_surface_set_material: - void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** Sets a mesh's surface's material. -.. _class_VisualServer_mesh_surface_update_region: +.. _class_VisualServer_method_mesh_surface_update_region: - void **mesh_surface_update_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** -.. _class_VisualServer_multimesh_allocate: +.. _class_VisualServer_method_multimesh_allocate: -- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** +- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, VisualServer.MultimeshCustomDataFormat custom_data_format=0 **)** -.. _class_VisualServer_multimesh_get_aabb: +.. _class_VisualServer_method_multimesh_get_aabb: - :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** const -.. _class_VisualServer_multimesh_get_instance_count: +.. _class_VisualServer_method_multimesh_get_instance_count: - :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** const -.. _class_VisualServer_multimesh_get_mesh: +.. _class_VisualServer_method_multimesh_get_mesh: - :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** const -.. _class_VisualServer_multimesh_get_visible_instances: +.. _class_VisualServer_method_multimesh_get_visible_instances: - :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** const -.. _class_VisualServer_multimesh_instance_get_color: +.. _class_VisualServer_method_multimesh_instance_get_color: - :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** const -.. _class_VisualServer_multimesh_instance_get_custom_data: +.. _class_VisualServer_method_multimesh_instance_get_custom_data: - :ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** const -.. _class_VisualServer_multimesh_instance_get_transform: +.. _class_VisualServer_method_multimesh_instance_get_transform: - :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** const -.. _class_VisualServer_multimesh_instance_get_transform_2d: +.. _class_VisualServer_method_multimesh_instance_get_transform_2d: - :ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** const -.. _class_VisualServer_multimesh_instance_set_color: +.. _class_VisualServer_method_multimesh_instance_set_color: - void **multimesh_instance_set_color** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** -.. _class_VisualServer_multimesh_instance_set_custom_data: +.. _class_VisualServer_method_multimesh_instance_set_custom_data: - void **multimesh_instance_set_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** -.. _class_VisualServer_multimesh_instance_set_transform: +.. _class_VisualServer_method_multimesh_instance_set_transform: - void **multimesh_instance_set_transform** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** -.. _class_VisualServer_multimesh_instance_set_transform_2d: +.. _class_VisualServer_method_multimesh_instance_set_transform_2d: - void **multimesh_instance_set_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** -.. _class_VisualServer_multimesh_set_as_bulk_array: +.. _class_VisualServer_method_multimesh_set_as_bulk_array: - void **multimesh_set_as_bulk_array** **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** -.. _class_VisualServer_multimesh_set_mesh: +.. _class_VisualServer_method_multimesh_set_mesh: - void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** -.. _class_VisualServer_multimesh_set_visible_instances: +.. _class_VisualServer_method_multimesh_set_visible_instances: - void **multimesh_set_visible_instances** **(** :ref:`RID` multimesh, :ref:`int` visible **)** -.. _class_VisualServer_omni_light_create: +.. _class_VisualServer_method_omni_light_create: - :ref:`RID` **omni_light_create** **(** **)** -.. _class_VisualServer_particles_create: +.. _class_VisualServer_method_particles_create: - :ref:`RID` **particles_create** **(** **)** -.. _class_VisualServer_particles_get_current_aabb: +.. _class_VisualServer_method_particles_get_current_aabb: - :ref:`AABB` **particles_get_current_aabb** **(** :ref:`RID` particles **)** -.. _class_VisualServer_particles_get_emitting: +.. _class_VisualServer_method_particles_get_emitting: - :ref:`bool` **particles_get_emitting** **(** :ref:`RID` particles **)** -.. _class_VisualServer_particles_restart: +.. _class_VisualServer_method_particles_restart: - void **particles_restart** **(** :ref:`RID` particles **)** -.. _class_VisualServer_particles_set_amount: +.. _class_VisualServer_method_particles_set_amount: - void **particles_set_amount** **(** :ref:`RID` particles, :ref:`int` amount **)** -.. _class_VisualServer_particles_set_custom_aabb: +.. _class_VisualServer_method_particles_set_custom_aabb: - void **particles_set_custom_aabb** **(** :ref:`RID` particles, :ref:`AABB` aabb **)** -.. _class_VisualServer_particles_set_draw_order: +.. _class_VisualServer_method_particles_set_draw_order: - void **particles_set_draw_order** **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** -.. _class_VisualServer_particles_set_draw_pass_mesh: +.. _class_VisualServer_method_particles_set_draw_pass_mesh: - void **particles_set_draw_pass_mesh** **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** -.. _class_VisualServer_particles_set_draw_passes: +.. _class_VisualServer_method_particles_set_draw_passes: - void **particles_set_draw_passes** **(** :ref:`RID` particles, :ref:`int` count **)** -.. _class_VisualServer_particles_set_emission_transform: +.. _class_VisualServer_method_particles_set_emission_transform: - void **particles_set_emission_transform** **(** :ref:`RID` particles, :ref:`Transform` transform **)** -.. _class_VisualServer_particles_set_emitting: +.. _class_VisualServer_method_particles_set_emitting: - void **particles_set_emitting** **(** :ref:`RID` particles, :ref:`bool` emitting **)** -.. _class_VisualServer_particles_set_explosiveness_ratio: +.. _class_VisualServer_method_particles_set_explosiveness_ratio: - void **particles_set_explosiveness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** -.. _class_VisualServer_particles_set_fixed_fps: +.. _class_VisualServer_method_particles_set_fixed_fps: - void **particles_set_fixed_fps** **(** :ref:`RID` particles, :ref:`int` fps **)** -.. _class_VisualServer_particles_set_fractional_delta: +.. _class_VisualServer_method_particles_set_fractional_delta: - void **particles_set_fractional_delta** **(** :ref:`RID` particles, :ref:`bool` enable **)** -.. _class_VisualServer_particles_set_lifetime: +.. _class_VisualServer_method_particles_set_lifetime: - void **particles_set_lifetime** **(** :ref:`RID` particles, :ref:`float` lifetime **)** -.. _class_VisualServer_particles_set_one_shot: +.. _class_VisualServer_method_particles_set_one_shot: - void **particles_set_one_shot** **(** :ref:`RID` particles, :ref:`bool` one_shot **)** -.. _class_VisualServer_particles_set_pre_process_time: +.. _class_VisualServer_method_particles_set_pre_process_time: - void **particles_set_pre_process_time** **(** :ref:`RID` particles, :ref:`float` time **)** -.. _class_VisualServer_particles_set_process_material: +.. _class_VisualServer_method_particles_set_process_material: - void **particles_set_process_material** **(** :ref:`RID` particles, :ref:`RID` material **)** -.. _class_VisualServer_particles_set_randomness_ratio: +.. _class_VisualServer_method_particles_set_randomness_ratio: - void **particles_set_randomness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** -.. _class_VisualServer_particles_set_speed_scale: +.. _class_VisualServer_method_particles_set_speed_scale: - void **particles_set_speed_scale** **(** :ref:`RID` particles, :ref:`float` scale **)** -.. _class_VisualServer_particles_set_use_local_coordinates: +.. _class_VisualServer_method_particles_set_use_local_coordinates: - void **particles_set_use_local_coordinates** **(** :ref:`RID` particles, :ref:`bool` enable **)** -.. _class_VisualServer_reflection_probe_create: +.. _class_VisualServer_method_reflection_probe_create: - :ref:`RID` **reflection_probe_create** **(** **)** -.. _class_VisualServer_reflection_probe_set_as_interior: +.. _class_VisualServer_method_reflection_probe_set_as_interior: - void **reflection_probe_set_as_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** -.. _class_VisualServer_reflection_probe_set_cull_mask: +.. _class_VisualServer_method_reflection_probe_set_cull_mask: - void **reflection_probe_set_cull_mask** **(** :ref:`RID` probe, :ref:`int` layers **)** -.. _class_VisualServer_reflection_probe_set_enable_box_projection: +.. _class_VisualServer_method_reflection_probe_set_enable_box_projection: - void **reflection_probe_set_enable_box_projection** **(** :ref:`RID` probe, :ref:`bool` enable **)** -.. _class_VisualServer_reflection_probe_set_enable_shadows: +.. _class_VisualServer_method_reflection_probe_set_enable_shadows: - void **reflection_probe_set_enable_shadows** **(** :ref:`RID` probe, :ref:`bool` enable **)** -.. _class_VisualServer_reflection_probe_set_extents: +.. _class_VisualServer_method_reflection_probe_set_extents: - void **reflection_probe_set_extents** **(** :ref:`RID` probe, :ref:`Vector3` extents **)** -.. _class_VisualServer_reflection_probe_set_intensity: +.. _class_VisualServer_method_reflection_probe_set_intensity: - void **reflection_probe_set_intensity** **(** :ref:`RID` probe, :ref:`float` intensity **)** -.. _class_VisualServer_reflection_probe_set_interior_ambient: +.. _class_VisualServer_method_reflection_probe_set_interior_ambient: - void **reflection_probe_set_interior_ambient** **(** :ref:`RID` probe, :ref:`Color` color **)** -.. _class_VisualServer_reflection_probe_set_interior_ambient_energy: +.. _class_VisualServer_method_reflection_probe_set_interior_ambient_energy: - void **reflection_probe_set_interior_ambient_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** -.. _class_VisualServer_reflection_probe_set_interior_ambient_probe_contribution: +.. _class_VisualServer_method_reflection_probe_set_interior_ambient_probe_contribution: - void **reflection_probe_set_interior_ambient_probe_contribution** **(** :ref:`RID` probe, :ref:`float` contrib **)** -.. _class_VisualServer_reflection_probe_set_max_distance: +.. _class_VisualServer_method_reflection_probe_set_max_distance: - void **reflection_probe_set_max_distance** **(** :ref:`RID` probe, :ref:`float` distance **)** -.. _class_VisualServer_reflection_probe_set_origin_offset: +.. _class_VisualServer_method_reflection_probe_set_origin_offset: - void **reflection_probe_set_origin_offset** **(** :ref:`RID` probe, :ref:`Vector3` offset **)** -.. _class_VisualServer_reflection_probe_set_update_mode: +.. _class_VisualServer_method_reflection_probe_set_update_mode: - void **reflection_probe_set_update_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** -.. _class_VisualServer_request_frame_drawn_callback: +.. _class_VisualServer_method_request_frame_drawn_callback: - void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** @@ -2686,289 +3106,289 @@ Schedules a callback to the corresponding named 'method' on 'where' after a fram The callback method must use only 1 argument which will be called with 'userdata'. -.. _class_VisualServer_scenario_create: +.. _class_VisualServer_method_scenario_create: - :ref:`RID` **scenario_create** **(** **)** -.. _class_VisualServer_scenario_set_debug: +.. _class_VisualServer_method_scenario_set_debug: - void **scenario_set_debug** **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** -.. _class_VisualServer_scenario_set_environment: +.. _class_VisualServer_method_scenario_set_environment: - void **scenario_set_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** -.. _class_VisualServer_scenario_set_fallback_environment: +.. _class_VisualServer_method_scenario_set_fallback_environment: - void **scenario_set_fallback_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** -.. _class_VisualServer_scenario_set_reflection_atlas_size: +.. _class_VisualServer_method_scenario_set_reflection_atlas_size: - void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` size, :ref:`int` subdiv **)** -.. _class_VisualServer_set_boot_image: +.. _class_VisualServer_method_set_boot_image: - void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** Sets a boot image. The color defines the background color and if scale is ``true`` the image will be scaled to fit the screen size. -.. _class_VisualServer_set_debug_generate_wireframes: +.. _class_VisualServer_method_set_debug_generate_wireframes: - void **set_debug_generate_wireframes** **(** :ref:`bool` generate **)** -.. _class_VisualServer_set_default_clear_color: +.. _class_VisualServer_method_set_default_clear_color: - void **set_default_clear_color** **(** :ref:`Color` color **)** -.. _class_VisualServer_shader_create: +.. _class_VisualServer_method_shader_create: - :ref:`RID` **shader_create** **(** **)** Creates an empty shader. -.. _class_VisualServer_shader_get_code: +.. _class_VisualServer_method_shader_get_code: - :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** const Returns a shader's code. -.. _class_VisualServer_shader_get_default_texture_param: +.. _class_VisualServer_method_shader_get_default_texture_param: - :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** const Returns a default texture from a shader searched by name. -.. _class_VisualServer_shader_get_param_list: +.. _class_VisualServer_method_shader_get_param_list: - :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const Returns the parameters of a shader. -.. _class_VisualServer_shader_set_code: +.. _class_VisualServer_method_shader_set_code: - void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** Sets a shader's code. -.. _class_VisualServer_shader_set_default_texture_param: +.. _class_VisualServer_method_shader_set_default_texture_param: - void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** Sets a shader's default texture. Overwrites the texture given by name. -.. _class_VisualServer_skeleton_allocate: +.. _class_VisualServer_method_skeleton_allocate: - void **skeleton_allocate** **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** -.. _class_VisualServer_skeleton_bone_get_transform: +.. _class_VisualServer_method_skeleton_bone_get_transform: - :ref:`Transform` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const -.. _class_VisualServer_skeleton_bone_get_transform_2d: +.. _class_VisualServer_method_skeleton_bone_get_transform_2d: - :ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const -.. _class_VisualServer_skeleton_bone_set_transform: +.. _class_VisualServer_method_skeleton_bone_set_transform: - void **skeleton_bone_set_transform** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** -.. _class_VisualServer_skeleton_bone_set_transform_2d: +.. _class_VisualServer_method_skeleton_bone_set_transform_2d: - void **skeleton_bone_set_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** -.. _class_VisualServer_skeleton_create: +.. _class_VisualServer_method_skeleton_create: - :ref:`RID` **skeleton_create** **(** **)** -.. _class_VisualServer_skeleton_get_bone_count: +.. _class_VisualServer_method_skeleton_get_bone_count: - :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** const -.. _class_VisualServer_sky_create: +.. _class_VisualServer_method_sky_create: - :ref:`RID` **sky_create** **(** **)** Creates an empty sky. -.. _class_VisualServer_sky_set_texture: +.. _class_VisualServer_method_sky_set_texture: - void **sky_set_texture** **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** Sets a sky's texture. -.. _class_VisualServer_spot_light_create: +.. _class_VisualServer_method_spot_light_create: - :ref:`RID` **spot_light_create** **(** **)** -.. _class_VisualServer_sync: +.. _class_VisualServer_method_sync: - void **sync** **(** **)** -.. _class_VisualServer_texture_allocate: +.. _class_VisualServer_method_texture_allocate: - void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** -.. _class_VisualServer_texture_create: +.. _class_VisualServer_method_texture_create: - :ref:`RID` **texture_create** **(** **)** Creates an empty texture. -.. _class_VisualServer_texture_create_from_image: +.. _class_VisualServer_method_texture_create_from_image: - :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** Creates a texture, allocates the space for an image, and fills in the image. -.. _class_VisualServer_texture_debug_usage: +.. _class_VisualServer_method_texture_debug_usage: - :ref:`Array` **texture_debug_usage** **(** **)** Returns a list of all the textures and their information. -.. _class_VisualServer_texture_get_data: +.. _class_VisualServer_method_texture_get_data: - :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. -.. _class_VisualServer_texture_get_depth: +.. _class_VisualServer_method_texture_get_depth: - :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** const -.. _class_VisualServer_texture_get_flags: +.. _class_VisualServer_method_texture_get_flags: - :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const Returns the flags of a texture. -.. _class_VisualServer_texture_get_format: +.. _class_VisualServer_method_texture_get_format: - :ref:`Format` **texture_get_format** **(** :ref:`RID` texture **)** const Returns the format of the texture's image. -.. _class_VisualServer_texture_get_height: +.. _class_VisualServer_method_texture_get_height: - :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const Returns the texture's height. -.. _class_VisualServer_texture_get_path: +.. _class_VisualServer_method_texture_get_path: - :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const Returns the texture's path. -.. _class_VisualServer_texture_get_texid: +.. _class_VisualServer_method_texture_get_texid: - :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const Returns the opengl id of the texture's image. -.. _class_VisualServer_texture_get_type: +.. _class_VisualServer_method_texture_get_type: - :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** const -.. _class_VisualServer_texture_get_width: +.. _class_VisualServer_method_texture_get_width: - :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const Returns the texture's width. -.. _class_VisualServer_texture_set_data: +.. _class_VisualServer_method_texture_set_data: - void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. -.. _class_VisualServer_texture_set_data_partial: +.. _class_VisualServer_method_texture_set_data_partial: - void **texture_set_data_partial** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** -.. _class_VisualServer_texture_set_flags: +.. _class_VisualServer_method_texture_set_flags: - void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** -Sets the texture's flags. See :ref:`TextureFlags` for options +Sets the texture's flags. See :ref:`TextureFlags` for options -.. _class_VisualServer_texture_set_path: +.. _class_VisualServer_method_texture_set_path: - void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** Sets the texture's path. -.. _class_VisualServer_texture_set_shrink_all_x2_on_set_data: +.. _class_VisualServer_method_texture_set_shrink_all_x2_on_set_data: - void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool` shrink **)** If ``true``, sets internal processes to shrink all image data to half the size. -.. _class_VisualServer_texture_set_size_override: +.. _class_VisualServer_method_texture_set_size_override: - void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** -.. _class_VisualServer_textures_keep_original: +.. _class_VisualServer_method_textures_keep_original: - void **textures_keep_original** **(** :ref:`bool` enable **)** If ``true``, the image will be stored in the texture's images array if overwritten. -.. _class_VisualServer_viewport_attach_camera: +.. _class_VisualServer_method_viewport_attach_camera: - void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** Sets a viewport's camera. -.. _class_VisualServer_viewport_attach_canvas: +.. _class_VisualServer_method_viewport_attach_canvas: - void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** Sets a viewport's canvas. -.. _class_VisualServer_viewport_attach_to_screen: +.. _class_VisualServer_method_viewport_attach_to_screen: - void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** Attaches a viewport to a screen. -.. _class_VisualServer_viewport_create: +.. _class_VisualServer_method_viewport_create: - :ref:`RID` **viewport_create** **(** **)** Creates an empty viewport. -.. _class_VisualServer_viewport_detach: +.. _class_VisualServer_method_viewport_detach: - void **viewport_detach** **(** :ref:`RID` viewport **)** Detaches the viewport from the screen. -.. _class_VisualServer_viewport_get_render_info: +.. _class_VisualServer_method_viewport_get_render_info: - :ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO\* constants. -.. _class_VisualServer_viewport_get_texture: +.. _class_VisualServer_method_viewport_get_texture: - :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** const Returns the viewport's last rendered frame. -.. _class_VisualServer_viewport_remove_canvas: +.. _class_VisualServer_method_viewport_remove_canvas: - void **viewport_remove_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** Detaches a viewport from a canvas and vice versa. -.. _class_VisualServer_viewport_set_active: +.. _class_VisualServer_method_viewport_set_active: - void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** If ``true``, sets the viewport active, else sets it inactive. -.. _class_VisualServer_viewport_set_canvas_stacking: +.. _class_VisualServer_method_viewport_set_canvas_stacking: - void **viewport_set_canvas_stacking** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** @@ -2976,121 +3396,121 @@ Sets the stacking order for a viewport's canvas. ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer. -.. _class_VisualServer_viewport_set_canvas_transform: +.. _class_VisualServer_method_viewport_set_canvas_transform: - void **viewport_set_canvas_transform** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** Sets the transformation of a viewport's canvas. -.. _class_VisualServer_viewport_set_clear_mode: +.. _class_VisualServer_method_viewport_set_clear_mode: - void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** Sets the clear mode of a viewport. See :ref:`ViewportClearMode` for options. -.. _class_VisualServer_viewport_set_debug_draw: +.. _class_VisualServer_method_viewport_set_debug_draw: - void **viewport_set_debug_draw** **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw` for options. -.. _class_VisualServer_viewport_set_disable_3d: +.. _class_VisualServer_method_viewport_set_disable_3d: - void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** If ``true``, a viewport's 3D rendering is disabled. -.. _class_VisualServer_viewport_set_disable_environment: +.. _class_VisualServer_method_viewport_set_disable_environment: - void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** If ``true``, rendering of a viewport's environment is disabled. -.. _class_VisualServer_viewport_set_global_canvas_transform: +.. _class_VisualServer_method_viewport_set_global_canvas_transform: - void **viewport_set_global_canvas_transform** **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** Sets the viewport's global transformation matrix. -.. _class_VisualServer_viewport_set_hdr: +.. _class_VisualServer_method_viewport_set_hdr: - void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** If ``true``, the viewport renders to hdr. -.. _class_VisualServer_viewport_set_hide_canvas: +.. _class_VisualServer_method_viewport_set_hide_canvas: - void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** If ``true``, the viewport's canvas is not rendered. -.. _class_VisualServer_viewport_set_hide_scenario: +.. _class_VisualServer_method_viewport_set_hide_scenario: - void **viewport_set_hide_scenario** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** -.. _class_VisualServer_viewport_set_msaa: +.. _class_VisualServer_method_viewport_set_msaa: - void **viewport_set_msaa** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** -Sets the anti-aliasing mode. see :ref:`ViewportMSAA` for options. +Sets the anti-aliasing mode. see :ref:`ViewportMSAA` for options. -.. _class_VisualServer_viewport_set_parent_viewport: +.. _class_VisualServer_method_viewport_set_parent_viewport: - void **viewport_set_parent_viewport** **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** Sets the viewport's parent to another viewport. -.. _class_VisualServer_viewport_set_scenario: +.. _class_VisualServer_method_viewport_set_scenario: - void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** Sets a viewport's scenario. -The scenario contains information about the :ref:`ScenarioDebugMode`, environment information, reflection atlas etc. +The scenario contains information about the :ref:`ScenarioDebugMode`, environment information, reflection atlas etc. -.. _class_VisualServer_viewport_set_shadow_atlas_quadrant_subdivision: +.. _class_VisualServer_method_viewport_set_shadow_atlas_quadrant_subdivision: - void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** Sets the shadow atlas quadrant's subdivision. -.. _class_VisualServer_viewport_set_shadow_atlas_size: +.. _class_VisualServer_method_viewport_set_shadow_atlas_size: - void **viewport_set_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size **)** Sets the size of the shadow atlas's images. -.. _class_VisualServer_viewport_set_size: +.. _class_VisualServer_method_viewport_set_size: - void **viewport_set_size** **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** Sets the viewport's width and height. -.. _class_VisualServer_viewport_set_transparent_background: +.. _class_VisualServer_method_viewport_set_transparent_background: - void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** If ``true``, the viewport renders its background as transparent. -.. _class_VisualServer_viewport_set_update_mode: +.. _class_VisualServer_method_viewport_set_update_mode: - void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** -Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` constants for options. +Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` constants for options. -.. _class_VisualServer_viewport_set_usage: +.. _class_VisualServer_method_viewport_set_usage: - void **viewport_set_usage** **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** -Sets the viewport's 2D/3D mode. See :ref:`ViewportUsage` constants for options. +Sets the viewport's 2D/3D mode. See :ref:`ViewportUsage` constants for options. -.. _class_VisualServer_viewport_set_use_arvr: +.. _class_VisualServer_method_viewport_set_use_arvr: - void **viewport_set_use_arvr** **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`ARVRInterface`. -.. _class_VisualServer_viewport_set_vflip: +.. _class_VisualServer_method_viewport_set_vflip: - void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index 9e54f71b0..32690c260 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -19,46 +19,54 @@ Brief Description Properties ---------- -+-------------------------------+------------------------------------------------------+ -| :ref:`Vector2` | :ref:`graph_offset` | -+-------------------------------+------------------------------------------------------+ ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`graph_offset` | ++-------------------------------+---------------------------------------------------------------+ 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:`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:`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 ------------ .. _enum_VisualShader_Type: +.. _class_VisualShader_constant_TYPE_VERTEX: + +.. _class_VisualShader_constant_TYPE_FRAGMENT: + +.. _class_VisualShader_constant_TYPE_LIGHT: + +.. _class_VisualShader_constant_TYPE_MAX: + enum **Type**: - **TYPE_VERTEX** = **0** @@ -72,6 +80,10 @@ enum **Type**: Constants --------- +.. _class_VisualShader_constant_NODE_ID_INVALID: + +.. _class_VisualShader_constant_NODE_ID_OUTPUT: + - **NODE_ID_INVALID** = **-1** - **NODE_ID_OUTPUT** = **0** @@ -79,7 +91,7 @@ Constants Property Descriptions --------------------- -.. _class_VisualShader_graph_offset: +.. _class_VisualShader_property_graph_offset: - :ref:`Vector2` **graph_offset** @@ -92,55 +104,55 @@ Property Descriptions Method Descriptions ------------------- -.. _class_VisualShader_add_node: +.. _class_VisualShader_method_add_node: - void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** -.. _class_VisualShader_can_connect_nodes: +.. _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 -.. _class_VisualShader_connect_nodes: +.. _class_VisualShader_method_connect_nodes: - :ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** -.. _class_VisualShader_disconnect_nodes: +.. _class_VisualShader_method_disconnect_nodes: - void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** -.. _class_VisualShader_get_node: +.. _class_VisualShader_method_get_node: - :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** const -.. _class_VisualShader_get_node_connections: +.. _class_VisualShader_method_get_node_connections: - :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** const -.. _class_VisualShader_get_node_list: +.. _class_VisualShader_method_get_node_list: - :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** const -.. _class_VisualShader_get_node_position: +.. _class_VisualShader_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** const -.. _class_VisualShader_get_valid_node_id: +.. _class_VisualShader_method_get_valid_node_id: - :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** const -.. _class_VisualShader_is_node_connection: +.. _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 -.. _class_VisualShader_remove_node: +.. _class_VisualShader_method_remove_node: - void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** -.. _class_VisualShader_set_mode: +.. _class_VisualShader_method_set_mode: - void **set_mode** **(** :ref:`Mode` mode **)** -.. _class_VisualShader_set_node_position: +.. _class_VisualShader_method_set_node_position: - void **set_node_position** **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index cf6499056..8767ad7fe 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -21,36 +21,36 @@ Brief Description Properties ---------- -+---------------------------+--------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`default_input_values` | -+---------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`output_port_for_preview` | -+---------------------------+--------------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`default_input_values` | ++---------------------------+-----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`output_port_for_preview` | ++---------------------------+-----------------------------------------------------------------------------------------+ Methods ------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_input_port_default_value` **(** :ref:`int` port **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_port_default_value` **(** :ref:`int` port, :ref:`Variant` value **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_input_port_default_value` **(** :ref:`int` port **)** const | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_port_default_value` **(** :ref:`int` port, :ref:`Variant` value **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_VisualShaderNode_editor_refresh_request: +.. _class_VisualShaderNode_signal_editor_refresh_request: - **editor_refresh_request** **(** **)** Property Descriptions --------------------- -.. _class_VisualShaderNode_default_input_values: +.. _class_VisualShaderNode_property_default_input_values: - :ref:`Array` **default_input_values** -.. _class_VisualShaderNode_output_port_for_preview: +.. _class_VisualShaderNode_property_output_port_for_preview: - :ref:`int` **output_port_for_preview** @@ -63,11 +63,11 @@ Property Descriptions Method Descriptions ------------------- -.. _class_VisualShaderNode_get_input_port_default_value: +.. _class_VisualShaderNode_method_get_input_port_default_value: - :ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** const -.. _class_VisualShaderNode_set_input_port_default_value: +.. _class_VisualShaderNode_method_set_input_port_default_value: - void **set_input_port_default_value** **(** :ref:`int` port, :ref:`Variant` value **)** diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index b53c02d1d..c07045f23 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+---------------------------+---------------------------------------------------------------+ -| :ref:`Color` | :ref:`constant` | -+---------------------------+---------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`constant` | ++---------------------------+------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeColorConstant_constant: +.. _class_VisualShaderNodeColorConstant_property_constant: - :ref:`Color` **constant** diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index 01cb7eeff..cc48a02b4 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -19,15 +19,33 @@ Brief Description Properties ---------- -+--------------------------------------------------------+---------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+--------------------------------------------------------+---------------------------------------------------------+ ++--------------------------------------------------------+------------------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++--------------------------------------------------------+------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeColorOp_Operator: +.. _class_VisualShaderNodeColorOp_constant_OP_SCREEN: + +.. _class_VisualShaderNodeColorOp_constant_OP_DIFFERENCE: + +.. _class_VisualShaderNodeColorOp_constant_OP_DARKEN: + +.. _class_VisualShaderNodeColorOp_constant_OP_LIGHTEN: + +.. _class_VisualShaderNodeColorOp_constant_OP_OVERLAY: + +.. _class_VisualShaderNodeColorOp_constant_OP_DODGE: + +.. _class_VisualShaderNodeColorOp_constant_OP_BURN: + +.. _class_VisualShaderNodeColorOp_constant_OP_SOFT_LIGHT: + +.. _class_VisualShaderNodeColorOp_constant_OP_HARD_LIGHT: + enum **Operator**: - **OP_SCREEN** = **0** @@ -51,7 +69,7 @@ enum **Operator**: Property Descriptions --------------------- -.. _class_VisualShaderNodeColorOp_operator: +.. _class_VisualShaderNodeColorOp_property_operator: - :ref:`Operator` **operator** diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index a8f1b489d..2df4ddb12 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -19,17 +19,23 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`CubeMap` | :ref:`cube_map` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`TextureType` | :ref:`texture_type` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`CubeMap` | :ref:`cube_map` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`TextureType` | :ref:`texture_type` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeCubeMap_TextureType: +.. _class_VisualShaderNodeCubeMap_constant_TYPE_DATA: + +.. _class_VisualShaderNodeCubeMap_constant_TYPE_COLOR: + +.. _class_VisualShaderNodeCubeMap_constant_TYPE_NORMALMAP: + enum **TextureType**: - **TYPE_DATA** = **0** @@ -41,7 +47,7 @@ enum **TextureType**: Property Descriptions --------------------- -.. _class_VisualShaderNodeCubeMap_cube_map: +.. _class_VisualShaderNodeCubeMap_property_cube_map: - :ref:`CubeMap` **cube_map** @@ -51,7 +57,7 @@ Property Descriptions | *Getter* | get_cube_map() | +----------+---------------------+ -.. _class_VisualShaderNodeCubeMap_texture_type: +.. _class_VisualShaderNodeCubeMap_property_texture_type: - :ref:`TextureType` **texture_type** diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 2fb7c39e3..1e42947a3 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -19,21 +19,21 @@ Brief Description Properties ---------- -+-----------------------------+-----------------------------------------------------------+ -| :ref:`String` | :ref:`input_name` | -+-----------------------------+-----------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_name` | ++-----------------------------+--------------------------------------------------------------------+ Signals ------- -.. _class_VisualShaderNodeInput_input_type_changed: +.. _class_VisualShaderNodeInput_signal_input_type_changed: - **input_type_changed** **(** **)** Property Descriptions --------------------- -.. _class_VisualShaderNodeInput_input_name: +.. _class_VisualShaderNodeInput_property_input_name: - :ref:`String` **input_name** diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodescalarconstant.rst index 8e9d76abe..8a3eab290 100644 --- a/classes/class_visualshadernodescalarconstant.rst +++ b/classes/class_visualshadernodescalarconstant.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+---------------------------+----------------------------------------------------------------+ -| :ref:`float` | :ref:`constant` | -+---------------------------+----------------------------------------------------------------+ ++---------------------------+-------------------------------------------------------------------------+ +| :ref:`float` | :ref:`constant` | ++---------------------------+-------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeScalarConstant_constant: +.. _class_VisualShaderNodeScalarConstant_property_constant: - :ref:`float` **constant** diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst index 46426424a..5fef9156d 100644 --- a/classes/class_visualshadernodescalarfunc.rst +++ b/classes/class_visualshadernodescalarfunc.rst @@ -19,15 +19,55 @@ Brief Description Properties ---------- -+-----------------------------------------------------------+------------------------------------------------------------+ -| :ref:`Function` | :ref:`function` | -+-----------------------------------------------------------+------------------------------------------------------------+ ++-----------------------------------------------------------+---------------------------------------------------------------------+ +| :ref:`Function` | :ref:`function` | ++-----------------------------------------------------------+---------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeScalarFunc_Function: +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIN: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_COS: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TAN: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASIN: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOS: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATAN: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SINH: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_COSH: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TANH: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SQRT: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ABS: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIGN: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_FLOOR: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUND: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_CEIL: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_FRAC: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SATURATE: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_NEGATE: + enum **Function**: - **FUNC_SIN** = **0** @@ -73,7 +113,7 @@ enum **Function**: Property Descriptions --------------------- -.. _class_VisualShaderNodeScalarFunc_function: +.. _class_VisualShaderNodeScalarFunc_property_function: - :ref:`Function` **function** diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst index f1da4e0df..24c7f539a 100644 --- a/classes/class_visualshadernodescalarop.rst +++ b/classes/class_visualshadernodescalarop.rst @@ -19,15 +19,33 @@ Brief Description Properties ---------- -+---------------------------------------------------------+----------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+---------------------------------------------------------+----------------------------------------------------------+ ++---------------------------------------------------------+-------------------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++---------------------------------------------------------+-------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeScalarOp_Operator: +.. _class_VisualShaderNodeScalarOp_constant_OP_ADD: + +.. _class_VisualShaderNodeScalarOp_constant_OP_SUB: + +.. _class_VisualShaderNodeScalarOp_constant_OP_MUL: + +.. _class_VisualShaderNodeScalarOp_constant_OP_DIV: + +.. _class_VisualShaderNodeScalarOp_constant_OP_MOD: + +.. _class_VisualShaderNodeScalarOp_constant_OP_POW: + +.. _class_VisualShaderNodeScalarOp_constant_OP_MAX: + +.. _class_VisualShaderNodeScalarOp_constant_OP_MIN: + +.. _class_VisualShaderNodeScalarOp_constant_OP_ATAN2: + enum **Operator**: - **OP_ADD** = **0** @@ -51,7 +69,7 @@ enum **Operator**: Property Descriptions --------------------- -.. _class_VisualShaderNodeScalarOp_operator: +.. _class_VisualShaderNodeScalarOp_property_operator: - :ref:`Operator` **operator** diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index 16608fb8d..0f0eb0b95 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -19,19 +19,27 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Source` | :ref:`source` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ -| :ref:`TextureType` | :ref:`texture_type` | -+--------------------------------------------------------------+-----------------------------------------------------------------+ ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`Source` | :ref:`source` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`TextureType` | :ref:`texture_type` | ++--------------------------------------------------------------+--------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeTexture_Source: +.. _class_VisualShaderNodeTexture_constant_SOURCE_TEXTURE: + +.. _class_VisualShaderNodeTexture_constant_SOURCE_SCREEN: + +.. _class_VisualShaderNodeTexture_constant_SOURCE_2D_TEXTURE: + +.. _class_VisualShaderNodeTexture_constant_SOURCE_2D_NORMAL: + enum **Source**: - **SOURCE_TEXTURE** = **0** @@ -44,6 +52,12 @@ enum **Source**: .. _enum_VisualShaderNodeTexture_TextureType: +.. _class_VisualShaderNodeTexture_constant_TYPE_DATA: + +.. _class_VisualShaderNodeTexture_constant_TYPE_COLOR: + +.. _class_VisualShaderNodeTexture_constant_TYPE_NORMALMAP: + enum **TextureType**: - **TYPE_DATA** = **0** @@ -55,7 +69,7 @@ enum **TextureType**: Property Descriptions --------------------- -.. _class_VisualShaderNodeTexture_source: +.. _class_VisualShaderNodeTexture_property_source: - :ref:`Source` **source** @@ -65,7 +79,7 @@ Property Descriptions | *Getter* | get_source() | +----------+-------------------+ -.. _class_VisualShaderNodeTexture_texture: +.. _class_VisualShaderNodeTexture_property_texture: - :ref:`Texture` **texture** @@ -75,7 +89,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ -.. _class_VisualShaderNodeTexture_texture_type: +.. _class_VisualShaderNodeTexture_property_texture_type: - :ref:`TextureType` **texture_type** diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index 3435d8e8d..4bd44da1d 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -19,17 +19,25 @@ Brief Description Properties ---------- -+-----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`ColorDefault` | :ref:`color_default` | -+-----------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`TextureType` | :ref:`texture_type` | -+-----------------------------------------------------------------------+--------------------------------------------------------------------------+ ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`ColorDefault` | :ref:`color_default` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`TextureType` | :ref:`texture_type` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeTextureUniform_TextureType: +.. _class_VisualShaderNodeTextureUniform_constant_TYPE_DATA: + +.. _class_VisualShaderNodeTextureUniform_constant_TYPE_COLOR: + +.. _class_VisualShaderNodeTextureUniform_constant_TYPE_NORMALMAP: + +.. _class_VisualShaderNodeTextureUniform_constant_TYPE_ANISO: + enum **TextureType**: - **TYPE_DATA** = **0** @@ -42,6 +50,10 @@ enum **TextureType**: .. _enum_VisualShaderNodeTextureUniform_ColorDefault: +.. _class_VisualShaderNodeTextureUniform_constant_COLOR_DEFAULT_WHITE: + +.. _class_VisualShaderNodeTextureUniform_constant_COLOR_DEFAULT_BLACK: + enum **ColorDefault**: - **COLOR_DEFAULT_WHITE** = **0** @@ -51,7 +63,7 @@ enum **ColorDefault**: Property Descriptions --------------------- -.. _class_VisualShaderNodeTextureUniform_color_default: +.. _class_VisualShaderNodeTextureUniform_property_color_default: - :ref:`ColorDefault` **color_default** @@ -61,7 +73,7 @@ Property Descriptions | *Getter* | get_color_default() | +----------+--------------------------+ -.. _class_VisualShaderNodeTextureUniform_texture_type: +.. _class_VisualShaderNodeTextureUniform_property_texture_type: - :ref:`TextureType` **texture_type** diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index fab7ab702..175129128 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-----------------------------------+-------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`constant` | -+-----------------------------------+-------------------------------------------------------------------+ ++-----------------------------------+----------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`constant` | ++-----------------------------------+----------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeTransformConstant_constant: +.. _class_VisualShaderNodeTransformConstant_property_constant: - :ref:`Transform` **constant** diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst index 2c88a90e9..54e63dbb0 100644 --- a/classes/class_visualshadernodetransformmult.rst +++ b/classes/class_visualshadernodetransformmult.rst @@ -19,15 +19,19 @@ Brief Description Properties ---------- -+--------------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+--------------------------------------------------------------+---------------------------------------------------------------+ ++--------------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++--------------------------------------------------------------+------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeTransformMult_Operator: +.. _class_VisualShaderNodeTransformMult_constant_OP_AxB: + +.. _class_VisualShaderNodeTransformMult_constant_OP_BxA: + enum **Operator**: - **OP_AxB** = **0** @@ -37,7 +41,7 @@ enum **Operator**: Property Descriptions --------------------- -.. _class_VisualShaderNodeTransformMult_operator: +.. _class_VisualShaderNodeTransformMult_property_operator: - :ref:`Operator` **operator** diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 8888b0932..e6dc7bc05 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -19,15 +19,23 @@ Brief Description Properties ---------- -+-----------------------------------------------------------------+------------------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+-----------------------------------------------------------------+------------------------------------------------------------------+ ++-----------------------------------------------------------------+---------------------------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++-----------------------------------------------------------------+---------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeTransformVecMult_Operator: +.. _class_VisualShaderNodeTransformVecMult_constant_OP_AxB: + +.. _class_VisualShaderNodeTransformVecMult_constant_OP_BxA: + +.. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_AxB: + +.. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_BxA: + enum **Operator**: - **OP_AxB** = **0** @@ -41,7 +49,7 @@ enum **Operator**: Property Descriptions --------------------- -.. _class_VisualShaderNodeTransformVecMult_operator: +.. _class_VisualShaderNodeTransformVecMult_property_operator: - :ref:`Operator` **operator** diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index baf79b323..0c7d1e4d5 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -21,14 +21,14 @@ Brief Description Properties ---------- -+-----------------------------+-----------------------------------------------------------------+ -| :ref:`String` | :ref:`uniform_name` | -+-----------------------------+-----------------------------------------------------------------+ ++-----------------------------+--------------------------------------------------------------------------+ +| :ref:`String` | :ref:`uniform_name` | ++-----------------------------+--------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeUniform_uniform_name: +.. _class_VisualShaderNodeUniform_property_uniform_name: - :ref:`String` **uniform_name** diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index ba1717f47..a3a562dd8 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -19,14 +19,14 @@ Brief Description Properties ---------- -+-------------------------------+--------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`constant` | -+-------------------------------+--------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`constant` | ++-------------------------------+-----------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeVec3Constant_constant: +.. _class_VisualShaderNodeVec3Constant_property_constant: - :ref:`Vector3` **constant** diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index 1b7884c83..ec7ff49ce 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -19,15 +19,27 @@ Brief Description Properties ---------- -+-----------------------------------------------------------+------------------------------------------------------------+ -| :ref:`Function` | :ref:`function` | -+-----------------------------------------------------------+------------------------------------------------------------+ ++-----------------------------------------------------------+---------------------------------------------------------------------+ +| :ref:`Function` | :ref:`function` | ++-----------------------------------------------------------+---------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeVectorFunc_Function: +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_NORMALIZE: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SATURATE: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_NEGATE: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_RECIPROCAL: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_RGB2HSV: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_HSV2RGB: + enum **Function**: - **FUNC_NORMALIZE** = **0** @@ -45,7 +57,7 @@ enum **Function**: Property Descriptions --------------------- -.. _class_VisualShaderNodeVectorFunc_function: +.. _class_VisualShaderNodeVectorFunc_property_function: - :ref:`Function` **function** diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index 4c63ae72d..e85a73a5e 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -19,15 +19,33 @@ Brief Description Properties ---------- -+---------------------------------------------------------+----------------------------------------------------------+ -| :ref:`Operator` | :ref:`operator` | -+---------------------------------------------------------+----------------------------------------------------------+ ++---------------------------------------------------------+-------------------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++---------------------------------------------------------+-------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShaderNodeVectorOp_Operator: +.. _class_VisualShaderNodeVectorOp_constant_OP_ADD: + +.. _class_VisualShaderNodeVectorOp_constant_OP_SUB: + +.. _class_VisualShaderNodeVectorOp_constant_OP_MUL: + +.. _class_VisualShaderNodeVectorOp_constant_OP_DIV: + +.. _class_VisualShaderNodeVectorOp_constant_OP_MOD: + +.. _class_VisualShaderNodeVectorOp_constant_OP_POW: + +.. _class_VisualShaderNodeVectorOp_constant_OP_MAX: + +.. _class_VisualShaderNodeVectorOp_constant_OP_MIN: + +.. _class_VisualShaderNodeVectorOp_constant_OP_CROSS: + enum **Operator**: - **OP_ADD** = **0** @@ -51,7 +69,7 @@ enum **Operator**: Property Descriptions --------------------- -.. _class_VisualShaderNodeVectorOp_operator: +.. _class_VisualShaderNodeVectorOp_property_operator: - :ref:`Operator` **operator** diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index f794b7887..74ccc9b68 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -19,23 +19,23 @@ Vertical version of :ref:`ScrollBar`, which goes from left (min Theme Properties ---------------- -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`decrement` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`decrement_highlight` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_highlight` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_pressed` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`increment` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`increment_highlight` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`scroll` | -+---------------------------------+------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`scroll_focus` | -+---------------------------------+------------------------------------------------------------------+ ++---------------------------------+---------------------+ +| :ref:`Texture` | decrement | ++---------------------------------+---------------------+ +| :ref:`Texture` | decrement_highlight | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | grabber | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | grabber_highlight | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | grabber_pressed | ++---------------------------------+---------------------+ +| :ref:`Texture` | increment | ++---------------------------------+---------------------+ +| :ref:`Texture` | increment_highlight | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | scroll | ++---------------------------------+---------------------+ +| :ref:`StyleBox` | scroll_focus | ++---------------------------------+---------------------+ diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index bdf24a766..99590f92b 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -19,11 +19,11 @@ Vertical version of :ref:`Separator`. Theme Properties ---------------- -+---------------------------------+------------------------------------------------+ -| :ref:`int` | :ref:`separation` | -+---------------------------------+------------------------------------------------+ -| :ref:`StyleBox` | :ref:`separator` | -+---------------------------------+------------------------------------------------+ ++---------------------------------+------------+ +| :ref:`int` | separation | ++---------------------------------+------------+ +| :ref:`StyleBox` | separator | ++---------------------------------+------------+ Description ----------- diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index e1772beda..52a73c68e 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -19,25 +19,25 @@ Vertical slider. Theme Properties ---------------- -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`Texture` | :ref:`grabber` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_area` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`Texture` | :ref:`grabber_disabled` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_disabled` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`Texture` | :ref:`grabber_highlight` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`grabber_highlight` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`slider` | -+---------------------------------+-----------------------------------------------------------+ -| :ref:`Texture` | :ref:`tick` | -+---------------------------------+-----------------------------------------------------------+ ++---------------------------------+-------------------+ +| :ref:`StyleBox` | focus | ++---------------------------------+-------------------+ +| :ref:`Texture` | grabber | ++---------------------------------+-------------------+ +| :ref:`StyleBox` | grabber_area | ++---------------------------------+-------------------+ +| :ref:`Texture` | grabber_disabled | ++---------------------------------+-------------------+ +| :ref:`StyleBox` | grabber_disabled | ++---------------------------------+-------------------+ +| :ref:`Texture` | grabber_highlight | ++---------------------------------+-------------------+ +| :ref:`StyleBox` | grabber_highlight | ++---------------------------------+-------------------+ +| :ref:`StyleBox` | slider | ++---------------------------------+-------------------+ +| :ref:`Texture` | tick | ++---------------------------------+-------------------+ Description ----------- diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index af3f73ba0..5c9c50699 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -19,15 +19,15 @@ Vertical split container. Theme Properties ---------------- -+---------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`autohide` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`Texture` | :ref:`grabber` | -+---------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`separation` | -+---------------------------------+-----------------------------------------------------+ ++---------------------------------+------------+ +| :ref:`int` | autohide | ++---------------------------------+------------+ +| :ref:`StyleBox` | bg | ++---------------------------------+------------+ +| :ref:`Texture` | grabber | ++---------------------------------+------------+ +| :ref:`int` | separation | ++---------------------------------+------------+ Description ----------- diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 5460ea159..d369f222f 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -19,19 +19,19 @@ Holds an :ref:`Object`, but does not contribute to the reference c Methods ------- -+--------------------------------+---------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_ref` **(** **)** const | -+--------------------------------+---------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_ref` **(** **)** const | ++-------------------------------+----------------------------------------------------------------+ Description ----------- -A weakref can hold a :ref:`Reference`, without contributing to the reference counter. A weakref can be created from an :ref:`Object` using :ref:`@GDScript.weakref`. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. +A weakref can hold a :ref:`Reference`, without contributing to the reference counter. A weakref can be created from an :ref:`Object` using :ref:`@GDScript.weakref`. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. Method Descriptions ------------------- -.. _class_WeakRef_get_ref: +.. _class_WeakRef_method_get_ref: - :ref:`Variant` **get_ref** **(** **)** const diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index 790edd51f..5da053849 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -19,51 +19,51 @@ A WebSocket client implementation Properties ---------- -+-------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`verify_ssl` | -+-------------------------+-----------------------------------------------------+ ++-------------------------+--------------------------------------------------------------+ +| :ref:`bool` | :ref:`verify_ssl` | ++-------------------------+--------------------------------------------------------------+ Methods ------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_url` **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_from_host` **(** :ref:`int` code=1000, :ref:`String` reason="" **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_to_url` **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_host` **(** :ref:`int` code=1000, :ref:`String` reason="" **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_WebSocketClient_connection_closed: +.. _class_WebSocketClient_signal_connection_closed: - **connection_closed** **(** :ref:`bool` was_clean_close **)** Emitted when the connection to the server is closed. ``was_clean_close`` will be ``true`` if the connection was shutdown cleanly. -.. _class_WebSocketClient_connection_error: +.. _class_WebSocketClient_signal_connection_error: - **connection_error** **(** **)** Emitted when the connection to the server fails. -.. _class_WebSocketClient_connection_established: +.. _class_WebSocketClient_signal_connection_established: - **connection_established** **(** :ref:`String` protocol **)** Emitted when a connection with the server is established, ``protocol`` will contain the sub-protocol agreed with the server. -.. _class_WebSocketClient_data_received: +.. _class_WebSocketClient_signal_data_received: - **data_received** **(** **)** Emitted when a WebSocket message is received. Note: This signal is NOT emitted when used as high level multiplayer peer. -.. _class_WebSocketClient_server_close_request: +.. _class_WebSocketClient_signal_server_close_request: - **server_close_request** **(** :ref:`int` code, :ref:`String` reason **)** -Emitted when the server requests a clean close. You should keep polling until you get a :ref:`connection_closed` signal to achieve the clean close. See :ref:`WebSocketPeer.close` for more details. +Emitted when the server requests a clean close. You should keep polling until you get a :ref:`connection_closed` signal to achieve the clean close. See :ref:`WebSocketPeer.close` for more details. Description ----------- @@ -72,14 +72,14 @@ This class implements a WebSocket client compatible with any RFC 6455 complaint This client can be optionally used as a network peer for the :ref:`MultiplayerAPI`. -After starting the client (:ref:`connect_to_url`), you will need to :ref:`NetworkedMultiplayerPeer.poll` it at regular intervals (e.g. inside :ref:`Node._process`). +After starting the client (:ref:`connect_to_url`), you will need to :ref:`NetworkedMultiplayerPeer.poll` it at regular intervals (e.g. inside :ref:`Node._process`). You will received appropriate signals when connecting, disconnecting, or when new data is available. Property Descriptions --------------------- -.. _class_WebSocketClient_verify_ssl: +.. _class_WebSocketClient_property_verify_ssl: - :ref:`bool` **verify_ssl** @@ -94,17 +94,17 @@ Enable or disable SSL certificate verification. Note: You must specify the certi Method Descriptions ------------------- -.. _class_WebSocketClient_connect_to_url: +.. _class_WebSocketClient_method_connect_to_url: - :ref:`Error` **connect_to_url** **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** Connect to the given URL requesting one of the given ``protocols`` as sub-protocol. -If ``true``, is passed as ``gd_mp_api``, the client will behave like a network peer for the :ref:`MultiplayerAPI`. Note: connections to non Godot servers will not work, and :ref:`data_received` will not be emitted when this option is true. +If ``true``, is passed as ``gd_mp_api``, the client will behave like a network peer for the :ref:`MultiplayerAPI`. Note: connections to non Godot servers will not work, and :ref:`data_received` will not be emitted when this option is true. -.. _class_WebSocketClient_disconnect_from_host: +.. _class_WebSocketClient_method_disconnect_from_host: - void **disconnect_from_host** **(** :ref:`int` code=1000, :ref:`String` reason="" **)** -Disconnect this client from the connected host. See :ref:`WebSocketPeer.close` for more info. +Disconnect this client from the connected host. See :ref:`WebSocketPeer.close` for more info. diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index 11c112375..efa30771f 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -21,14 +21,14 @@ Base class for WebSocket server and client. Methods ------- -+--------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`WebSocketPeer` | :ref:`get_peer` **(** :ref:`int` peer_id **)** const | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`WebSocketPeer` | :ref:`get_peer` **(** :ref:`int` peer_id **)** const | ++-------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_WebSocketMultiplayerPeer_peer_packet: +.. _class_WebSocketMultiplayerPeer_signal_peer_packet: - **peer_packet** **(** :ref:`int` peer_source **)** @@ -42,7 +42,7 @@ Base class for WebSocket server and client, allowing them to be used as network Method Descriptions ------------------- -.. _class_WebSocketMultiplayerPeer_get_peer: +.. _class_WebSocketMultiplayerPeer_method_get_peer: - :ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** const diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index 6b1e20efc..9e1fe5ac9 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -19,27 +19,31 @@ A class representing a specific WebSocket connection. Methods ------- -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** :ref:`int` code=1000, :ref:`String` reason="" **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connected_port` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`WriteMode` | :ref:`get_write_mode` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_write_mode` **(** :ref:`WriteMode` mode **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`was_string_packet` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** :ref:`int` code=1000, :ref:`String` reason="" **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connected_host` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connected_port` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`WriteMode` | :ref:`get_write_mode` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_write_mode` **(** :ref:`WriteMode` mode **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`was_string_packet` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_WebSocketPeer_WriteMode: +.. _class_WebSocketPeer_constant_WRITE_MODE_TEXT: + +.. _class_WebSocketPeer_constant_WRITE_MODE_BINARY: + enum **WriteMode**: - **WRITE_MODE_TEXT** = **0** --- Specify that WebSockets messages should be transferred as text payload (only valid UTF-8 is allowed). @@ -56,49 +60,49 @@ You can choose to write to the socket in binary or text mode, and you can recogn Method Descriptions ------------------- -.. _class_WebSocketPeer_close: +.. _class_WebSocketPeer_method_close: - void **close** **(** :ref:`int` code=1000, :ref:`String` reason="" **)** Close this WebSocket connection. ``code`` is the status code for the closure (see RFC6455 section 7.4 for a list of valid status codes). ``reason`` is the human readable reason for closing the connection (can be any UTF8 string, must be less than 123 bytes). -Note: To achieve a clean close, you will need to keep polling until either :ref:`WebSocketClient.connection_closed` or :ref:`WebSocketServer.client_disconnected` is received. +Note: To achieve a clean close, you will need to keep polling until either :ref:`WebSocketClient.connection_closed` or :ref:`WebSocketServer.client_disconnected` is received. Note: HTML5 export might not support all status codes. Please refer to browsers-specific documentation for more details. -.. _class_WebSocketPeer_get_connected_host: +.. _class_WebSocketPeer_method_get_connected_host: - :ref:`String` **get_connected_host** **(** **)** const Returns the IP Address of the connected peer. (Not available in HTML5 export) -.. _class_WebSocketPeer_get_connected_port: +.. _class_WebSocketPeer_method_get_connected_port: - :ref:`int` **get_connected_port** **(** **)** const Returns the remote port of the connected peer. (Not available in HTML5 export) -.. _class_WebSocketPeer_get_write_mode: +.. _class_WebSocketPeer_method_get_write_mode: - :ref:`WriteMode` **get_write_mode** **(** **)** const -Get the current selected write mode. See :ref:`WriteMode`. +Get the current selected write mode. See :ref:`WriteMode`. -.. _class_WebSocketPeer_is_connected_to_host: +.. _class_WebSocketPeer_method_is_connected_to_host: - :ref:`bool` **is_connected_to_host** **(** **)** const Returns ``true`` if this peer is currently connected. -.. _class_WebSocketPeer_set_write_mode: +.. _class_WebSocketPeer_method_set_write_mode: - void **set_write_mode** **(** :ref:`WriteMode` mode **)** -Sets the socket to use the given :ref:`WriteMode`. +Sets the socket to use the given :ref:`WriteMode`. -.. _class_WebSocketPeer_was_string_packet: +.. _class_WebSocketPeer_method_was_string_packet: - :ref:`bool` **was_string_packet** **(** **)** const -Returns ``true`` if the last received packet was sent as a text payload. See :ref:`WriteMode` +Returns ``true`` if the last received packet was sent as a text payload. See :ref:`WriteMode` diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst index 730abb142..dcdf64c89 100644 --- a/classes/class_websocketserver.rst +++ b/classes/class_websocketserver.rst @@ -19,44 +19,44 @@ A WebSocket server implementation 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:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_peer` **(** :ref:`int` id **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_peer` **(** :ref:`int` id **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_WebSocketServer_client_close_request: +.. _class_WebSocketServer_signal_client_close_request: - **client_close_request** **(** :ref:`int` id, :ref:`int` code, :ref:`String` reason **)** -Emitted when a client requests a clean close. You should keep polling until you get a :ref:`client_disconnected` signal with the same ``id`` to achieve the clean close. See :ref:`WebSocketPeer.close` for more details. +Emitted when a client requests a clean close. You should keep polling until you get a :ref:`client_disconnected` signal with the same ``id`` to achieve the clean close. See :ref:`WebSocketPeer.close` for more details. -.. _class_WebSocketServer_client_connected: +.. _class_WebSocketServer_signal_client_connected: - **client_connected** **(** :ref:`int` id, :ref:`String` protocol **)** Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client. -.. _class_WebSocketServer_client_disconnected: +.. _class_WebSocketServer_signal_client_disconnected: - **client_disconnected** **(** :ref:`int` id, :ref:`bool` was_clean_close **)** Emitted when a client disconnects. ``was_clean_close`` will be ``true`` if the connection was shutdown cleanly. -.. _class_WebSocketServer_data_received: +.. _class_WebSocketServer_signal_data_received: - **data_received** **(** :ref:`int` id **)** @@ -67,44 +67,44 @@ Description This class implements a WebSocket server that can also support the high level multiplayer API. -After starting the server (:ref:`listen`), you will need to :ref:`NetworkedMultiplayerPeer.poll` it at regular intervals (e.g. inside :ref:`Node._process`). When clients connect, disconnect, or send data, you will receive the appropriate signal. +After starting the server (:ref:`listen`), you will need to :ref:`NetworkedMultiplayerPeer.poll` it at regular intervals (e.g. inside :ref:`Node._process`). When clients connect, disconnect, or send data, you will receive the appropriate signal. Note: This class will not work in HTML5 exports due to browser restrictions. Method Descriptions ------------------- -.. _class_WebSocketServer_disconnect_peer: +.. _class_WebSocketServer_method_disconnect_peer: - void **disconnect_peer** **(** :ref:`int` id, :ref:`int` code=1000, :ref:`String` reason="" **)** -Disconnects the peer identified by ``id`` from the server. See :ref:`WebSocketPeer.close` for more info. +Disconnects the peer identified by ``id`` from the server. See :ref:`WebSocketPeer.close` for more info. -.. _class_WebSocketServer_get_peer_address: +.. _class_WebSocketServer_method_get_peer_address: - :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const Returns the IP address of the given peer. -.. _class_WebSocketServer_get_peer_port: +.. _class_WebSocketServer_method_get_peer_port: - :ref:`int` **get_peer_port** **(** :ref:`int` id **)** const Returns the remote port of the given peer. -.. _class_WebSocketServer_has_peer: +.. _class_WebSocketServer_method_has_peer: - :ref:`bool` **has_peer** **(** :ref:`int` id **)** const Returns ``true`` if a peer with the given ID is connected. -.. _class_WebSocketServer_is_listening: +.. _class_WebSocketServer_method_is_listening: - :ref:`bool` **is_listening** **(** **)** const Returns ``true`` if the server is actively listening on a port. -.. _class_WebSocketServer_listen: +.. _class_WebSocketServer_method_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** @@ -112,9 +112,9 @@ Start listening on the given port. You can specify the desired subprotocols via the "protocols" array. If the list empty (default), "binary" will be used. -You can use this server as a network peer for :ref:`MultiplayerAPI` by passing ``true`` as ``gd_mp_api``. Note: :ref:`data_received` will not be fired and clients other than Godot will not work in this case. +You can use this server as a network peer for :ref:`MultiplayerAPI` by passing ``true`` as ``gd_mp_api``. Note: :ref:`data_received` will not be fired and clients other than Godot will not work in this case. -.. _class_WebSocketServer_stop: +.. _class_WebSocketServer_method_stop: - void **stop** **(** **)** diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index c2d6c57d5..464aaf631 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -21,41 +21,41 @@ Base class for window dialogs. Properties ---------- -+-----------------------------+------------------------------------------------------+ -| :ref:`bool` | :ref:`resizable` | -+-----------------------------+------------------------------------------------------+ -| :ref:`String` | :ref:`window_title` | -+-----------------------------+------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`resizable` | ++-----------------------------+---------------------------------------------------------------+ +| :ref:`String` | :ref:`window_title` | ++-----------------------------+---------------------------------------------------------------+ Methods ------- -+--------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | -+--------------------------------------------+--------------------------------------------------------------------------+ ++-------------------------------------------+---------------------------------------------------------------------------------+ +| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | ++-------------------------------------------+---------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Texture` | :ref:`close` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`close_h_ofs` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Texture` | :ref:`close_highlight` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`close_v_ofs` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`scaleborder_size` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Color` | :ref:`title_color` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`Font` | :ref:`title_font` | -+---------------------------------+--------------------------------------------------------------+ -| :ref:`int` | :ref:`title_height` | -+---------------------------------+--------------------------------------------------------------+ ++---------------------------------+------------------+ +| :ref:`Texture` | close | ++---------------------------------+------------------+ +| :ref:`int` | close_h_ofs | ++---------------------------------+------------------+ +| :ref:`Texture` | close_highlight | ++---------------------------------+------------------+ +| :ref:`int` | close_v_ofs | ++---------------------------------+------------------+ +| :ref:`StyleBox` | panel | ++---------------------------------+------------------+ +| :ref:`int` | scaleborder_size | ++---------------------------------+------------------+ +| :ref:`Color` | title_color | ++---------------------------------+------------------+ +| :ref:`Font` | title_font | ++---------------------------------+------------------+ +| :ref:`int` | title_height | ++---------------------------------+------------------+ Description ----------- @@ -65,7 +65,7 @@ Windowdialog is the base class for all window-based dialogs. It's a by-default t Property Descriptions --------------------- -.. _class_WindowDialog_resizable: +.. _class_WindowDialog_property_resizable: - :ref:`bool` **resizable** @@ -77,7 +77,7 @@ Property Descriptions If ``true``, the user can resize the window. Default value: ``false``. -.. _class_WindowDialog_window_title: +.. _class_WindowDialog_property_window_title: - :ref:`String` **window_title** @@ -92,7 +92,7 @@ The text displayed in the window's title bar. Method Descriptions ------------------- -.. _class_WindowDialog_get_close_button: +.. _class_WindowDialog_method_get_close_button: - :ref:`TextureButton` **get_close_button** **(** **)** diff --git a/classes/class_world.rst b/classes/class_world.rst index 5ad4bf8c7..e82aaa6e3 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -19,17 +19,17 @@ Class that has everything pertaining to a world. Properties ---------- -+---------------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`direct_space_state` | -+---------------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Environment` | :ref:`environment` | -+---------------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`Environment` | :ref:`fallback_environment` | -+---------------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`RID` | :ref:`scenario` | -+---------------------------------------------------------------+---------------------------------------------------------------+ -| :ref:`RID` | :ref:`space` | -+---------------------------------------------------------------+---------------------------------------------------------------+ ++---------------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`direct_space_state` | ++---------------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`environment` | ++---------------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`fallback_environment` | ++---------------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`scenario` | ++---------------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`space` | ++---------------------------------------------------------------+------------------------------------------------------------------------+ Description ----------- @@ -44,7 +44,7 @@ Tutorials Property Descriptions --------------------- -.. _class_World_direct_space_state: +.. _class_World_property_direct_space_state: - :ref:`PhysicsDirectSpaceState` **direct_space_state** @@ -54,7 +54,7 @@ Property Descriptions The World's physics direct space state, used for making various queries. Might be used only during ``_physics_process``. -.. _class_World_environment: +.. _class_World_property_environment: - :ref:`Environment` **environment** @@ -66,7 +66,7 @@ The World's physics direct space state, used for making various queries. Might b The World's :ref:`Environment`. -.. _class_World_fallback_environment: +.. _class_World_property_fallback_environment: - :ref:`Environment` **fallback_environment** @@ -78,7 +78,7 @@ The World's :ref:`Environment`. The World's fallback_environment will be used if the World's :ref:`Environment` fails or is missing. -.. _class_World_scenario: +.. _class_World_property_scenario: - :ref:`RID` **scenario** @@ -88,7 +88,7 @@ The World's fallback_environment will be used if the World's :ref:`Environment` **space** diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 707235d6f..24d933368 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -19,13 +19,13 @@ Class that has everything pertaining to a 2D world. Properties ---------- -+-------------------------------------------------------------------+-------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas` | -+-------------------------------------------------------------------+-------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`direct_space_state` | -+-------------------------------------------------------------------+-------------------------------------------------------------+ -| :ref:`RID` | :ref:`space` | -+-------------------------------------------------------------------+-------------------------------------------------------------+ ++-------------------------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas` | ++-------------------------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`direct_space_state` | ++-------------------------------------------------------------------+----------------------------------------------------------------------+ +| :ref:`RID` | :ref:`space` | ++-------------------------------------------------------------------+----------------------------------------------------------------------+ Description ----------- @@ -40,7 +40,7 @@ Tutorials Property Descriptions --------------------- -.. _class_World2D_canvas: +.. _class_World2D_property_canvas: - :ref:`RID` **canvas** @@ -50,7 +50,7 @@ Property Descriptions The :ref:`RID` of this world's canvas resource. Used by the :ref:`VisualServer` for 2D drawing. -.. _class_World2D_direct_space_state: +.. _class_World2D_property_direct_space_state: - :ref:`Physics2DDirectSpaceState` **direct_space_state** @@ -60,7 +60,7 @@ The :ref:`RID` of this world's canvas resource. Used by the :ref:`Vis The state of this world's physics space. This allows arbitrary querying for collision. -.. _class_World2D_space: +.. _class_World2D_property_space: - :ref:`RID` **space** diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index cf09aacac..575753b40 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -19,9 +19,9 @@ Default environment properties for the entire scene (post-processing effects, li Properties ---------- -+---------------------------------------+--------------------------------------------------------+ -| :ref:`Environment` | :ref:`environment` | -+---------------------------------------+--------------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------+ +| :ref:`Environment` | :ref:`environment` | ++---------------------------------------+-----------------------------------------------------------------+ Description ----------- @@ -40,7 +40,7 @@ Tutorials Property Descriptions --------------------- -.. _class_WorldEnvironment_environment: +.. _class_WorldEnvironment_property_environment: - :ref:`Environment` **environment** diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 4f45693a3..956d83e6b 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -19,47 +19,61 @@ Low-level class for creating parsers for XML files. 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 ------------ .. _enum_XMLParser_NodeType: +.. _class_XMLParser_constant_NODE_NONE: + +.. _class_XMLParser_constant_NODE_ELEMENT: + +.. _class_XMLParser_constant_NODE_ELEMENT_END: + +.. _class_XMLParser_constant_NODE_TEXT: + +.. _class_XMLParser_constant_NODE_COMMENT: + +.. _class_XMLParser_constant_NODE_CDATA: + +.. _class_XMLParser_constant_NODE_UNKNOWN: + enum **NodeType**: - **NODE_NONE** = **0** --- There's no node (no file or buffer opened) @@ -84,103 +98,103 @@ This class can serve as base to make custom XML parsers. Since XML is a very fle Method Descriptions ------------------- -.. _class_XMLParser_get_attribute_count: +.. _class_XMLParser_method_get_attribute_count: - :ref:`int` **get_attribute_count** **(** **)** const Get the amount of attributes in the current element. -.. _class_XMLParser_get_attribute_name: +.. _class_XMLParser_method_get_attribute_name: - :ref:`String` **get_attribute_name** **(** :ref:`int` idx **)** const Get the name of the attribute specified by the index in ``idx`` argument. -.. _class_XMLParser_get_attribute_value: +.. _class_XMLParser_method_get_attribute_value: - :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** const Get the value of the attribute specified by the index in ``idx`` argument. -.. _class_XMLParser_get_current_line: +.. _class_XMLParser_method_get_current_line: - :ref:`int` **get_current_line** **(** **)** const Get the current line in the parsed file (currently not implemented). -.. _class_XMLParser_get_named_attribute_value: +.. _class_XMLParser_method_get_named_attribute_value: - :ref:`String` **get_named_attribute_value** **(** :ref:`String` name **)** const Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. -.. _class_XMLParser_get_named_attribute_value_safe: +.. _class_XMLParser_method_get_named_attribute_value_safe: - :ref:`String` **get_named_attribute_value_safe** **(** :ref:`String` name **)** const Get 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. -.. _class_XMLParser_get_node_data: +.. _class_XMLParser_method_get_node_data: - :ref:`String` **get_node_data** **(** **)** const Get the contents of a text node. This will raise an error in any other type of node. -.. _class_XMLParser_get_node_name: +.. _class_XMLParser_method_get_node_name: - :ref:`String` **get_node_name** **(** **)** const Get the name of the current element node. This will raise an error if the current node type is not ``NODE_ELEMENT`` nor ``NODE_ELEMENT_END`` -.. _class_XMLParser_get_node_offset: +.. _class_XMLParser_method_get_node_offset: - :ref:`int` **get_node_offset** **(** **)** const Get the byte offset of the current node since the beginning of the file or buffer. -.. _class_XMLParser_get_node_type: +.. _class_XMLParser_method_get_node_type: - :ref:`NodeType` **get_node_type** **(** **)** Get the type of the current node. Compare with ``NODE_*`` constants. -.. _class_XMLParser_has_attribute: +.. _class_XMLParser_method_has_attribute: - :ref:`bool` **has_attribute** **(** :ref:`String` name **)** const Check whether or not the current element has a certain attribute. -.. _class_XMLParser_is_empty: +.. _class_XMLParser_method_is_empty: - :ref:`bool` **is_empty** **(** **)** const Check whether the current element is empty (this only works for completely empty tags, e.g. ). -.. _class_XMLParser_open: +.. _class_XMLParser_method_open: - :ref:`Error` **open** **(** :ref:`String` file **)** Open a XML file for parsing. This returns an error code. -.. _class_XMLParser_open_buffer: +.. _class_XMLParser_method_open_buffer: - :ref:`Error` **open_buffer** **(** :ref:`PoolByteArray` buffer **)** Open a XML raw buffer for parsing. This returns an error code. -.. _class_XMLParser_read: +.. _class_XMLParser_method_read: - :ref:`Error` **read** **(** **)** Read the next node of the file. This returns an error code. -.. _class_XMLParser_seek: +.. _class_XMLParser_method_seek: - :ref:`Error` **seek** **(** :ref:`int` position **)** Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. -.. _class_XMLParser_skip_section: +.. _class_XMLParser_method_skip_section: - void **skip_section** **(** **)** diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index f58cde127..284f130d2 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -19,9 +19,9 @@ Sort all child nodes based on their Y positions. Properties ---------- -+-------------------------+-----------------------------------------------+ -| :ref:`bool` | :ref:`sort_enabled` | -+-------------------------+-----------------------------------------------+ ++-------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`sort_enabled` | ++-------------------------+--------------------------------------------------------+ Description ----------- @@ -31,7 +31,7 @@ Sort all child nodes based on their Y positions. The child node must inherit fro Property Descriptions --------------------- -.. _class_YSort_sort_enabled: +.. _class_YSort_property_sort_enabled: - :ref:`bool` **sort_enabled**